ListVpcGatewayEndpoints - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries gateway endpoints.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:ListVpcGatewayEndpoints	list	GatewayEndpoint acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/* GatewayEndpoint acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
EndpointId	string	No	The ID of the gateway endpoint.	vpce-bp1i1212ss2whuwyw****
EndpointName	string	No	The name of the gateway endpoint. The name must be 1 to 128 characters in length.	test
ServiceName	string	No	The name of the endpoint service.	com.aliyun.cn-hangzhou.oss
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. If a value is returned for NextToken, specify the value in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
RegionId	string	Yes	The region ID of the gateway endpoint. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the gateway endpoint belongs.	rg-acfmxvfvazb4p****
Tags	array<object>	No	The tag list.
	object	No
Key	string	No	The key of tag N added to the resource. You can specify at most 20 tag keys. It cannot be an empty string. The key cannot exceed 64 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The value of tag N added to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If no value is returned for NextToken, no next queries are sent. If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	long	The number of entries returned.	10
Endpoints	array<object>	The list of gateway endpoints.
Endpoint	object
EndpointId	string	The ID of the gateway endpoint.	vpce-bp1i1212ss2whuwyw****
EndpointName	string	The name of the gateway endpoint.	test
EndpointDescription	string	The description of the gateway endpoint.	test_description
ServiceName	string	The name of the endpoint service.	com.aliyun.cn-hangzhou.oss
VpcId	string	The ID of the virtual private cloud (VPC) to which the gateway endpoint belongs.	vpc-bp1gsk7h12ew7oegk****
PolicyDocument	string	The access policy for the cloud service. For more information about the syntax and structure of the access policy, see Policy syntax and structure.	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
CreationTime	string	The time when the endpoint was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2021-09-08T08:43:04Z
EndpointStatus	string	The status of the gateway endpoint. Valid values: Creating Created Modifying Associating Dissociating Deleting	Created
AssociatedRouteTables	array	The ID of the route table associated with the gateway endpoint.
RouteTable	string	The ID of the route table associated with the gateway endpoint.	vtb-bp1sme72jnuodvyx7****
ResourceGroupId	string	The ID of the resource group to which the gateway endpoint belongs.	rg-acfmxvfvazb4p****
Tags	array<object>	The tag list.
Tag	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	long	The number of entries per page.	20

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
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.	The VPC does not exist. Check whether the specified VPC is valid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-06	The Error code has changed	View Change Details
2023-06-13	The Error code has changed	View Change Details
2023-03-23	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details