ListVpcEndpoints - PrivateLink: Central de Documentação do Alibaba Cloud

Consulta endpoints.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

privatelink:ListVpcEndpoints

get

*VpcEndpoint.

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região dos endpoints a serem consultados. Você pode chamar a operação DescribeRegions para obter o ID da região.	cn-huhehaote
NextToken	string	Não	O token de paginação para a próxima consulta. Valores válidos:\n- Se esta for a primeira consulta ou nenhuma próxima consulta for necessária, deixe este parâmetro vazio.\n- Se uma próxima consulta for necessária, defina o valor como o valor de NextToken retornado da chamada de API anterior.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	Não	O número de entradas por página. Valores válidos: 1 a 1000. Valor padrão: 50.	50
EndpointId	string	Não	O ID do endpoint a ser consultado.	ep-hp33b2e43fays7s8****
ServiceName	string	Não	O nome do serviço de endpoint associado ao endpoint a ser consultado.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	Não	A VPC à qual o endpoint pertence.	vpc-fdjkf789dfdfdfde****
EndpointName	string	Não	O nome do endpoint.	test
EndpointType	string	Não	O tipo de endpoint. Valores válidos:\n\n- Interface: endpoint de interface.\n\n- Reverse: endpoint reverso.\n- GatewayLoadBalancer: endpoint de Gateway Load Balancer.	Interface
EndpointStatus	string	Não	O status do endpoint. Valores válidos:\n\n- Creating: O endpoint está sendo criado.\n\n- Active: O endpoint está disponível.\n\n- Pending: O endpoint está sendo modificado.\n\n- Deleting: O endpoint está sendo excluído.	Active
ConnectionStatus	string	Não	O status da conexão do endpoint. Valores válidos:\n\n- Pending: O endpoint está sendo modificado.\n\n- Connecting: O endpoint está sendo conectado.\n\n- Connected: O endpoint está conectado.\n\n- Disconnecting: O endpoint está sendo desconectado.\n\n- Disconnected: O endpoint está desconectado.\n\n- Deleting: O endpoint está sendo excluído.\n\n- ServiceDeleted: O serviço de endpoint associado ao endpoint foi excluído.	Disconnected
Tag	array<object>	Não	A lista de tags.
	object	Não	A tag.
Key	string	Não	A chave da tag da instância. Você pode especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag da instância. Você pode especificar até 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	FinanceJoshua
ResourceGroupId	string	Não	O ID do grupo de recursos.	1
AddressIpVersion	string	Não	A versão do IP. Valores válidos:\n\n- IPv4: IPv4.\n- DualStack: dual-stack.	IPv4
ServiceRegionId	string	Não	O ID da região do serviço de endpoint.	cn-huhehaote

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Endpoints	array<object>	Os endpoints.
	array<object>	Os endpoints.
VpcId	string	A VPC à qual o endpoint pertence.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	O nome do endpoint.	test
EndpointType	string	O tipo de endpoint. Valores válidos:\n\n- Interface: endpoint de interface.\n\n- Reverse: endpoint reverso.\n- GatewayLoadBalancer: endpoint de Gateway Load Balancer.	Interface
CreateTime	string	A hora em que o endpoint foi criado. A hora é exibida em UTC e segue o padrão ISO 8601 no formato AAAA-MM-DDTHH:mm:ssZ.	2021-09-24T18:00:07Z
ServiceId	string	O ID do serviço de endpoint associado ao endpoint.	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	Especifica se a afinidade de zona está ativada para o nome de domínio do endpoint usado para conectar ao serviço. Valores válidos:\n- true: sim.\n\n- false: não.	true
EndpointDomain	string	O nome de domínio do endpoint.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	O status do endpoint. Valores válidos:\n\n- Creating: O endpoint está sendo criado.\n\n- Active: O endpoint está disponível.\n\n- Pending: O endpoint está sendo modificado.\n\n- Deleting: O endpoint está sendo excluído.	Active
RegionId	string	O ID da região do endpoint.	cn-huhehaote
ResourceOwner	boolean	Especifica se o endpoint e o serviço de endpoint pertencem à mesma conta da Alibaba Cloud. Valores válidos:\n\n- true: sim.\n\n- false: não.	true
Bandwidth	integer	A largura de banda de conexão do endpoint. Unidade: Mbit/s.	1024
ConnectionStatus	string	O status da conexão do endpoint. Valores válidos:\n\n- Pending: O endpoint está sendo modificado.\n\n- Connecting: O endpoint está sendo conectado.\n\n- Connected: O endpoint está conectado.\n\n- Disconnecting: O endpoint está sendo desconectado.\n\n- Disconnected: O endpoint está desconectado.\n\n- Deleting: O endpoint está sendo excluído.\n\n- ServiceDeleted: O serviço de endpoint associado ao endpoint foi excluído.	Disconnected
EndpointDescription	string	A descrição do endpoint.	This is my Endpoint.
EndpointId	string	O ID do endpoint.	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	O status comercial do endpoint. Valores válidos:\n\n- Normal: Normal.\n\n- FinancialLocked: Bloqueado devido a pagamento em atraso.	Normal
ServiceName	string	O nome do serviço de endpoint associado ao endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	A lista de tags.
	object	A lista de tags.
Key	string	A chave da tag da instância.	FinanceDept
Value	string	O valor da tag da instância.	FinanceJoshua
ResourceGroupId	string	O ID da instância de recurso.	1
PolicyDocument	string	A política de acesso do Resource Access Management (RAM). Para obter mais informações sobre os elementos da política, consulte Elementos da política.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	A versão do IP. Valores válidos:\n\n- IPv4: IPv4.\n- DualStack: dual-stack.	IPv4
ServiceRegionId	string	O ID da região do serviço de endpoint associado ao endpoint.	cn-huhehaote
CrossRegionBandwidth	integer	A largura de banda entre regiões do endpoint. Unidade: Mbit/s.	1000
ProtectedEnabled	boolean	Especifica se a proteção gerenciada está ativada. Este parâmetro entra em vigor apenas para chamadas do Security Token Service (STS). Valores válidos:\n\n- true: ativada. Depois que a proteção gerenciada é ativada, apenas o usuário que criou o endpoint pode modificar ou excluir o endpoint usando o STS.\n\n- false: desativada.
NextToken	string	O token de paginação para a próxima consulta. Valores válidos:\n- Se NextToken estiver vazio, nenhuma próxima consulta é necessária.\n- Se NextToken for retornado, o valor indica o token para a próxima consulta.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	O ID da solicitação.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	O número de entradas por página.	50
TotalCount	integer	O número total de entradas.	12

Exemplos

Resposta de sucesso

JSON formato

{
  "Endpoints": [
    {
      "VpcId": "vpc-hp356stwkxg3fn2xe****",
      "EndpointName": "test",
      "EndpointType": "Interface",
      "CreateTime": "2021-09-24T18:00:07Z",
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ZoneAffinityEnabled": true,
      "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
      "EndpointStatus": "Active",
      "RegionId": "cn-huhehaote",
      "ResourceOwner": true,
      "Bandwidth": 1024,
      "ConnectionStatus": "Disconnected",
      "EndpointDescription": "This is my Endpoint.",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointBusinessStatus": "Normal",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "1",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "AddressIpVersion": "IPv4",
      "ServiceRegionId": "cn-huhehaote",
      "CrossRegionBandwidth": 1000,
      "ProtectedEnabled": false
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.