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

Invokes the ListVpcEndpointServicesByEndUser operation to query the endpoint services for which the current account is in the authorization whitelist. The results include services under the current account and other accounts. The results cover services that are active and can be associated when you create an endpoint, and services that are already associated with existing endpoints.

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 of the endpoint services to query. You can call DescribeRegions to obtain the region ID.	cn-huhehaote
NextToken	string	No	Specifies whether to include a token for the next query. Valid values: Leave this parameter empty for the first query or if no more results exist. If more results exist, set this parameter to the NextToken value returned by the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 1000. Default value: 50.	50
ServiceId	string	No	The ID of the endpoint service to query.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	No	The name of the endpoint service to query.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
ServiceType	string	No	The endpoint service type. Set the value to Interface, which indicates an interface endpoint. You can add Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB) as EPS resource types.	Interface
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The tag key of the instance. 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 and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the instance. 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 `aliyun` or `acs:`. It 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>	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 when you create an endpoint.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Zones	array	The active zones of the endpoint service that can be associated when you create an endpoint.
	string	The active zone of the endpoint service that can be associated when you create an endpoint.	cn-huhehaote-a
ServiceId	string	The ID of the endpoint service that can be associated when you create an endpoint.	epsrv-hp3vpx8yqxblby3i****
ServiceName	string	The name of the endpoint service that can be associated when you create an endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceType	string	The endpoint service type. Set the value to Interface, which indicates an interface endpoint. You can add Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB) as EPS resource types.	Interface
ServiceSupportIPv6	boolean	Indicates whether the endpoint service supports IPv6. Valid values: true: IPv6 is supported. false: IPv6 is not supported.	false
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key of the instance.	FinanceDept
Value	string	The tag value of the instance.	FinanceJoshua
ResourceGroupId	string	The resource group ID.	rg-acfmy*****
ServiceResourceType	string	The EPS resource type. Valid values: slb: The EPS resource type is Classic Load Balancer (CLB). alb: The EPS resource type is Application Load Balancer (ALB). nlb: The EPS resource type is Network Load Balancer (NLB).	slb
AddressIpVersion	string	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack.	IPv4
ZoneAffinityEnabled	boolean	Indicates whether nearest access is enabled for the endpoint domain name that connects to the service. Valid values: true: Nearest access is enabled. false: Nearest access is disabled.	false
VpcEndpointPolicySupported	boolean	Indicates whether the endpoint service supports endpoint policy. Valid values: true: Endpoint policy is supported. false: Endpoint policy is not supported.
AutoAcceptEnabled	boolean	Indicates whether the endpoint service is configured to automatically accept endpoint connections. Valid values: true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections.	true
NextToken	string	Indicates whether a next query token exists. Valid values: If NextToken is empty, no more results exist. If NextToken is returned, the value indicates the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries per page.	50
TotalCount	string	The total number of entries returned.	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.