Consulta de uma versão da API

Função

Essa interface é usada para consultar uma versão de API especificada do serviço AS.

URI

GET /{api_version}

Mensagem de solicitação

• Parâmetros de solicitação

  Nenhum

• Exemplo de solicitação

  Este exemplo mostra como consultar a API V1 de AS.

  GET https://{Endpoint}/v1

Mensagem de resposta

• Parâmetros de resposta

  Tabela 2 Parâmetros de resposta

  Parâmetro	Tipo	Descrição
  version	version object	Especifica uma versão de API especificada.

  Tabela 3 Descrição do campo version

  Parâmetro	Tipo	Descrição
  id	String	Especifica o ID da versão da API.
  links	Array of links objects	Especifica o URL da API. Para mais detalhes, consulte Tabela 4.
  min_version	String	Especifica o número de versão da API com suporte mais antigo.
  status	String	Especifica o status da versão da API. CURRENT: indica uma versão primária. SUPPORTED: indica uma versão anterior que ainda é suportada. DEPRECATED: indica uma versão obsoleta que pode ser excluída posteriormente.
  updated	String	Especifica a data de lançamento de uma versão da API.
  version	String	Especifica o número de versão da API mais recente compatível.

  Tabela 4 Descrição do campo links

  Parâmetro	Tipo	Descrição
  href	String	Especifica o URL (Uniform Resource Locator) da API.
  rel	String	Especifica a dependência de URL da API.

• Exemplo de resposta

  {
    "version": {
      "id": "v1",
      "links": [
        {
          "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/",
          "rel": "self"
        }
      ],
      "min_version": "",
      "status": "CURRENT",
      "updated": "2016-06-30T00:00:00Z",
      "version": ""
    }
  }

Valores retornados

• Normal

  200

• Anormal

  Valores retornados	Descrição
  400 Bad Request	O servidor falhou ao processar a solicitação.
  401 Unauthorized	Você deve digitar o nome de usuário e a senha para acessar a página solicitada.
  403 Forbidden	Você está proibido de acessar a página solicitada.
  404 Not Found	O servidor não conseguiu encontrar a página solicitada.
  405 Method Not Allowed	Você não tem permissão para usar o método especificado na solicitação.
  406 Not Acceptable	A resposta gerada pelo servidor não poderia ser aceita pelo cliente.
  407 Proxy Authentication Required	Você deve usar o servidor proxy para autenticação para que a solicitação possa ser processada.
  408 Request Timeout	A solicitação expirou o tempo limite.
  409 Conflict	A solicitação não pôde ser processada devido a um conflito.
  500 Internal Server Error	Falhou ao concluir a solicitação porque ocorre um erro de serviço interno.
  501 Not Implemented	Falhou ao concluir a solicitação porque o servidor não suporta a função solicitada.
  502 Bad Gateway	Falhou ao concluir a solicitação porque a solicitação é inválida.
  503 Service Unavailable	Falhou ao concluir a solicitação porque o sistema não está disponível.
  504 Gateway Timeout	Ocorreu um erro de tempo limite de gateway.

Códigos de erro

Consulte Códigos de erro.