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-02-20 GMT+08:00

Consulta de versões da API do VPCEP

Função

Essa API é usada para consultar versões das APIs do VPCEP.

URI

GET /

Parâmetros de solicitação

Tabela 1 Parâmetros do cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

Content-Type

Sim

String

Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as APIs usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo.

Parâmetros de resposta

Código de status: 200

Tabela 2 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

versions

Array of VersionObject objects

Lista as versões do VPCEP.

Tabela 3 VersionObject

Parâmetro

Tipo

Descrição

status

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.

updated

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 micro versão suportado. Se as APIs não suportarem micro versões, o parâmetro será deixado em branco.

links

Array of Link objects

Especifica o URL da API.

Código de status: 400

Tabela 5 Parâmetros de corpo de 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 6 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 status: 401

Tabela 7 Parâmetros de corpo de 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 8 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 status: 403

Tabela 9 Parâmetros de corpo de 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 10 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 status: 404

Tabela 11 Parâmetros de corpo de 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 12 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 status: 405

Tabela 13 Parâmetros de corpo de 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 14 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 status: 406

Tabela 15 Parâmetros de corpo de 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 16 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 status: 407

Tabela 17 Parâmetros de corpo de 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 18 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 status: 408

Tabela 19 Parâmetros de corpo de 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 20 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 status: 409

Tabela 21 Parâmetros de corpo de 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 22 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 status: 500

Tabela 23 Parâmetros de corpo de 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 24 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 status: 501

Tabela 25 Parâmetros de corpo de 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 26 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 status: 502

Tabela 27 Parâmetros de corpo de 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 28 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 status: 503

Tabela 29 Parâmetros de corpo de 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 30 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 status: 504

Tabela 31 Parâmetros de corpo de 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 32 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.

Exemplos de solicitações

GET https://{endpoint}/

Exemplo de respostas

Código de status: 200

O servidor processou a solicitação com sucesso.

{
  "versions" : [ {
    "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 status

Código de status

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 a solicitação, mas se recusa a atendê-la.

404

O servidor não encontrou nada que corresponda ao URI da solicitação.

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

Códigos de erro

Consulte Códigos de erro.