Consulta de información de una versión de API
Función
Esta API se utiliza para consultar información de una versión de API.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /{version}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
version |
Sí |
String |
La versión de API que se va a consultar. El valor puede ser v1, v2 o v3. Valores de enumeración:
|
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
El token del usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
versions |
Array of Versions objects |
La información sobre la versión. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de versión de API. |
links |
Array of Link objects |
El URI de la versión de API. |
media-types |
Array of MediaTypes objects |
El tipo de mensaje de solicitud de la versión de API. |
min_version |
String |
La versión mínima de API. |
status |
String |
El estado de la versión de la API. |
updated |
String |
La última vez que se actualizó la versión de API. |
version |
String |
El número de versión de la API. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
El enlace de acceso directo correspondiente. |
rel |
String |
El nombre del marcador de enlace de acceso directo. Valor predeterminado: next |
Parámetro |
Tipo |
Descripción |
---|---|---|
base |
String |
El tipo de texto. |
type |
String |
El tipo de retorno. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
El mensaje de error devuelto si se produce un error. |
Parámetro |
Tipo |
Descripción |
---|---|---|
code |
String |
El código de error devuelto si se produce un error. Para obtener más detalles sobre los códigos de error y sus significados, consulte Códigos de error. |
message |
String |
El mensaje de error devuelto si se produce un error. |
Ejemplo de solicitudes
GET https://{endpoint}/{version} https://{endpoint}/{version}
Ejemplo de respuestas
Código de estado: 200
Los detalles de la versión.
{ "versions" : [ { "min_version" : "", "media-types" : [ { "type" : "application/vnd.openstack.volume+json;version=1", "base" : "application/json" }, { "type" : "application/vnd.openstack.volume+xml;version=1", "base" : "application/xml" } ], "links" : [ { "rel" : "describedby", "href" : "http://docs.openstack.org/", "type" : "text/html" }, { "rel" : "self", "href" : "https://evs.localdomain.com/v2" } ], "id" : "v2.0", "updated" : "2014-06-28T12:20:21Z", "version" : "", "status" : "SUPPORTED" } ] }
Código de estado: 400
Error en la solicitud
{ "error" : { "code" : "string", "message" : "string" } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Los detalles de la versión. |
400 |
Error en la solicitud |
Códigos de error
Consulte Códigos de error.