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

Consulta os serviços de endpoint pertencentes à sua conta.

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

get

*VpcEndpointService

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região em que o serviço de endpoint está implantado. Chame 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: Deixe este parâmetro vazio para a primeira consulta ou quando não houver mais resultados. Se outra consulta for necessária, defina este parâmetro com o valor NextToken retornado na chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Não	O número de entradas a serem retornadas por página. Valores válidos: 1 a 1000. Valor padrão: 50.	50
ServiceId	string	Não	O ID do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	Não	O nome do serviço de endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ResourceId	string	Não	O ID do recurso de serviço.	lb-hp32z1wp5peaoox2q****
ServiceResourceType	string	Não	O tipo do recurso de serviço. Valores válidos: slb: O recurso de serviço é uma instância de Classic Load Balancer (CLB). alb: O recurso de serviço é uma instância de Application Load Balancer (ALB). nlb: O recurso de serviço é uma instância de Network Load Balancer (NLB). gwlb: O recurso de serviço é uma instância de Gateway Load Balancer (GWLB).	slb
AutoAcceptEnabled	boolean	Não	Especifica se as conexões de endpoint devem ser aceitas automaticamente. Valores válidos: true: Aceita conexões de endpoint automaticamente. false: Não aceita conexões de endpoint automaticamente.	false
ServiceStatus	string	Não	O status do serviço de endpoint. Valores válidos: Creating: O serviço de endpoint está sendo criado. Pending: O serviço de endpoint está sendo modificado. Active: O serviço de endpoint está disponível. Deleting: O serviço de endpoint está sendo excluído.	Active
ServiceBusinessStatus	string	Não	O status comercial do serviço de endpoint. Valores válidos: Normal: O serviço de endpoint está em execução conforme o esperado. FinancialLocked: O serviço de endpoint está bloqueado devido a um pagamento em atraso.	Normal
ZoneAffinityEnabled	boolean	Não	Especifica se a afinidade de zona está ativada para a resolução de nomes de domínio. Valores válidos: true: Sim. false: Não.	true
RegionId	string	Sim	O ID da região em que o serviço de endpoint está implantado. Chame a operação DescribeRegions para obter o ID da região.	cn-huhehaote
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 não pode ser uma string vazia. A chave 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 pode ser uma string vazia. O valor 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.	rg-acfmy*****
AddressIpVersion	string	Não	A versão do endereço IP. Valores válidos: IPv4: Tipo IPv4. DualStack: Tipo pilha dupla.	IPv4

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Services	array<object>	A coleção de serviços de endpoint.
	array<object>	A coleção de serviços de endpoint.
AutoAcceptEnabled	boolean	Especifica se as conexões de endpoint devem ser aceitas automaticamente. Valores válidos: true: Aceita conexões de endpoint automaticamente. false: Não aceita conexões de endpoint automaticamente.	true
ServiceId	string	O ID do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****
CreateTime	string	A hora em que o serviço de endpoint foi criado.	2021-09-24T17:15:10Z
MinBandwidth	integer	A largura de banda mínima da conexão de endpoint. Unidade: Mbps.	100
MaxBandwidth	integer	A largura de banda máxima da conexão de endpoint. Unidade: Mbps.	1024
ServiceStatus	string	O status do serviço de endpoint. Valores válidos: Creating: O serviço de endpoint está sendo criado. Pending: O serviço de endpoint está sendo modificado. Active: O serviço de endpoint está disponível. Deleting: O serviço de endpoint está sendo excluído.	Active
ZoneAffinityEnabled	boolean	Indica se a afinidade de zona está ativada. Valores válidos: true: Sim. false: Não.	true
RegionId	string	O ID da região em que o serviço de endpoint está implantado.	cn-huhehaote
ServiceDomain	string	O nome de domínio do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Payer	string	O pagador. Valores válidos: Endpoint: o consumidor do serviço. EndpointService: o provedor do serviço.	Endpoint
ServiceBusinessStatus	string	O status comercial do serviço de endpoint. Valores válidos: Normal: O serviço de endpoint está em execução conforme o esperado. FinancialLocked: O serviço de endpoint está bloqueado devido a um pagamento em atraso.	Normal
ConnectBandwidth	integer	A largura de banda máxima padrão. Unidade: Mbps.	1024
ServiceName	string	O nome do serviço de endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceDescription	string	A descrição do serviço de endpoint.	This is my EndpointService.
ServiceResourceType	string	O tipo do recurso de serviço. Valores válidos: slb: O recurso de serviço é uma instância CLB. alb: O recurso de serviço é uma instância ALB. nlb: O recurso de serviço é uma instância NLB. gwlb: O recurso de serviço é uma instância GWLB.	slb
ServiceType	string	O tipo do serviço de endpoint. Valores válidos: Interface: um endpoint de interface. Você pode adicionar instâncias CLB, ALB e NLB como recursos de serviço. GatewayLoadBalancer: um endpoint de Gateway Load Balancer. Você pode adicionar instâncias GWLB como recursos de serviço.	Interface
ServiceSupportIPv6 `deprecated`	boolean	Indica se o serviço de endpoint suporta IPv6. Valores válidos: true: Sim. false: Não.	false
Tags	array<object>	A lista de tags.
	object	A lista de tags.
Key	string	The tag key of the instance.	FinanceDept
Value	string	The tag value of the instance.	FinanceJoshua
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmy*****
AddressIpVersion	string	A versão do endereço IP. Valores válidos: IPv4: Tipo IPv4. DualStack: Tipo 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 dessas regiões.
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	The status of the region supported by the endpoint service. Valid values: Pending: The status is being updated. Available: The region is available. Deleting: The region is being deleted. Failed: The operation failed. Closed: The region is closed.	Available
RegionBusinessStatus	string	The business status of the region supported by the endpoint service. Valid values: Normal: Normal. FinancialLocked: Locked due to an overdue payment.	Normal
SupportedRegionId	string	The ID of the region supported by the endpoint service.	cn-hangzhou
NextToken	string	O token de paginação para a próxima consulta. Valores válidos: Se NextToken estiver vazio, não há mais resultados. Se NextToken tiver um valor, use-o como token inicial para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	O número de entradas retornadas por página.	50
TotalCount	integer	O número total de registros.	12

Exemplos

Resposta de sucesso

JSON formato

{
  "Services": [
    {
      "AutoAcceptEnabled": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "CreateTime": "2021-09-24T17:15:10Z",
      "MinBandwidth": 100,
      "MaxBandwidth": 1024,
      "ServiceStatus": "Active",
      "ZoneAffinityEnabled": true,
      "RegionId": "cn-huhehaote",
      "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
      "Payer": "Endpoint",
      "ServiceBusinessStatus": "Normal",
      "ConnectBandwidth": 1024,
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
      "ServiceDescription": "This is my EndpointService.",
      "ServiceResourceType": "slb",
      "ServiceType": "Interface",
      "ServiceSupportIPv6": false,
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "rg-acfmy*****",
      "AddressIpVersion": "IPv4",
      "SupportedRegionSet": [
        {
          "ServiceRegionId": "",
          "RegionServiceStatus": "Available",
          "RegionBusinessStatus": "Normal",
          "SupportedRegionId": "cn-hangzhou"
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "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.