ListVpcEndpointServices - PrivateLink - Alibaba Cloud Documentation Center

Queries a list of endpoint services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
privatelink:ListVpcEndpointServices	get	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint service. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is your first request and no next requests are to be performed, you do not need to specify this parameter. If a next request is to be performed, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.	50
ServiceId	string	No	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	No	The name of the endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ResourceId	string	No	The service resource ID.	lb-hp32z1wp5peaoox2q****
ServiceResourceType	string	No	The type of the service resource. Valid values: slb: a Classic Load Balancer (CLB) instance alb: an Application Load Balancer (ALB) instance	slb
AutoAcceptEnabled	boolean	No	Specifies whether to automatically accept endpoint connection requests. Valid values: true false (default)	false
ServiceStatus	string	No	The state of the endpoint service. Valid values: Creating: The endpoint service is being created. Pending: The endpoint service is being modified. Active: The endpoint service is available. Deleting: The endpoint service is being deleted	Active
ServiceBusinessStatus	string	No	The service state of the endpoint service. Valid values: Normal: The endpoint service runs as expected. FinancialLocked: The endpoint service is locked due to overdue payments.	Normal
ZoneAffinityEnabled	boolean	No	Specifies whether to first resolve the domain name of the nearest endpoint that is associated with the endpoint service. Valid values: true (default) false	true
Tag	array<object>	No	The list of tags.
	object	No	The information about the array object.
Key	string	No	The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The value of the tag. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.	FinanceJoshua
ResourceGroupId	string	No	The resource group ID.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object
Services	array<object>	The endpoint services.
Service	object	The information about the array object.
AutoAcceptEnabled	boolean	Indicates whether endpoint connection requests are automatically accepted. Valid values: true: Endpoint connection requests are automatically accepted. false: Endpoint connection requests are not automatically accepted.	true
ServiceId	string	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
CreateTime	string	The time when the endpoint service 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-24T17:15:10Z
MinBandwidth	integer	The minimum bandwidth of the endpoint connection. Unit: Mbit/s.	100
MaxBandwidth	integer	The maximum bandwidth of the endpoint connection. Unit: Mbit/s.	1024
ServiceStatus	string	The state of the endpoint service. Valid values: Creating: The endpoint service is being created. Pending: The endpoint service is being modified. Active: The endpoint service is available. Deleting: The endpoint service is being deleted.	Active
ZoneAffinityEnabled	boolean	Indicates whether zone affinity is enabled. Valid values: true false	true
RegionId	string	The region ID of the endpoint service.	cn-huhehaote
ServiceDomain	string	The domain name of the endpoint service.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Payer	string	The payer. Valid values: Endpoint: service consumer EndpointService: service provider	Endpoint
ServiceBusinessStatus	string	The service state of the endpoint service. Valid values: Normal: The endpoint service runs as expected. FinancialLocked: The endpoint service is locked due to overdue payments.	Normal
ConnectBandwidth	integer	The default maximum bandwidth of the endpoint connection. Unit: Mbit/s.	1024
ServiceName	string	The name of the endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceDescription	string	The description of the endpoint service.	This is my EndpointService.
ServiceResourceType	string	The type of the service resource. Valid values: slb: Classic Load Balancer (CLB) instance alb: Application Load Balancer (ALB) instance nlb: Network Load Balancer (NLB) instance	slb
ServiceType	string	The type of the endpoint service. Only Interface may be returned. You can specify CLB, ALB, and NLB instances as the service resources of the endpoint service.	Interface
ServiceSupportIPv6	boolean	Indicates whether the endpoint service supports IPv6. Valid values: true false	false
Tags	array<object>	The tags added to the resource.
TagModel	object	The information about the array object.
Key	string	The key of the tag added to the resource.	FinanceDept
Value	string	The value of the tag added to the resource.	FinanceJoshua
ResourceGroupId	string	The ID of the resource group.	rg-acfmy*****
NextToken	string	The returned value of NextToken is a pagination token, which 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 requests are performed. If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of entries returned.	12

Examples

Sample success responses

JSONformat

{
  "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*****"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-12	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-09-26	The response structure of the API has changed	View Change Details
2023-09-05	The response structure of the API has changed	View Change Details
2023-03-02	API Description Update. The response structure of the API has changed	View Change Details
2022-12-06	The request parameters of the API has changed	View Change Details
2022-09-20	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-07-26	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2021-03-17	The response structure of the API has changed	View Change Details