ListVpcEndpointServices - PrivateLink - Alibaba Cloud Documentation Center

Retrieves a list of endpoint services.

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 ID of the region where the endpoint service is deployed. Call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
NextToken	string	No	A pagination token. It is used in the next query to retrieve a new page of results. Valid values: If this is your first query, leave this parameter empty. If a subsequent query is required, set this parameter to the NextToken value returned from the previous query.	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-hp3vpx8yqxblby3i****
ResourceId	string	No	The ID of the service resource.	lb-hp32z1wp5peaoox2q****
ServiceResourceType	string	No	The type of the service resource. Valid values: 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. gwlb: The service resource is a Gateway Load Balancer (GWLB) instance.	slb
AutoAcceptEnabled	boolean	No	Specifies whether to automatically accept endpoint connections. Valid values: true: automatically accept endpoint connections. false: do not automatically accept endpoint connections.	false
ServiceStatus	string	No	The state of the endpoint service. Valid values: Creating: The endpoint service is being created. Pending: The endpoint service is being modified. Active: The endpoint service is available. Deleting: The endpoint service is being deleted.	Active
ServiceBusinessStatus	string	No	The business status of the endpoint service. Valid values: Normal: The endpoint service is running as expected. FinancialLocked: The endpoint service is locked due to an overdue payment.	Normal
ZoneAffinityEnabled	boolean	No	Specifies whether to enable zonal affinity for domain name resolution. Valid values: true false	true
RegionId	string	Yes	The ID of the region where the endpoint service is deployed. Call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
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 key cannot be an empty string. The 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 value can be an empty string. The 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 ID of the resource group.	rg-acfmy*****
AddressIpVersion	string	No	The IP address version. Valid values: IPv4 DualStack	IPv4

Response elements

Element	Type	Description	Example
	object
Services	array<object>	The collection of endpoint services.
	array<object>	The collection of endpoint services.
AutoAcceptEnabled	boolean	Indicates whether endpoint connections are automatically accepted. 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.	2021-09-24T17:15:10Z
MinBandwidth	integer	The minimum bandwidth of the endpoint connection. Unit: Mbps.	100
MaxBandwidth	integer	The maximum bandwidth of the endpoint connection. Unit: Mbps.	1024
ServiceStatus	string	The state of the endpoint service. Valid values: Creating: The endpoint service is being created. Pending: The endpoint service is being modified. Active: The endpoint service is available. Deleting: The endpoint service is being deleted.	Active
ZoneAffinityEnabled	boolean	Indicates whether zonal affinity is enabled. Valid values: true false	true
RegionId	string	The region where the endpoint service is deployed.	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: The endpoint service is running as expected. FinancialLocked: The endpoint service is locked due to an overdue payment.	Normal
ConnectBandwidth	integer	The default maximum bandwidth. Unit: Mbps.	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 type of the service resource. Valid values: slb: The service resource is a CLB instance. alb: The service resource is an ALB instance. nlb: The service resource is an NLB instance. gwlb: The service resource is a GWLB instance.	slb
ServiceType	string	The type of the endpoint service. Valid values: Interface: an interface endpoint. You can add CLB, ALB, and NLB instances as service resources. GatewayLoadBalancer: a Gateway Load Balancer endpoint. You can add GWLB instances as service resources.	Interface
ServiceSupportIPv6 `deprecated`	boolean	Indicates whether the endpoint service supports IPv6. Valid values: true false	false
Tags	array<object>	The list of tags.
	object	The list of tags.
Key	string	The tag key of the instance.	FinanceDept
Value	string	The tag value of the instance.	FinanceJoshua
ResourceGroupId	string	The ID of the resource group.	rg-acfmy*****
AddressIpVersion	string	The IP address version. Valid values: IPv4 DualStack	IPv4
SupportedRegionSet	array<object>
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string
RegionBusinessStatus	string
SupportedRegionId	string
NextToken	string	A pagination token. It is used in the next query to retrieve a new page of results. If this parameter is empty, all results have been returned. If a value is returned, use this value in the `NextToken` request parameter 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 on each page.	50
TotalCount	integer	The total number of records.	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": "",
          "RegionBusinessStatus": "",
          "SupportedRegionId": ""
        }
      ]
    }
  ],
  "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.