ListVpcEndpointServicesByEndUser - PrivateLink - Alibaba Cloud Documentation Center

Queries the endpoint services that you are authorized to associate with an endpoint.

Operation description

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

privatelink:ListVpcEndpointServicesByEndUser

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#AccountId}:vpcendpointservice/*

privatelink:VpcEndpointServiceId

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. To obtain a region ID, call the DescribeRegions operation. Get the region ID by calling the DescribeRegions API.	cn-huhehaote
NextToken	string	No	The token that is used to retrieve the next page of results. Valid values: If this is your first query or no next page exists, leave this parameter empty. If a next page exists, set the parameter to the NextToken value returned from the previous call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 1000. Default value: 50.	50
ServiceId	string	No	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	No	The name of the endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
ServiceType	string	No	The type of the endpoint service. Set the value to Interface. An interface endpoint lets you add service resources of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).	Interface
RegionId	string	Yes	The ID of the region. To obtain a region ID, call the DescribeRegions operation. You can obtain the region ID by calling the DescribeRegions API operation.	cn-huhehaote
Tag	array<object>	No	The tags.
	object	No	The tag.
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 can be up to 64 characters in length. It 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. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy*****

Response elements

Element	Type	Description	Example
	object
Services	array<object>	The endpoint services.
	array<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 you can connect to.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Zones	array	The zones where the endpoint service is available.
	string	The zone where the endpoint service is available.	cn-huhehaote-a
ServiceId	string	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	The name of the endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceType	string	The type of the endpoint service. The value is Interface, which indicates an interface endpoint. You can add service resources of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).	Interface
ServiceSupportIPv6	boolean	Indicates whether the endpoint service supports IPv6. Valid values: true false	false
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
ResourceGroupId	string	The ID of the resource group.	rg-acfmy*****
ServiceResourceType	string	The type of the service resource. slb: The service resource is a Classic Load Balancer (CLB) instance. alb: The service resource is an Application Load Balancer (ALB) instance. nlb: The service resource is a Network Load Balancer (NLB) instance.	slb
AddressIpVersion	string	The IP version. Valid values: IPv4 DualStack	IPv4
ZoneAffinityEnabled	boolean
VpcEndpointPolicySupported	boolean
AutoAcceptEnabled	boolean
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is empty, no next page exists. If a value is returned, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned on each page.	50
TotalCount	string	The total number of entries.	29

Examples

Success response

JSON format

{
  "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",
      "AddressIpVersion": "IPv4",
      "ZoneAffinityEnabled": false,
      "VpcEndpointPolicySupported": false,
      "AutoAcceptEnabled": false
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": "29"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.