Queries 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 cn-huhehaote

The region ID of the endpoint service.

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

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
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.

ServiceResourceType String No slb

The type of the service resource.

Set the value to slb, which specifies Classic Load Balancer (CLB).

AutoAcceptEnabled Boolean No false

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

  • true: yes
  • false (default): no
ServiceStatus String No Active

The status of the endpoint service. Valid values:

  • Creating: being created
  • Pending: being modified
  • Active: available
  • Deleting: being deleted
ServiceBusinessStatus String No Normal

The business status of the endpoint service. Valid values:

  • Normal: normal
  • FinacialLocked: locked due to overdue payments
ZoneAffinityEnabled Boolean No true

Specifies whether to enable zone affinity. Valid values:

  • true: yes
  • false (default): no

Response parameters

Parameter Type Example Description
Services Array of Service

The list of endpoint services.

AutoAcceptEnabled Boolean true

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

  • true: yes
  • false: no
ServiceId String epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

CreateTime String 2021-09-24T17:15:10Z

The time when the endpoint service was created.

MinBandwidth Integer 100

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

MaxBandwidth Integer 1024

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

ServiceStatus String Active

The status of the endpoint service. Valid values:

  • Creating: being created
  • Pending: being modified
  • Active: available
  • Deleting: being deleted
ZoneAffinityEnabled Boolean true

Indicates whether zone affinity is enabled. Valid values:

  • true: yes
  • false: no
RegionId String cn-huhehaote

The ID of the region where the endpoint service is created.

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

The domain name of the endpoint service.

Payer String Endpoint

The payer of the endpoint service. Valid values:

  • Endpoint: the service consumer
  • EndpointService: the service provider
ServiceBusinessStatus String Normal

The business status of the endpoint service. Valid values:

  • Normal: normal
  • FinacialLocked: locked due to overdue payments
ConnectBandwidth Integer 1024

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

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

The name of the endpoint service.

ServiceDescription String This is my EndpointService.

The description of the endpoint service.

ServiceResourceType String slb

The type of the service resource.

The value is set to slb, which indicates CLB.

ServiceType String Interface

The type of the endpoint service.

The value is set to Interface. This value is used when ServiceResourceType is set to slb.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. Valid values:

  • If the value returned of NextToken is empty, it indicates that no next query is to be sent.
  • If the value returned of NextToken is not empty, the value indicates the token that is used for the next query.
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

MaxResults String 50

The number of entries returned per page.

Examples

Sample requests

https://[Endpoint]/?Action=ListVpcEndpointServices
&RegionId=cn-huhehaote
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListVpcEndpointServicesResponse>
    <Services>
        <AutoAcceptEnabled>true</AutoAcceptEnabled>
        <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
        <CreateTime>2021-09-24T17:15:10Z</CreateTime>
        <MinBandwidth>100</MinBandwidth>
        <MaxBandwidth>1024</MaxBandwidth>
        <ServiceStatus>Active</ServiceStatus>
        <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
        <RegionId>cn-huhehaote</RegionId>
        <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>
        <Payer>Endpoint</Payer>
        <ServiceBusinessStatus>Normal</ServiceBusinessStatus>
        <ConnectBandwidth>1024</ConnectBandwidth>
        <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>
        <ServiceDescription>This is my EndpointService.</ServiceDescription>
        <ServiceResourceType>slb</ServiceResourceType>
        <ServiceType>Interface</ServiceType>
    </Services>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <MaxResults>50</MaxResults>
</ListVpcEndpointServicesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

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