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> Pontos de extremidade da VPC> Consulta de informações básicas de um serviço do VPC Endpoint

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

Ver PDF

Consulta de informações básicas de um serviço do VPC Endpoint

Função

FunçãoEssa API é usada para consultar informações básicas de um serviço do ponto de extremidade da VPC. Você pode usar essa API para consultar os serviços do ponto de extremidade da VPC a serem acessados. Essa API também pode ser usada por outros usuários para consultar informações básicas do seu serviço do ponto de extremidade da VPC, sem expor as informações do servidor.

URI

GET /v1/{project_id}/vpc-endpoint-services/describe

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatoriedade	Tipo	Descrição
project_id	Sim	String	ID do projeto. Mínimo: 1 Máximo: 64

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatoriedade	Tipo	Descrição
endpoint_service_name	Não	String	Especifica o nome do serviço do ponto de extremidade da VPC. Observação: este campo ou o campo id deve ser especificado. Caso contrário, ocorre um erro. Mínimo: 1 Máximo: 128
id	Não	String	Especifica o ID do serviço do ponto de extremidade da VPC. O ID é o identificador exclusivo do serviço do ponto de extremidade da VPC. Observação: este parâmetro ou endpoint_service_name devem ser especificados. Mínimo: 1 Máximo: 64

Parâmetros de solicitação

**Tabela 3** Parâmetros de cabeçalho de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
X-Auth-Token	Sim	String	Especifica o token do usuário. Ele pode ser obtido chamando a API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. Mínimo: 1 Máximo: 2048
Content-Type	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. Mínimo: 1 Máximo: 64

Parâmetros de resposta

Código de estado: 200

**Tabela 4** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
id	String	Especifica o ID único do serviço do ponto de extremidade da VPC.
service_name	String	Especifica o nome do serviço do ponto de extremidade da VPC.
service_type	String	Especifica o tipo do serviço do ponto de extremidade da VPC. Somente seus serviços privados podem ser configurados em serviços do ponto de extremidade da VPC de interface. ● gateway: os serviços do ponto de extremidade de VPC desse tipo são configurados por equipe de O&M. Você pode usá-los diretamente sem criá-los por si mesmos. ● interface: serviços de nuvem configurados pela equipe de O&M e serviços privados criados por você estão incluídos. Você não pode configurar esses serviços de nuvem, mas pode usá-los. Você pode criar um ponto de extremidade da VPC para acessar serviços de gateway e interface do ponto de extremidade da VPC.
created_at	String	Especifica o horário de criação do serviço do ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ.
is_charge	Boolean	Especifica se o ponto de extremidade da VPC associado carrega uma cobrança. ● true: o ponto de extremidade da VPC associado precisa ser cobrado. ● false: o ponto de extremidade da VPC associado não precisa ser cobrado.

Código de estado: 400

**Tabela 5** 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 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 estado: 401

**Tabela 7** 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 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 estado: 403

**Tabela 9** 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 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 estado: 404

**Tabela 11** 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 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 estado: 405

**Tabela 13** 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 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 estado: 406

**Tabela 15** 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 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 estado: 407

**Tabela 17** 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 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 estado: 408

**Tabela 19** 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 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 estado: 409

**Tabela 21** 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 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 estado: 500

**Tabela 23** 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 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 estado: 501

**Tabela 25** 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 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 estado: 502

**Tabela 27** 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 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 estado: 503

**Tabela 29** 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 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 estado: 504

**Tabela 31** 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 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.

Exemplo de solicitações

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id={4189d3c2-8882-4871-a3c2-d380272eed83}

Exemplo de respostas

Código de estado: 200

O servidor processou a solicitação com sucesso.

{
  "id" : "9d4c1028-1336-4556-9881-b5d807c1b8a8",
  "service_name" : "test123",
  "service_type" : "interface",
  "created_at" : "2018-09-17T07:28:31Z",
  "is_charge" : "true"
}

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