All Products
Search
Document Center

PrivateLink:ListVpcEndpointServices

Last Updated:Feb 27, 2024

Queries a list of endpoint services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
privatelink:ListVpcEndpointServicesRead
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the endpoint service.

You can call the DescribeRegions operation to query the most recent region list.

cn-huhehaote
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • If this is your first request and no next requests are to be performed, you do not need to specify this parameter.
  • If a next request is to be performed, set the parameter to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.

50
ServiceIdstringNo

The endpoint service ID.

epsrv-hp3vpx8yqxblby3i****
ServiceNamestringNo

The name of the endpoint service.

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ResourceIdstringNo

The service resource ID.

lb-hp32z1wp5peaoox2q****
ServiceResourceTypestringNo

The type of the service resource. Valid values:

  • slb: a Classic Load Balancer (CLB) instance
  • alb: an Application Load Balancer (ALB) instance
slb
AutoAcceptEnabledbooleanNo

Specifies whether to automatically accept endpoint connection requests. Valid values:

  • true
  • false (default)
false
ServiceStatusstringNo

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
ServiceBusinessStatusstringNo

The service state of the endpoint service. Valid values:

  • Normal: The endpoint service runs as expected.
  • FinancialLocked: The endpoint service is locked due to overdue payments.
Normal
ZoneAffinityEnabledbooleanNo

Specifies whether to first resolve the domain name of the nearest endpoint that is associated with the endpoint service. Valid values:

  • true (default)
  • false
true
Tagobject []No

The list of tags.

KeystringNo

The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string.

The tag key must be 1 to 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.

FinanceDept
ValuestringNo

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 and cannot start with acs: or aliyun. It cannot contain http:// or https://.

FinanceJoshua
ResourceGroupIdstringNo

The resource group ID.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object
Servicesobject []

The endpoint services.

AutoAcceptEnabledboolean

Indicates whether endpoint connection requests are automatically accepted. Valid values:

  • true: Endpoint connection requests are automatically accepted.
  • false: Endpoint connection requests are not automatically accepted.
true
ServiceIdstring

The ID of the endpoint service.

epsrv-hp3vpx8yqxblby3i****
CreateTimestring

The time when the endpoint service was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-09-24T17:15:10Z
MinBandwidthinteger

The minimum bandwidth of the endpoint connection. Unit: Mbit/s.

100
MaxBandwidthinteger

The maximum bandwidth of the endpoint connection. Unit: Mbit/s.

1024
ServiceStatusstring

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
ZoneAffinityEnabledboolean

Indicates whether zone affinity is enabled. Valid values:

  • true
  • false
true
RegionIdstring

The region ID of the endpoint service.

cn-huhehaote
ServiceDomainstring

The domain name of the endpoint service.

epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Payerstring

The payer. Valid values:

  • Endpoint: service consumer
  • EndpointService: service provider
Endpoint
ServiceBusinessStatusstring

The service state of the endpoint service. Valid values:

  • Normal: The endpoint service runs as expected.
  • FinancialLocked: The endpoint service is locked due to overdue payments.
Normal
ConnectBandwidthinteger

The default maximum bandwidth of the endpoint connection. Unit: Mbit/s.

1024
ServiceNamestring

The name of the endpoint service.

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceDescriptionstring

The description of the endpoint service.

This is my EndpointService.
ServiceResourceTypestring

The type of the service resource. Valid values:

  • slb: Classic Load Balancer (CLB) instance
  • alb: Application Load Balancer (ALB) instance
  • nlb: Network Load Balancer (NLB) instance
slb
ServiceTypestring

The type of the endpoint service.

  • Only Interface may be returned. You can specify CLB, ALB, and NLB instances as the service resources of the endpoint service.
Interface
ServiceSupportIPv6boolean

Indicates whether the endpoint service supports IPv6. Valid values:

  • true
  • false
false
Tagsobject []

The tags added to the resource.

Keystring

The key of the tag added to the resource.

FinanceDept
Valuestring

The value of the tag added to the resource.

FinanceJoshua
ResourceGroupIdstring

The ID of the resource group.

rg-acfmy*****
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:

  • If no value is returned for NextToken, no next requests are performed.
  • If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResultsinteger

The number of entries returned per page.

50
TotalCountinteger

The total number of entries returned.

12

Examples

Sample success responses

JSONformat

{
  "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*****"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-26The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-09-05The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-03-02API Description Update. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Output ParametersThe response structure of the API has changed.
2022-12-06The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceId
2022-09-20The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
Output ParametersThe response structure of the API has changed.
2022-07-26The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag
Output ParametersThe response structure of the API has changed.
2021-03-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.