Call the ListVpcEndpointServices API to query endpoint services - PrivateLink - Alibaba Cloud - PrivateLink

Queries the list of endpoint services that belong to the current account.

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:ListVpcEndpointServices

get

*VpcEndpointService

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

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	Specifies whether to have a token for the next query. Valid values: Leave this parameter empty for the first query or if no next query exists. If a next query exists, 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.	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 EPS resource type. Valid values: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer (NLB). gwlb: Gateway Load Balancer (GWLB).	slb
AutoAcceptEnabled	boolean	No	Specifies whether to automatically accept endpoint connections. Valid values: true: Endpoint connections are automatically accepted. false: Endpoint connections are not automatically accepted.	false
ServiceStatus	string	No	The endpoint service status. Valid values: Creating: being created. Pending: being modified. Active: active. Deleting: being deleted.	Active
ServiceBusinessStatus	string	No	The business status of the endpoint service. Valid values: Normal: normal. FinancialLocked: locked due to overdue payment.	Normal
ZoneAffinityEnabled	boolean	No	Specifies whether zone affinity is enabled for the endpoint that connects to the endpoint service. Valid values: true: Zone affinity is enabled. false: Zone affinity is disabled.	true
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*****
AddressIpVersion	string	No	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack.	IPv4

Response elements

Element	Type	Description	Example
	object
Services	array<object>	The endpoint services.
	array<object>	The endpoint services.
AutoAcceptEnabled	boolean	Specifies whether to automatically accept endpoint connections. Valid values: true: Endpoint connections are automatically accepted. false: Endpoint connections 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 is in the YYYY-MM-DDTHH:mm:ssZ format and 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 endpoint service status. Valid values: Creating: being created. Pending: being modified. Active: active. Deleting: being deleted.	Active
ZoneAffinityEnabled	boolean	Indicates whether zone affinity is enabled. Valid values: true: Zone affinity is enabled. false: Zone affinity is disabled.	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: the service consumer. EndpointService: the service provider.	Endpoint
ServiceBusinessStatus	string	The business status of the endpoint service. Valid values: Normal: normal. FinancialLocked: locked due to overdue payment.	Normal
ConnectBandwidth	integer	The default bandwidth limit. 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 EPS resource type. Valid values: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer (NLB). gwlb: Gateway Load Balancer (GWLB).	slb
ServiceType	string	The endpoint service type. Valid values: Interface: interface endpoint. You can add Classic Load Balancer (CLB), Application Load Balancer (ALB), and Network Load Balancer (NLB) instances as service resources. GatewayLoadBalancer: Gateway Load Balancer endpoint (GWLBe). You can add Gateway Load Balancer (GWLB) instances as service resources.	Interface
ServiceSupportIPv6 `deprecated`	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*****
AddressIpVersion	string	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack.	IPv4
SupportedRegionSet	array<object>	The regions supported by the endpoint service. Service consumers can create endpoint connections from these regions.
	object
ServiceRegionId `deprecated`	string	[Deprecated] The region ID supported by the endpoint service. Use SupportedRegionId instead.
RegionServiceStatus	string	The status of the region supported by the endpoint service. Valid values: Pending: being modified. Available: available. Deleting: being deleted. Failed: failed. Closed: closed.	Available
RegionBusinessStatus	string	The business status of the region supported by the endpoint service. Valid values: Normal: normal. FinancialLocked: locked due to overdue payment.	Normal
SupportedRegionId	string	The region ID supported by the endpoint service.	cn-hangzhou
NextToken	string	Indicates whether a next query exists. Valid values: If NextToken is empty, no next query exists. 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	integer	The total number of entries returned.	12

Examples

Success response

JSON format

{
  "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*****",
      "AddressIpVersion": "IPv4",
      "SupportedRegionSet": [
        {
          "ServiceRegionId": "",
          "RegionServiceStatus": "Available",
          "RegionBusinessStatus": "Normal",
          "SupportedRegionId": "cn-hangzhou"
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.