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 2024-09-25 GMT+08:00

Obtenção de detalhes de uma versão da API

Função

Essa API é usada para consultar os detalhes de uma versão da API do DSS.

URI

GET /{api_version}

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

Parâmetro

Obrigatório

Tipo

Descrição

api_version

Sim

String

Especifica o número da versão de destino.

Para saber como obter o número da versão, consulte Obtenção de detalhes de versões da API.

Solicitação

  • Parâmetros de solicitação

    Nenhum

  • Exemplo de solicitação

    O exemplo a seguir mostra como consultar informações de versão de uma API v1.

    GET https://{endpoint}/v1

Resposta

Parâmetros de resposta

A Tabela 2 descreve os parâmetros de resposta.
Tabela 2 Parâmetros de resposta

Parâmetro

Tipo

Descrição

version

Object

Especifica as informações de versão da API.

id

String

Especifica o ID da versão, por exemplo, v1.

links

Array

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

version

String

Especifica a microversão máxima suportada por essa API.

status

String

Especifica o status da versão. O valor pode ser o seguinte:

CURRENT: indica que a versão é atualmente recomendada para uso.

SUPPORTED: indica que a versão é uma versão anterior, mas ainda é suportada.

DEPRECATED: indica uma versão obsoleta que pode ser excluída posteriormente.

updated

String

Especifica a hora em que a versão da API foi lançada.

Formato da hora: UTC YYYY-MM-DDTHH:MM:SS

min_version

String

Especifica a microversão mínima suportada por essa API.

Parâmetros no campo links

Tabela 3 descreve os parâmetros no campo links.
Tabela 3 Descrição do parâmetro

Parâmetro

Tipo

Descrição

rel

String

Especifica a descrição do link.

href

String

Especifica o link de consulta de versão.

  • Exemplo de resposta
    {
        "version": {
                "min_version": "", 
                 "links": [
                    {
                        "rel": "self", 
                        "href": "https://dss.localdomain.com/v1"
                    }
                ], 
                "id": "v1", 
                "updated": "2014-06-28T12:20:21Z", 
                "version": "", 
                "status": "CURRENT"
            }
    }

Valores retornados

Códigos de erro

Consulte Códigos de erro.