调用GetVpcEndpointServiceAttribute获取终端节点服务属性信息。

调试

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

请求参数

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

系统规定参数。取值:GetVpcEndpointServiceAttribute

RegionId String cn-hangzhou

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

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

ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点服务的ID。

返回数据

名称 类型 示例值 描述
Payer String Endpoint

付费方,取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
RequestId String 8D8992C1-6712-423C-BAC5-E5E817484C6B

请求ID。

ServiceDescription String This is my EndpointService.

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

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

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

MaxBandwidth Integer 1024

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

MinBandwidth Integer 100

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

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

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

AutoAcceptEnabled Boolean true

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

  • true:自动接受终端节点连接。
  • false:不自动接受终端节点连接。
ZoneAffinityEnabled Boolean true

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

  • true:是。
  • false:否。
ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点服务的ID。

Zones Array of String cn-huhehaote

服务资源所属的可用区。

ServiceBusinessStatus String Normal

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

  • Normal:正常。
  • FinacialLocked:欠费锁定。
ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

终端节点服务的名称。

ServiceStatus String Active

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

  • Creating:创建中。
  • Pending:修改中。
  • Active:可用。
  • Deleting:删除中。
  • Inactive:不可用。
ConnectBandwidth Integer 1024

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

RegionId String cn-huhehaote

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

示例

请求示例

https://[Endpoint]/?Action=GetVpcEndpointServiceAttribute
&RegionId=cn-huhehaote
&ServiceId=epsrv-hp3vpx8yqxblby3i****
&<公共请求参数>

正常返回示例

XML格式

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

<GetVpcEndpointServiceAttributeResponse>
    <Payer>Endpoint</Payer>
    <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
    <ServiceDescription>This is my EndpointService.</ServiceDescription>
    <CreateTime>2020-01-02T19:11:12Z</CreateTime>
    <MaxBandwidth>1024</MaxBandwidth>
    <MinBandwidth>100</MinBandwidth>
    <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>
    <AutoAcceptEnabled>true</AutoAcceptEnabled>
    <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
    <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
    <Zones>cn-huhehaote</Zones>
    <ServiceBusinessStatus>Normal</ServiceBusinessStatus>
    <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>
    <ServiceStatus>Active</ServiceStatus>
    <ConnectBandwidth>1024</ConnectBandwidth>
    <RegionId>cn-huhehaote</RegionId>
</GetVpcEndpointServiceAttributeResponse>

JSON格式

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

{
  "Payer" : "Endpoint",
  "RequestId" : "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceDescription" : "This is my EndpointService.",
  "CreateTime" : "2020-01-02T19:11:12Z",
  "MaxBandwidth" : 1024,
  "MinBandwidth" : 100,
  "ServiceDomain" : "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "AutoAcceptEnabled" : true,
  "ZoneAffinityEnabled" : true,
  "ServiceId" : "epsrv-hp3vpx8yqxblby3i****",
  "Zones" : [ "cn-huhehaote" ],
  "ServiceBusinessStatus" : "Normal",
  "ServiceName" : "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus" : "Active",
  "ConnectBandwidth" : 1024,
  "RegionId" : "cn-huhehaote"
}

错误码

HttpCode 错误码 错误信息 描述
400 EndpointServiceNotFound The specified Service does not exist. 当前终端节点服务不存在

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