调用ListVpcEndpointServices接口查询终端节点服务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListVpcEndpointServices

系统规定参数。取值:ListVpcEndpointServices

RegionId String cn-huhehaote

终端节点服务所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
MaxResults Integer 50

分批次查询时每次显示的条目数。取值范围:1~50,默认值:50

ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点服务的ID。

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

终端节点服务的名称。

ServiceResourceType String slb

服务资源类型。

仅取值:slb,表示服务资源类型为传统型负载均衡CLB(原SLB)。

AutoAcceptEnabled Boolean false

是否自动接受终端节点连接,取值:

  • true:自动接受终端节点连接。
  • false(默认值):不自动接受终端节点连接。
ServiceStatus String Active

终端节点服务的状态,取值:

  • Creating:创建中。
  • Pending:修改中。
  • Active:可用。
  • Deleting:删除中。
ServiceBusinessStatus String Normal

终端节点服务的业务状态,取值:

  • Normal:正常。
  • FinacialLocked:欠费锁定。
ZoneAffinityEnabled Boolean true

是否支持可用区就近解析,取值:

  • true:是。
  • false(默认值):否。

返回数据

名称 类型 示例值 描述
Services Array of Service

终端节点服务集合。

AutoAcceptEnabled Boolean true

是否自动接受终端节点连接,取值:

  • true:自动接受终端节点连接。
  • false:不自动接受终端节点连接。
ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点服务的ID。

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

终端节点服务的创建时间。

MinBandwidth Integer 100

终端节点连接的最小带宽。单位:Mbps。

MaxBandwidth Integer 1024

终端节点连接的最大带宽。单位:Mbps。

ServiceStatus String Active

终端节点服务的状态,取值:

  • Creating:创建中。
  • Pending:修改中。
  • Active:可用。
  • Deleting:删除中。
ZoneAffinityEnabled Boolean true

是否支持可用区就近解析,取值:

  • true:是。
  • false:否。
RegionId String cn-huhehaote

终端节点服务所属的地域。

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

终端节点服务的服务域名。

Payer String Endpoint

付费方,取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
ServiceBusinessStatus String Normal

终端节点服务的业务状态,取值:

  • Normal:正常。
  • FinacialLocked:欠费锁定。
ConnectBandwidth Integer 1024

默认连接带宽峰值。单位:Mbps。

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

终端节点服务的名称。

ServiceDescription String This is my EndpointService.

终端节点服务的描述信息。

ServiceResourceType String slb

服务资源类型。

仅取值:slb,表示服务资源类型为传统型负载均衡CLB(原SLB)。

ServiceType String Interface

终端节点服务类型。

仅取值:Interface,表示ServiceResourceTypeslb(传统型负载均衡CLB)时的终端节点服务类型。

ServiceSupportIPv6 Boolean false

终端节点服务是否支持IPv6功能。取值:

  • true:是。
  • false:否。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

MaxResults Integer 50

分批次查询时每次显示的条目数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListVpcEndpointServices
&RegionId=cn-huhehaote
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=50
&ServiceId=epsrv-hp3vpx8yqxblby3i****
&ServiceName=com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
&ServiceResourceType=slb
&AutoAcceptEnabled=false
&ServiceStatus=Active
&ServiceBusinessStatus=Normal
&ZoneAffinityEnabled=true
&公共请求参数

正常返回示例

XML格式

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>
        <ServiceSupportIPv6>false</ServiceSupportIPv6>
    </Services>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <MaxResults>50</MaxResults>
</ListVpcEndpointServicesResponse>

JSON格式

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

错误码

访问错误中心查看更多错误码。