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 de las API.
URI
GET /{version}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| version | Sí | String | La versión de la API que se va a consultar. El valor puede ser v1, v2 o v3. |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | El token de usuario. Se puede obtener invocando 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 de la versión. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | El ID de la versión de la API. |
| links | Array of Link objects | El URI de la versión de la API. |
| media-types | Array of MediaTypes objects | El tipo de mensaje de solicitud de la versión de la API. |
| min_version | String | La versión mínima de la API. |
| status | String | El estado de la versión de la API. |
| updated | String | La última vez que se actualizó la versión de la API. |
| version | String | El número de versión de la API. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| href | String | Definición El enlace de acceso directo correspondiente. Rango N/D |
| rel | String | Definición El nombre del marcador del enlace de acceso directo. Rango N/D |
| 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 | Definición La información de error devuelta si se produce un error. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| code | String | Definición El código de error devuelto si se produce un error. Rango Para obtener más información sobre el código de error, consulte Códigos de error. |
| message | String | Definición El mensaje de error devuelto si se produce un error. Rango N/D |
Ejemplos de solicitudes
GET https://{endpoint}/{version}
https://{endpoint}/{version} Ejemplos 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
Bad Request
{
"error" : {
"code" : "string",
"message" : "string"
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | Los detalles de la versión. |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.
