ListVpcEndpointServicesByEndUser - PrivateLink - Alibaba Cloud Documentation Center

Queries a list of endpoint services that can be associated with the endpoint created within the current account.

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:ListVpcEndpointServicesByEndUser	Read	All Resources *	privatelink:VpcEndpointServiceId	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint. 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 value 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 ID of the endpoint service that you want to query.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	No	The name of the endpoint service that you want to query.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
ServiceType	string	No	The type of the endpoint service. Set the value to Interface. You can specify CLB and ALB instances as service resources for the endpoint service.	Interface
Tag	object []	No	The list of tags.
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	The returned results.
Services	object []	The endpoint services.
Payer	string	The payer. Valid values: Endpoint: the service consumer EndpointService: the service provider	Endpoint
ServiceDomain	string	The domain name of the endpoint service that can be associated with the endpoint.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Zones	array	The zones of the endpoint service that can be associated with the endpoint.
	string	The information about the array object.	cn-huhehaote-a
ServiceId	string	The ID of the endpoint service that can be associated with the endpoint.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	The name of the endpoint service that can be associated with the endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceType	string	The type of the endpoint service. Only Interface is returned, which indicates an interface endpoint. You can specify CLB and ALB instances as service resources.	Interface
ServiceSupportIPv6	boolean	Indicates whether IPv6 is enabled. Valid values: true false	false
Tags	object []	The list of tags.
Key	string	The key of the tag.	FinanceDept
Value	string	The value of the tag.	FinanceJoshua
ResourceGroupId	string	The resource group ID.	rg-acfmy*****
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
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	string	The total number of entries returned.	29

Examples

Sample success responses

JSONformat

{
  "Services": [
    {
      "Payer": "Endpoint",
      "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
      "Zones": [
        "cn-huhehaote-a"
      ],
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
      "ServiceType": "Interface",
      "ServiceSupportIPv6": false,
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "rg-acfmy*****",
      "ServiceResourceType": "slb"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": "29"
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-09-26

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-09-05

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-05-09

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-03-02

API Description Update. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Output Parameters	The response structure of the API has changed.

2022-09-20

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ResourceGroupId
Output Parameters	The response structure of the API has changed.

2022-07-26

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tag
Output Parameters	The response structure of the API has changed.

2021-10-14

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.