Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2023-03-20 GMT+08:00

Consulta de uma versão da API

Função

Esta API é usada para consultar uma versão específica da API.

URI

GET /{api_version}

A Tabela 1 lista os parâmetros.
Tabela 1 Descrição do parâmetro

Parâmetro

Obrigatório

Descrição

api_version

Sim

Especifica a versão da API, por exemplo, v1.

Solicitação

  • Parâmetros de solicitação

    Nenhum

  • Exemplo de solicitação
    1
    GET https://{BMS Endpoint}/v1
    

Resposta

  • Parâmetros de resposta

    Parâmetro

    Tipo

    Descrição

    version

    Object

    Especifica uma versão de API especificada do serviço BMS. Para mais detalhes, consulte Tabela 2.

    Tabela 2 Descrição da estrutura de dados do campo version

    Parâmetro

    Tipo

    Descrição

    id

    String

    Especifica a versão da API.

    links

    Array of objects

    Especifica o URL da API. Para mais detalhes, consulte Tabela 3.

    min_version

    String

    Especifica a versão mais antiga da micro API com suporte.

    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.

    O formato do carimbo de data/hora é AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por exemplo, 2018-09-30T00:00:00Z.

    version

    String

    Especifica a versão mais recente da micro API que é suportada.

    Tabela 3 Descrição da estrutura de dados do campo links

    Parâmetro

    Tipo

    Descrição

    href

    String

    Especifica o URL da API.

    rel

    String

    Especifica a dependência de URL da API. O valor pode ser:

    • self: link de recurso que contém o número da versão. É usado quando o rastreamento imediato é necessário.
    • bookmark: link de recurso que pode ser armazenado por um longo tempo.
  • Exemplo de resposta
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    {
        "version": {
            "id": "v1",
            "links": [
                {
                    "href": "http://bms.xxx.com/v1/",
                    "rel": "self"
                }
            ],
            "min_version": "",
            "status": "CURRENT",
            "updated": "2018-09-30T00:00:00Z",
            "version": ""
        }
    }
    

Valores retornados

Valores normais

Valor retornado

Descrição

200

A solicitação foi processada com sucesso.

Para obter detalhes sobre outros valores retornados, consulte Códigos de status.

Códigos de erro

Consulte Códigos de erro.