ListVpcGatewayEndpoints - Virtual Private Cloud: Central de Documentação do Alibaba Cloud

Consulta os endpoints de gateway.

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

vpc:ListVpcGatewayEndpoints

list

GatewayEndpoint

acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/*

GatewayEndpoint

acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EndpointId	string	Não	O ID do endpoint de gateway.	vpce-bp1i1212ss2whuwyw****
EndpointName	string	Não	O nome do endpoint de gateway. O nome deve ter de 1 a 128 caracteres.	test
ServiceName	string	Não	O nome do serviço de endpoint.	com.aliyun.cn-hangzhou.oss
NextToken	string	Não	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Você não precisa especificar este parâmetro na primeira solicitação. Se um valor for retornado para NextToken, especifique o valor na próxima solicitação para recuperar uma nova página de resultados.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Não	O número de entradas a serem retornadas por página. Valores válidos: 1 a 100. Valor padrão: 20.	20
RegionId	string	Sim	O ID da região do endpoint de gateway. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o endpoint de gateway pertence.	rg-acfmxvfvazb4p****
Tags	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag N adicionada ao recurso. Você pode especificar no máximo 20 chaves de tag. Não pode ser uma string vazia. A chave não pode exceder 64 caracteres e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). A chave deve começar com uma letra, mas não pode começar com `aliyun` ou `acs:`. A chave não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag N adicionada ao recurso. Você pode especificar no máximo 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag não pode exceder 128 caracteres e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). O valor deve começar com uma letra, mas não pode começar com `aliyun` ou `acs:`. O valor não pode conter `http://` ou `https://`.	FinanceJoshua
VpcId	string	Não	O ID da nuvem privada virtual (VPC) à qual o endpoint de gateway pertence.	vpc-bp1gsk7h12ew7oegk****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O ID da solicitação.
RequestId	string	O ID da solicitação.	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Se nenhum valor for retornado para NextToken, nenhuma consulta subsequente será enviada. Se um valor for retornado para NextToken, o valor poderá ser usado na próxima solicitação para recuperar uma nova página de resultados.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	O número de entradas retornadas.	10
Endpoints	array<object>	A lista de endpoints de gateway.
	array<object>
EndpointId	string	O ID do endpoint de gateway.	vpce-bp1i1212ss2whuwyw****
EndpointName	string	O nome do endpoint de gateway.	test
EndpointDescription	string	A descrição do endpoint de gateway.	test_description
ServiceName	string	O nome do serviço de endpoint.	com.aliyun.cn-hangzhou.oss
VpcId	string	O ID da nuvem privada virtual (VPC) à qual o endpoint de gateway pertence.	vpc-bp1gsk7h12ew7oegk****
PolicyDocument	string	A política de acesso para o serviço em nuvem. Para obter mais informações sobre a sintaxe e a estrutura da política de acesso, consulte Sintaxe e estrutura da política.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
CreationTime	string	A hora em que o endpoint foi criado. A hora segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2021-09-08T08:43:04Z
EndpointStatus	string	O status do endpoint de gateway. Valores válidos: Creating Created Modifying Associating Dissociating Deleting	Created
AssociatedRouteTables	array	O ID da tabela de rotas associada ao endpoint de gateway.
	string	O ID da tabela de rotas associada ao endpoint de gateway.	vtb-bp1sme72jnuodvyx7****
ResourceGroupId	string	O ID do grupo de recursos ao qual o endpoint de gateway pertence.	rg-acfmxvfvazb4p****
Tags	array<object>	A lista de tags.
	object
Key	string	The key of tag N added to the resource.	FinanceDept
Value	string	The value of tag N added to the resource.	FinanceJoshua
MaxResults	integer	O número de entradas por página.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0AB1129F-32C1-5E4D-9E22-E4A859CA46EB",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "Endpoints": [
    {
      "EndpointId": "vpce-bp1i1212ss2whuwyw****",
      "EndpointName": "test",
      "EndpointDescription": "test_description",
      "ServiceName": "com.aliyun.cn-hangzhou.oss",
      "VpcId": "vpc-bp1gsk7h12ew7oegk****",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "CreationTime": "2021-09-08T08:43:04Z",
      "EndpointStatus": "Created",
      "AssociatedRouteTables": [
        "vtb-bp1sme72jnuodvyx7****"
      ],
      "ResourceGroupId": "rg-acfmxvfvazb4p****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "MaxResults": 20
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.
400	IllegalParam.MaxResults	The param of MaxResults is illegal.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.