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.

Central de ajuda> VPC Endpoint> Referência de API> API> Gerenciamento de versão> Consulta de versão de uma API do VPCEP especificada

Atualizado em 2023-02-20 GMT+08:00

Ver PDF

Consulta de versão de uma API do VPCEP especificada

Função

Função Essa API é usada para consultar a versão de uma API do VPCEP especificada.

URI

GET /{version}

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatoriedade	Tipo	Descrição
version	Sim	String	Especifica o número da versão a ser consultada. O valor começa com v, por exemplo, v1. Se esse parâmetro for deixado em branco, as versões de todas as APIs do VPCEP serão consultadas.

Parâmetros de solicitação

**Tabela 2** Parâmetros de cabeçalho de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
Tipo de conteúdo	Sim	String	Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as API usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo.

Parâmetros de resposta

Código de estado: 200

**Tabela 3** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
version	VersionObject object	Especifica as versões da API do VPCEP.

**Tabela 4** VersionObject
Parâmetro	Tipo	Descrição
Estado	String	Especifica o status da versão.● CURRENT: indica uma versão primária.● SUPPORT: indica uma versão anterior que ainda é suportada. ● DEPRECATED: indica uma versão obsoleta que pode ser excluída posteriormente.
id	String	Especifica a versão da API.
Atualização bem-sucedida	String	Especifica a hora em que versão da API foi lançada. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ.
version	String	Especifica o número de versão suportado.
min_version	String	Especifica o número de microversão suportado. Se as APIs não suportarem microversões, o parâmetro será deixado em branco.
links	Array of Link objects	Especifica o URL da API.

**Tabela 5** Ligação
Parâmetro	Tipo	Descrição
href	String	Especifica o endereço de referência da versão atual da API.
type	String	Especifica o tipo MIME do corpo da solicitação. O valor é application/json.
rel	String	Especifica a relação entre a versão atual da API e o endereço referenciado.

Código de estado: 400

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 7** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 401

**Tabela 8** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 9** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 403

**Tabela 10** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 11** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 404

**Tabela 12** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 13** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 405

**Tabela 14** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 15** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 406

**Tabela 16** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 17** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 407

**Tabela 18** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 19** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 408

**Tabela 20** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 21** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 409

**Tabela 22** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 23** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 500

**Tabela 24** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 25** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 501

**Tabela 26** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 27** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 502

**Tabela 28** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 29** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 503

**Tabela 30** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 31** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Código de estado: 504

**Tabela 32** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Error object	Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

**Tabela 33** Erro
Parâmetro	Tipo	Descrição
message	String	Descrição do erro da tarefa
code	String	Código de erro de uma exceção de tarefa.

Exemplo de solicitações

GET https://{endpoint}/v1

Exemplo de respostas

Código de estado: 200

O servidor processou a solicitação com sucesso.

{
  "version":{
    {
      "updated":"2018-09-30T00:00:00Z",
      "version":"1",
      "min_version":"",
      "status":"CURRENT",
      "id":"v1",
      "links":[
        {
          "href":"https://{vpcep_uri}/v1",
          "type":"application/json",
          "rel":"self"
        }
      ]
    }
  }
}

Códigos de estado

Código de estado	Descrição
200	O servidor processou a solicitação com sucesso.
400	A solicitação não pôde ser entendida pelo servidor devido à sintaxe mal formada.
401	A página solicitada requer um nome de usuário e senha.
403	O servidor entendeu o pedido, mas está se recusando a cumpri-lo.
404	A página solicitada não foi encontrada.
405	O método especificado na linha de solicitação não é permitido para o recurso identificado pelo URI da solicitação.
406	O recurso identificado pela solicitação só é capaz de gerar entidades de resposta que tenham características de conteúdo não aceitáveis de acordo com os cabeçalhos de aceitação enviados na solicitação.
407	O cliente deve primeiro autenticar-se com o proxy.
408	O cliente não produziu uma solicitação dentro do tempo que o servidor estava preparado para esperar.
409	A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso.
500	Falhou ao concluir a solicitação. Anormalidade de serviço.
501	Falhou ao concluir a solicitação. O servidor não suporta a função solicitada.
502	Falhou ao concluir a solicitação. porque o servidor recebe uma resposta inválida.
503	Falhou ao concluir a solicitação. porque o sistema não está disponível.
504	Gateway expirou o tempo limite