文档

GetVpcEndpointServiceAttribute - 获取终端节点服务属性信息

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
privatelink:GetVpcEndpointServiceAttributeRead
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-huhehaote
ServiceIdstring

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****

返回参数

名称类型描述示例值
object
Payerstring

付费方,取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
Endpoint
RequestIdstring

请求 ID。

8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescriptionstring

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

This is my EndpointService.
CreateTimestring

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

2020-01-02T19:11:12Z
MaxBandwidthinteger

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

1024
MinBandwidthinteger

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

100
ServiceDomainstring

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

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

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

  • true:自动接受终端节点连接。

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

true
ZoneAffinityEnabledboolean

是否支持连接服务的终端节点域名就近解析。取值:

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

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
Zonesarray

服务资源所属的可用区列表。

string

服务资源所属的可用区。

cn-huhehaote-b
ServiceBusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
ServiceNamestring

终端节点服务的名称。

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

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

  • Creating:创建中。

  • Pending:修改中。

  • Active:可用。

  • Deleting:删除中。

Active
ConnectBandwidthinteger

默认连接带宽峰值。单位:Mbps。取值范围:100~10240

3072
RegionIdstring

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

cn-huhehaote
ServiceTypestring

终端节点类型。

仅取值: Interface,表示接口终端节点,您可以添加传统型负载均衡 CLB(Classic Load Balancer)、应用型负载均衡 ALB(Application Load Balancer)和网络型负载均衡 NLB(Network Load Balancer )的服务资源类型。

Interface
ServiceResourceTypestring

服务资源类型,取值:

  • slb:表示服务资源类型为传统型负载均衡 CLB(Classic Load Balancer)。
  • alb:表示服务资源类型为应用型负载均衡 ALB(Application Load Balancer)。
  • nlb :表示服务资源类型为网络型负载均衡 NLB(Network Load Balancer )。
slb
ServiceSupportIPv6boolean

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

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

资源组 ID。

rg-acfmy*****

示例

正常返回示例

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-b"
  ],
  "ServiceBusinessStatus": "Normal",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ConnectBandwidth": 3072,
  "RegionId": "cn-huhehaote",
  "ServiceType": "Interface",
  "ServiceResourceType": "slb",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****"
}

错误码

HTTP status code错误码错误信息描述
400EndpointServiceNotFoundThe specified Service does not exist.当前终端节点服务不存在

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

变更历史

变更时间变更内容概要操作
2023-09-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-09-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-09-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)