Query authorized endpoint services using ListVpcEndpointServicesByEndUser - PrivateLink - Alibaba Cloud - PrivateLink

Call the ListVpcEndpointServicesByEndUser operation to retrieve a list of endpoint services for which the current account is whitelisted. This list includes services that you can connect to by creating new endpoints, as well as services that are already connected to your existing ones.

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 region ID. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
NextToken	string	No	The pagination token. If this is your first request, do not specify this parameter. If more results are available, set this parameter to the NextToken value from the previous response to retrieve the next page.	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. Only Interface is supported. An interface endpoint allows you to use Application Load Balancers (ALBs), Classic Load Balancers (CLBs), and Network Load Balancers (NLBs) as service resources.	Interface
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
Tag	array<object>	No	A list of tags to filter resources. You can specify up to 20 tags.
	object	No	A key-value pair that makes up a tag.
Key	string	No	The key of the tag. 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:` and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The value of the tag. 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:` and cannot contain `http://` or `https://`.	FinanceJoshua
ResourceGroupId	string	No	The resource group ID.	rg-acfmy*****
ServiceRegionId	string	No	The region ID of the endpoint service.	cn-beijing

Response elements

Element	Type	Description	Example
	object
Services	array<object>	The endpoint services.
	array<object>	An endpoint service.
Payer	string	The payer. Valid values: Endpoint: the service consumer. EndpointService: the service provider.	Endpoint
ServiceDomain	string	The domain name of the endpoint service.	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 always Interface. This indicates an interface endpoint where you can add service resources such as Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).	Interface
ServiceSupportIPv6	boolean	Specifies whether the endpoint service supports IPv6. Valid values: true: The endpoint service supports IPv6. false: The endpoint service does not support IPv6.	false
Tags	array<object>	A list of tags.
	object	A tag.
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 service resource type. slb: A Classic Load Balancer (CLB) instance. alb: An Application Load Balancer (ALB) instance. nlb: A Network Load Balancer (NLB) instance.	slb
AddressIpVersion	string	The IP version. Valid values: IPv4: The service supports IPv4. DualStack: The service supports both IPv4 and IPv6 (dual stack).	IPv4
ZoneAffinityEnabled	boolean	Specifies whether zone affinity is enabled. Valid values: true: Zone affinity is enabled. false: Zone affinity is disabled.	false
VpcEndpointPolicySupported	boolean
AutoAcceptEnabled	boolean	Specifies whether connection requests are automatically accepted. Valid values: true: Connection requests are automatically accepted. false: Connection requests must be manually accepted.	true
NextToken	string	The token that is used to retrieve the next page of results. Valid values: If this parameter is empty, all results have been returned. If a value is returned, use it in a subsequent request to retrieve the next 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.	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": true
    }
  ],
  "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.