Solicitudes de REST API de VMware Aria Operations

Para recuperar representaciones de objetos, los clientes realizan solicitudes HTTP a referencias de objetos.

Seguridad

El vínculo HTTP entre el servidor y el cliente de API se establece mediante SSL. Los clientes de API configuran la autenticación basada en token para comunicarse con el servidor.

Figura 1. Escenario: proporcionar credenciales de usuario para obtener detalles acerca de la alerta con el ID 123

Puede llamar a las API de VMware Aria Operations después de generar el token de autenticación de Cloud Services. Utilice el siguiente endpoint:

https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api

Nota: Si su organización se encuentra fuera de los Estados Unidos, utilice la abreviatura del país para el endpoint de la API. Si se utiliza un endpoint incorrecto, se producirá un error 404. Por ejemplo, si su organización se encuentra en Australia, la abreviatura del país será AU y el endpoint de la API es:

https://au.www.mgmt.cloud.vmware.com/vrops-cloud/suite-api 

Debe pasar el token de autenticación de Cloud Services con cada solicitud como un encabezado HTTP con el siguiente formato:

Authorization: CSPToken {CSP Auth Token}

Por ejemplo:

curl -k https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/api/resources -H "Content-Type: application/json" -H "Accept: application/json" -H "Authorization: CSPToken abc12345...

Encabezados de solicitud

Por lo general, los siguientes encabezados HTTP se incluyen en solicitudes API:

Accept-Language	Para especificar el idioma deseado en las respuestas, utilice el encabezado de solicitud Accept-Language. Las cadenas de mensajes en las respuestas de ErrorType están localizadas. Para solicitar una respuesta con cadenas de mensajes localizadas en francés, utilice el siguiente encabezado: Accept-Language: fr-FR
Autorización	Todas las solicitudes para crear una sesión de API deben incluir un encabezado Authorization del formulario prescrito por el proveedor de identidad que utiliza su organización
Content-Type	Las solicitudes que incluyen un cuerpo deben incluir un encabezado Content-Type HTTP adecuado. Para un cuerpo de la solicitud en XML, el encabezado debe incluir Content-Type: application/xml Para un cuerpo de solicitud en JSON, el encabezado debe incluir Content-Type: application/json
Aceptar	Para especificar el formato de respuesta deseado, incluya el encabezado de solicitud Accept. Para una respuesta en XML, el encabezado debe incluir Accept: application/xml Para una respuesta en JSON, el encabezado debe incluir Accept: application/json

Solicitar cuerpos en XML

Para un cuerpo de solicitud escrito en XML, VMware Aria Operations utiliza un analizador XML de validación que requiere que los elementos en el cuerpo de la solicitud acepten el esquema según orden y número. Los cuerpos de la solicitud se rechazan como no válidos, a menos que cumplan los siguientes criterios:

• Los atributos del espacio de nombres XML deben proporcionarse para todos los espacios de nombres representados por los elementos de la solicitud.
• Si se representan varios espacios de nombres en la solicitud, los atributos del espacio de nombres XML deben incluir un prefijo de identificación y ese prefijo debe utilizarse con todos los elementos de ese espacio de nombres.
• Todos los elementos necesarios deben aparecer en los cuerpos de la solicitud. Todos los elementos que aparecen en los cuerpos de la solicitud deben aparecer en el orden en el que se establece el esquema y con contenido que se ajuste a la restricción de tipo que especifica el esquema.