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

Consulta os atributos de um serviço de endpoint que pertence à conta atual.

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

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do serviço de endpoint. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-huhehaote
ServiceId	string	Sim	O ID do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****
RegionId	string	Sim	O ID da região onde o serviço de endpoint está localizado. Você pode chamar a operação DescribeRegions para obter o ID da região.	cn-huhehaote

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
RequestId	string	O ID da solicitação.	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescription	string	A descrição do serviço de endpoint.	This is my EndpointService
CreateTime	string	A hora em que o serviço de endpoint foi criado.	2020-01-02T19:11:12Z
MaxBandwidth	integer	A largura de banda máxima da conexão de endpoint. Unidade: Mbps.	1024
MinBandwidth	integer	A largura de banda mínima da conexão de endpoint. Unidade: Mbps.	100
ServiceDomain	string	O nome de domínio de serviço do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
AutoAcceptEnabled	boolean	Especifica se as conexões de endpoint devem ser aceitas automaticamente. Valores válidos: true: aceita automaticamente as conexões de endpoint. false: não aceita automaticamente as conexões de endpoint.	true
ZoneAffinityEnabled	boolean	Indica se a afinidade de zona está ativada para o nome de domínio de endpoint do serviço conectado. Valores válidos: true (padrão): A afinidade de zona está ativada. false: A afinidade de zona está desativada.	true
ServiceId	string	O ID do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****
Zones	array	A lista de zonas nas quais os recursos de serviço residem.
	string	A zona na qual os recursos de serviço residem.	cn-huhehaote-b
ServiceBusinessStatus	string	O status comercial do serviço de endpoint. Valores válidos: Normal: normal. FinancialLocked: bloqueio financeiro.	Normal
ServiceName	string	O nome do serviço de endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	O status do serviço de endpoint. Valores válidos: Creating: sendo criado. Pending: sendo modificado. Active: disponível. Deleting: sendo excluído.	Active
ConnectBandwidth	integer	O limite padrão de largura de banda da conexão de endpoint. Unidade: Mbps. Valores válidos: 100 a 10240.	3072
RegionId	string	A região à qual o serviço de endpoint pertence.	cn-huhehaote
ServiceType	string	O tipo de endpoint. Interface: um endpoint de interface. Você pode adicionar instâncias de Classic Load Balancer (CLB), Application Load Balancer (ALB) e Network Load Balancer (NLB) como recursos de serviço. GatewayLoadBalancer: um endpoint de Gateway Load Balancer (GWLBe). Você pode adicionar instâncias de Gateway Load Balancer (GWLB) como recursos de serviço.	Interface
ServiceResourceType	string	O tipo de recurso EPS. Valores válidos: slb: o tipo de recurso EPS é Classic Load Balancer (CLB). alb: o tipo de recurso EPS é Application Load Balancer (ALB). nlb: o tipo de recurso EPS é Network Load Balancer (NLB). gwlb: o tipo de recurso EPS é Gateway Load Balancer (GWLB).	slb
ServiceSupportIPv6 `deprecated`	boolean	Indica se o IPv6 é suportado para o serviço de endpoint. Valores válidos: true: O IPv6 é suportado. false (padrão): O IPv6 não é suportado.	false
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmy*****
AddressIpVersion	string	A versão do protocolo. Valores válidos: IPv4: IPv4. DualStack: pilha dupla.	IPv4
SupportedRegionSet	array<object>	A lista de regiões suportadas pelo serviço de endpoint. Os consumidores do serviço podem iniciar conexões de endpoint a partir das regiões nesta lista.
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	O status da região suportada pelo serviço de endpoint. Valores válidos: Pending: sendo modificado. Available: disponível. Deleting: sendo excluído. Failed: falhou. Closed: fechado.	Available
RegionBusinessStatus	string	O status comercial da região suportada pelo serviço de endpoint. Valores válidos: Normal: normal. FinancialLocked: bloqueio financeiro.	Normal
SupportedRegionId	string	O ID da região suportada pelo serviço de endpoint.	cn-hangzhou

Exemplos

Resposta de sucesso

JSON formato

{
  "Payer": "Endpoint",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2020-01-02T19:11:12Z",
  "MaxBandwidth": 1024,
  "MinBandwidth": 100,
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "AutoAcceptEnabled": true,
  "ZoneAffinityEnabled": true,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "Zones": [
    "cn-huhehaote-b"
  ],
  "ServiceBusinessStatus": "Normal",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ConnectBandwidth": 3072,
  "RegionId": "cn-huhehaote",
  "ServiceType": "Interface",
  "ServiceResourceType": "slb",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	EndpointServiceNotFound	The specified Service 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.