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 pontos de extremidade da VPC
Atualizado em 2023-02-20 GMT+08:00

Consulta de pontos de extremidade da VPC

Função

Função Essa API é usada para consultar pontos de extremidade da VPC.

URI

GET /v1/{project_id}/vpc-endpoints

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. O nome não diferencia maiúsculas de minúsculas e suporta correspondência difusa.

Mínimo: 1

Máximo: 128

vpc_id

Não

String

Especifica o ID da VPC em que o ponto de extremidade da VPC será criado.

Mínimo: 1

Máximo: 64

id

Não

String

Especifica o ID exclusivo do ponto de extremidade da VPC.

Mínimo: 1

Máximo: 64

limit

Não

Integer

Especifica o número máximo de pontos de extremidade da VPC exibidos em cada página. O valor varia de 0 a 500 e é geralmente 10, 20 ou 50. O número padrão é 10.

Mínimo: 1

Máximo: 1000

Padrão: 10

offset

Não

Integer

Especifica o deslocamento. Todos os serviços do ponto de extremidade da VPC após esse deslocamento serão consultados. O deslocamento deve ser um número inteiro maior que 0, mas menor que o número de serviços do ponto de extremidade da VPC.

Mínimo: 0

sort_key

Não

String

Especifica o campo de classificação dos endpoints da VPC, que pode ser: ●create_at: os pontos de extremidade da VPC são classificados por hora de criação. ●update_at: os pontos de extremidade da VPC são classificados por hora de atualização. O campo padrão é create_at.

sort_dir

Não

String

Especifica o método de classificação dos pontos de extremidade da VPC, que pode ser: ● desc: os pontos de extremidade da VPC são classificados em ordem decrescente. ● asc: os pontos de extremidade da VPC são classificados em ordem crescente. O método padrão é desc.

public_border_group

Não

String

Especifica o serviço do ponto de extremidade da VPC que corresponde ao atributo de borda no resultado da filtragem.

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

Pontos de extremidade

Array of EndpointResp objects

Lista de pontos de extremidade.

total_count

Integer

Especifica o número total de pontos de extremidade que atendem aos critérios de pesquisa. O número não é afetado pelos parâmetros limite e offset.

Tabela 5 EndpointResp

Parâmetro

Tipo

Descrição

id

String

Especifica o ID exclusivo do ponto de extremidade da VPC.

service_type

String

Especifica o tipo de serviço do ponto de extremidade da VPC associado ao ponto de extremidade da VPC. ● gateway: configurado pelo pessoal de O&M. Você pode usá-los diretamente sem criá-los por si mesmos. ● interface: inclui serviços em nuvem configurados pela equipe de O&M e serviços privados criados pelos usuários. Você não pode configurar esses serviços de nuvem, mas pode usá-los. Você pode consultar serviços públicos do ponto de extremidade da VPC para visualizar os serviços do ponto de extremidade da VPC visíveis e acessíveis a todos os usuários configurados pela equipe de O&M. Você também pode criar um serviço do ponto de extremidade da VPC de interface criando um serviço do ponto de extremidade da VPC.

status

String

Especifica o status da conexão do ponto de extremidade da VPC. ●pendingAcceptance: a conexão do ponto de extremidade da VPC deve ser aceita. ● creating: s conexão do ponto de extremidade da VPC está sendo criada. ●accepted: a conexão do ponto de extremidade da VPC foi aceita. ● failed: a conexão do ponto de extremidade da VPC falhou.

active_status

Array of strings

Especifica o status da conta. ● frozen: a conta está congelada. ● active: a conta está descongelada.

endpoint_service_name

String

Especifica o nome do serviço do ponto de extremidade da VPC.

marker_id

Integer

Especifica o ID do pacote do ponto de extremidade da VPC.

endpoint_service_id

String

Especifica o ID do serviço do ponto de extremidade da VPC.

enable_dns

Boolean

Especifica se deve ou não criar um nome de domínio. ● true: um nome de domínio é necessário. ● false: um nome de domínio não é necessário. Observação: quando você cria um ponto de extremidade da VPC para conectar um serviço de gateway do ponto de extremidade da VPC, nenhum nome de domínio é criado se enable_dns estiver definido como true ou false.

dns_names

Array of strings

Especifica o nome de domínio para acessar o serviço do ponto de extremidade da VPC associado. Este parâmetro só está disponível quando enable_dns é definido como true.

ip

String

Especifica o endereço IP para acessar o serviço do ponto de extremidade da VPC associado. Este parâmetro é retornado somente quando as seguintes condições são atendidas: você consulta um ponto de extremidade da VPC para acessar um serviço de interface de ponto de extremidade da VPC. A função de aprovação de conexão está habilitada para o serviço do ponto de extremidade da VPC, e a conexão foi aceita. O status do ponto de extremidade da VPC pode ser accepted ou rejected. O status rejected aparece apenas quando a conexão do ponto de extremidade da VPC é aceita e, em seguida, rejeitada.

vpc_id

String

Especifica o ID da VPC em que o ponto de extremidade da VPC será criado.

subnet_id

String

Especifica o ID da sub-rede na VPC com base em vpc_id. O ID está no formato UUID.

created_at

String

Especifica o horário de criação de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MM-DDTHH:MM:SSZ.

updated_at

String

Especifica o horário de atualização de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MM-DDTHH:MM:SSZ.

project_id

String

Especifica a ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte "Obtenção de um ID de projeto".

tags

Array of TagList objects

Especifica a lista de marcas. Se não houver nenhuma tag na lista, as tags serão tomadas como uma matriz vazia.

error

Array of QueryError objects

Especifica a mensagem de erro. Esse campo é retornado quando o ponto de extremidade da VPC é anormal, ou seja, o valor de status é failed.

whitelist

Array of strings

Especifica a lista branca para controlar o acesso ao ponto de extremidade da VPC. Se você não especificar este parâmetro, uma lista branca vazia é retornada. Esse parâmetro só está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de interface de ponto de extremidade da VPC.

enable_whitelist

Boolean

Especifica se deve ativar o isolamento da ACL de rede. ● true: o isolamento da ACL de rede está habilitado. ● false: o isolamento ACL de rede está desabilitado. Se você não especificar esse parâmetro, o isolamento da ACL de rede será desabilitado. Esse parâmetro só está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de interface de ponto de extremidade da VPC.

routetables

Array of strings

Especifica os IDs das tabelas de rotas. Se você não especificar esse parâmetro, o ID da tabela de rotas da VPC será retornado. Esse parâmetro só está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de gateway de ponto de extremidade da VPC.

description

String

Especifica o campo de descrição. O valor pode conter caracteres como letras e dígitos, mas não pode conter sinais menores (<) e sinais maiores (>).

policy_statement

Array of PolicyStatement objects

Esse campo é exibido no corpo da resposta apenas para habilitar gateway do ponto de extremidade da VPC com portas fixas em ambas as extremidades.

endpoint_pool_id

String

Especifica o ID do pool associado ao ponto de extremidade da VPC.

public_border_group

String

Especifica as informações sobre o grupo de borda pública associado ao ponto de extremidade da VPC. Esse parâmetro é retornado somente quando o ponto final é associado a um pool de bordas.

Tabela 6 TagList

Parâmetro

Tipo

Descrição

key

String

Especifica a chave de tag. Uma chave de tag pode conter um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Não pode conter sinais iguais (=), asteriscos (*), sinais menores (<), sinais maiores (>), barras invertidas (), vírgulas (,), barras verticais (|) e barras (/), e o primeiro e último caracteres não podem ser espaços.

Mínimo: 1

Máximo: 36

value

String

Especifica a chave de tag. Um valor de tag contém um máximo de 43 caracteres Unicode e pode ser uma cadeia vazia. Não pode conter sinais iguais (=), asteriscos (*), sinais menores (<), sinais maiores (>), barras invertidas (), vírgulas (,), barras verticais (|) e barras (/), e o primeiro e último caracteres não podem ser espaços.

Mínimo: 1

Máximo: 43

Tabela 7 QueryError

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_message

String

Mensagem de erro.

Tabela 8 PolicyStatement

Parâmetro

Tipo

Descrição

Effect

String

Especifica se aceita ou rejeita as permissões ou o objeto do OBS

Action

Array of strings

Especifica as permissões de acesso do OBS.

Resource

Array of strings

Specifies the OBS object.

Código de estado: 400

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: 401

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: 403

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: 404

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: 405

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: 406

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: 407

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: 408

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: 409

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: 500

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: 501

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: 502

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.

Código de estado: 503

Tabela 33 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 34 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 35 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 36 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-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}

Exemplo de respostas

Código de estado: 200

O servidor processou a solicitação com sucesso.

{ "endpoints" : [ { "id" : "03184a04-95d5-4555-86c4-e767a371ff99", "status" : "accepted", "ip" : "192.168.0.232", "marker_id" : 16777337, "active_status" : "active", "vpc_id" : "84758cf5-9c62-43ae-a778-3dbd8370c0a4", "service_type" : "interface", "project_id" : "295dacf46a4842fcbf7844dc2dc2489d", "subnet_id" : "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de", "enable_dns" : "true", "dns_name" : "test123", "created_at" : "2018-10-18T06:49:46Z", "updated_at" : "2018-10-18T06:49:50Z", "endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78", "endpoint_service_name" : "test123", "endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde", "public_border_group" : "br-iaas-odin1raa", "whitelist" : [ "127.0.0.1" ], "enable_whitelist" : true }, { "id" : "43b0e3b0-eec9-49da-866b-6687b75f9fe5", "status" : "accepted", "ip" : "192.168.0.115", "marker_id" : 16777322, "active_status" : "active", "vpc_id" : "e251b400-2963-4131-b38a-da81e32026ee", "service_type" : "interface", "project_id" : "295dacf46a4842fcbf7844dc2dc2489d", "subnet_id" : "65528a22-59a1-4972-ba64-88984b3207cd", "enable_dns" : "true", "dns_name" : "test123", "created_at" : "2018-10-18T06:36:20Z", "updated_at" : "2018-10-18T06:36:24Z", "endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78", "endpoint_service_name" : "test123", "endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde", "whitelist" : [ "127.0.0.1" ], "enable_whitelist" : true } ], "total_count" : 2 }

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

Códigos de erro

Consulte Códigos de erro.