ListVpcGatewayEndpoints - Query VPC gateway endpoints - Virtual Private Cloud

Queries VPC gateway endpoints.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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. 1 to 128 characters.	test
ServiceName	string	No	The name of the endpoint service.	com.aliyun.cn-hangzhou.oss
NextToken	string	No	The pagination token for the next query. Leave empty for the first request. If returned, use this value in the next request to retrieve more results.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return per page. Valid values: 1 to 100. Default value: 20.	20
RegionId	string	Yes	The region ID of the gateway endpoint. Call DescribeRegions 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	The tag list
Key	string	No	The tag key. Maximum 20 keys. Cannot be empty. Up to 64 characters; can contain digits, periods (.), underscores (_), and hyphens (-). Must start with a letter. Cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. Maximum 20 values. Can be empty. Up to 128 characters; can contain digits, periods (.), underscores (_), and hyphens (-). Must start with a letter. Cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	FinanceJoshua
VpcId	string	No	The ID of the VPC to which the gateway endpoint belongs.	vpc-bp1gsk7h12ew7oegk****

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	The pagination token for subsequent queries. If not returned, no more results are available. If returned, use this value in the next request.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The number of entries returned.	10
Endpoints	array<object>	The list of gateway endpoints.
	array<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 VPC to which the gateway endpoint belongs.	vpc-bp1gsk7h12ew7oegk****
PolicyDocument	string	The access policy for the cloud service. For syntax details, 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, in the YYYY-MM-DDThh:mm:ssZ format (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.
	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.
	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	The number of entries per page.	20

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.