Query available endpoint services using ListVpcEndpointServicesByEndUser - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Queries available endpoint services.

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
ServiceName	string	No	The name of the endpoint service that you want to query.	com.aliyun.cn-hangzhou.oss
NextToken	string	No	The token that is used for the next query. Valid values: If this is your first query and no next queries are to be sent, ignore this parameter. If a next query is to be performed, set the value to the NextToken value returned in the last call to the ListListenerCertificates operation.	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. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	The token that is used for the next query. Valid values: If no value is returned for NextToken, no next queries are sent. If NextToken is returned, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries returned per page.	20
Services	array<object>	The list of entries returned.
	object
ServiceId	string	The ID of the endpoint service.	vpces-m5enwdmilo210aibo9****
ServiceName	string	The name of the endpoint service.	com.aliyun.cn-hangzhou.oss
DefaultPolicyDocument	string	The default access policy.	{ \"Version\" : \"1\", \"Statement\" : [ { \"Effect\" : \"Allow\", \"Action\" : \"\", \"Principal\" : \"\", \"Resource\" : \"*\" } ] }
SupportPolicy	boolean	Indicate whether the endpoint service supports the access policy. Valid values: false true	true
ServiceDomain	string	The domain name of the cloud service to which the endpoint service belongs.	oss-admin.aliyuncs.com
TotalCount	string	The total number of entries returned.	2

Examples

Success response

JSON format

{
  "RequestId": "0AB1129F-32C1-5E4D-9E22-E4A859CA46EB",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "Services": [
    {
      "ServiceId": "vpces-m5enwdmilo210aibo9****",
      "ServiceName": "com.aliyun.cn-hangzhou.oss",
      "DefaultPolicyDocument": "{   \\\"Version\\\" : \\\"1\\\",   \\\"Statement\\\" : [ {     \\\"Effect\\\" : \\\"Allow\\\",     \\\"Action\\\" : \\\"*\\\",     \\\"Principal\\\" : \\\"*\\\",     \\\"Resource\\\" : \\\"*\\\"   } ] }",
      "SupportPolicy": true,
      "ServiceDomain": "oss-admin.aliyuncs.com"
    }
  ],
  "TotalCount": "2"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.EndpointServiceId	The specified resource gateway endpoint service is not found.
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.