Consulta de informações de uma versão da API
Função
Esta API é usada para consultar informações de uma versão da API.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /{version}
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
version |
Sim |
String |
A versão da API a ser consultada. O valor pode ser v1, v2 ou v3. Valores de enumeração:
|
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
O token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
versions |
Array of Versions objects |
Informações sobre a versão. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
O ID da versão da API. |
|
links |
Array of Link objects |
O URI da versão da API. |
|
media-types |
Array of MediaTypes objects |
O tipo de mensagem de solicitação da versão da API. |
|
min_version |
String |
A versão mínima da API. |
|
status |
String |
O status da versão da API. |
|
updated |
String |
A última vez em que a versão da API foi atualizada. |
|
version |
String |
O número da versão da API. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
href |
String |
O link de atalho correspondente. |
|
rel |
String |
O nome do marcador do link de atalho. Padrão: next |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
base |
String |
O tipo de texto. |
|
type |
String |
O tipo de retorno. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
A mensagem de erro retornada se ocorrer um erro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
code |
String |
O código de erro retornado se ocorrer um erro. Para obter detalhes sobre códigos de erro e seus significados, consulte Códigos de erro. |
|
message |
String |
A mensagem de erro retornada se ocorrer um erro. |
Exemplo de solicitações
GET https://{endpoint}/{version}
https://{endpoint}/{version}
Exemplo de respostas
Código de status: 200
Os detalhes da versão.
{
"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 status: 400
Bad Request
{
"error" : {
"code" : "string",
"message" : "string"
}
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Os detalhes da versão. |
|
400 |
Bad Request |
Códigos de erro
Consulte Códigos de erro.