Queries the 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListVpcEndpointServices

The operation that you want to perform. Set the value to ListVpcEndpointServices.

RegionId String Yes eu-west-1

The ID of the region where the endpoint service is created. You can call the DescribeRegions operation to query region IDs.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The query token. Set this parameter to the NextToken parameter value that is returned in the last API call. If no subsequent queries are to be sent, you can leave the parameter empty.

MaxResults Integer No 50

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

ServiceId String No epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

ServiceName String No com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

The name of the endpoint service.

AutoAcceptEnabled Boolean No false

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

  • true: automatically accepts endpoint connection requests.
  • false: manually accepts endpoint connection requests.
ServiceStatus String No Active

The status 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.
ServiceBusinessStatus String No Normal

The business status of the endpoint service. Valid values:

  • Normal: normal.
  • FinancialLocked: locked due to overdue payments.

Response parameters

Parameter Type Example Description
MaxResults String 100

The number of entries to return on each page.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token required by the next query. If the NextToken parameter is empty, it indicates that no subsequent query will be sent.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Services Array of Service

The list of endpoint services.

AutoAcceptEnabled Boolean true

Indicates whether to automatically accept endpoint connection requests:

  • true: automatically accepts endpoint connection requests.
  • false: manually accepts endpoint connection requests.
ConnectBandwidth String 1024

Default maximum bandwidth of the endpoint connection.

CreateTime String 2020-01-02T19:11:12Z

The time when the endpoint service was created.

MaxBandwidth String 1024

The maximum bandwidth of the endpoint connection.

MinBandwidth String 100

The minimum bandwidth of the endpoint connection.

RegionId String eu-west-1

The region where the endpoint service was created.

ServiceBusinessStatus String Normal

The business status of the endpoint service. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments.
ServiceDescription String This is my EndpointService.

Enter a description for the endpoint service.

ServiceDomain String epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com

The domain name of the endpoint service.

ServiceId String epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

The name of the endpoint service.

ServiceStatus String Active

The status 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.

Examples

Sample requests

https://[Endpoint]/?Action=ListVpcEndpointServices
&RegionId=eu-west-1
&<Common request parameters>

Sample success responses

XML format

<ListVpcEndpointServicesResponse>
  <Services>
        <ServiceBusinessStatus>Normal</ServiceBusinessStatus>
        <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>
        <ServiceStatus>Active</ServiceStatus>
        <ServiceDescription></ServiceDescription>
        <CreateTime>2020-09-09T02:26:51Z</CreateTime>
        <MaxBandwidth>1024</MaxBandwidth>
        <ConnectBandwidth>1024</ConnectBandwidth>
        <RegionId>cn-huhehaote</RegionId>
        <MinBandwidth>100</MinBandwidth>
        <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>
        <AutoAcceptEnabled>false</AutoAcceptEnabled>
        <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
  </Services>
  <RequestId>CBD4A69F-DD55-4021-A8AA-3A504095F8EC</RequestId>
  <MaxResults>50</MaxResults>
</ListVpcEndpointServicesResponse>

JSON format

{
  "Services": [
    {
      "ServiceBusinessStatus": "Normal",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
      "ServiceStatus": "Active",
      "ServiceDescription": "",
      "CreateTime": "2020-09-09T02:26:51Z",
      "MaxBandwidth": 1024,
      "ConnectBandwidth": 1024,
      "RegionId": "cn-huhehaote",
      "MinBandwidth": 100,
      "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
      "AutoAcceptEnabled": false,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****"
    }
  ],
  "RequestId": "CBD4A69F-DD55-4021-A8AA-3A504095F8EC",
  "MaxResults": 50
}

Error codes

For a list of error codes, visit the API Error Center.