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

Consulta os atributos de um endpoint.

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

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 do endpoint cujos atributos você deseja consultar. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-huhehaote
EndpointId	string	Sim	O ID do endpoint cujos atributos você deseja consultar.	ep-hp33b2e43fays7s8****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Payer	string	O pagador. Valores válidos: Endpoint: o consumidor do serviço. EndpointService: o provedor do serviço.	Endpoint
EndpointDomain	string	O nome de domínio do endpoint.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	O ID da solicitação.	8D8992C1-6712-423C-BAC5-E5E817484C6B
CreateTime	string	A hora em que o endpoint foi criado.	2021-09-24T18:00:07Z
ResourceOwner	boolean	Indica se o endpoint e o serviço de endpoint pertencem à mesma conta Alibaba Cloud. Valores válidos: true: O endpoint e o serviço de endpoint pertencem à mesma conta. false: O endpoint e o serviço de endpoint pertencem a contas diferentes.	true
EndpointBusinessStatus	string	O status comercial do endpoint. Valores válidos: Normal: Normal. FinancialLocked: Bloqueio financeiro.	Normal
EndpointDescription	string	A descrição do endpoint.	This is my Endpoint
ServiceId	string	O ID do serviço de endpoint ao qual o endpoint está associado.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	O status do endpoint. Valores válidos: Creating: sendo criado. Active: disponível. Pending: sendo modificado. Deleting: sendo excluído.	Active
VpcId	string	O ID da nuvem privada virtual (VPC) à qual o endpoint pertence.	vpc-fdfhkjafhjvcvdjf****
EndpointName	string	O nome do endpoint.	test
ZonePrivateIpAddressCount	integer	O número de endereços IP privados atribuídos à interface de rede elástica (ENI) do endpoint em cada zona. O valor é fixo como 1.	1
EndpointType	string	O tipo de endpoint. Valores válidos: Interface: endpoint de interface. Reverse: endpoint reverso. GatewayLoadBalancer: endpoint Gateway Load Balancer (GWLBe).	Interface
ServiceName	string	O nome do serviço de endpoint ao qual o endpoint está associado.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	A largura de banda da conexão do endpoint. Unidade: Mbps.	1024
EndpointId	string	O ID do endpoint.	ep-hp33b2e43fays7s8****
RegionId	string	O ID da região do endpoint.	cn-huhehaote
ConnectionStatus	string	O status da conexão do endpoint. Valores válidos: Pending: sendo modificado. Connecting: conectando. Connected: conectado. Disconnecting: desconectando. Disconnected: desconectado. Deleting: sendo excluído. ServiceDeleted: o serviço de endpoint correspondente foi excluído.	Connected
ZoneAffinityEnabled	boolean	Indica se a afinidade de zona está ativada para o nome de domínio do endpoint resolver para o serviço conectado. Valores válidos: true: ativado. false: desativado.	true
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmz7nocpei***
PolicyDocument	string	A política de acesso do RAM. Para obter mais informações sobre a definição da política, consulte Elementos da política.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	A versão do protocolo. Valores válidos: IPv4: IPv4. DualStack: pilha dupla.	IPv4
ServiceRegionId	string	O ID da região do serviço de endpoint ao qual o endpoint está associado.	cn-hangzhou
CrossRegionBandwidth	integer	A largura de banda entre regiões do endpoint. Unidade: Mbps.	1000
ProtectedEnabled	boolean	Indica se a proteção gerenciada está ativada. Este parâmetro entra em vigor apenas quando o método de chamada STS é usado. Valores válidos: true: ativado. Após a ativação da proteção gerenciada, apenas o mesmo usuário que criou o endpoint pode modificar ou excluir o endpoint usando STS. false: desativado.

Exemplos

Resposta de sucesso

JSON formato

{
  "Payer": "Endpoint",
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "CreateTime": "2021-09-24T18:00:07Z",
  "ResourceOwner": true,
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "Este é meu Endpoint",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-fdfhkjafhjvcvdjf****",
  "EndpointName": "teste",
  "ZonePrivateIpAddressCount": 1,
  "EndpointType": "Interface",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 1024,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "RegionId": "cn-huhehaote",
  "ConnectionStatus": "Connected",
  "ZoneAffinityEnabled": true,
  "ResourceGroupId": "rg-acfmz7nocpei***",
  "PolicyDocument": "{\n  \"Version\": \"1\",\n  \"Statement\": [\n    {\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"oss:List*\",\n        \"oss:PutObject\",\n        \"oss:GetObject\"\n      ],\n      \"Resource\": [\n        \"acs:oss:oss-*:*:pvl-policy-test/policy-test.txt\"\n      ],\n      \"Principal\": {\n        \"RAM\": [\n          \"acs:ram::14199xxxxxx:*\"\n        ]\n      }\n    }\n  ]\n}",
  "AddressIpVersion": "IPv4",
  "ServiceRegionId": "cn-hangzhou",
  "CrossRegionBandwidth": 1000,
  "ProtectedEnabled": false
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	EndpointNotFound	The specified Endpoint does not exist.
400	EndpointConnectionNotFound	The specified endpoint connection does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.