GetVpcEndpointServiceAttribute - 获取终端节点服务属性信息 - 私网连接 PrivateLink

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

privatelink:GetVpcEndpointServiceAttribute

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	终端节点服务所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
ServiceId	string	是	终端节点服务的 ID。	epsrv-hp3vpx8yqxblby3i****
RegionId	string	是	终端节点服务所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote

返回参数

名称	类型	描述	示例值
	object
Payer	string	付费方，取值： Endpoint：服务使用方。 EndpointService：服务提供方。	Endpoint
RequestId	string	请求 ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescription	string	终端节点服务的描述信息。	This is my EndpointService.
CreateTime	string	终端节点服务的创建时间。	2020-01-02T19:11:12Z
MaxBandwidth	integer	终端节点连接的最大带宽。单位：Mbps。	1024
MinBandwidth	integer	终端节点连接的最小带宽。单位：Mbps。	100
ServiceDomain	string	终端节点服务的服务域名。	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
AutoAcceptEnabled	boolean	是否自动接受终端节点连接，取值： true：自动接受终端节点连接。 false：不自动接受终端节点连接。	true
ZoneAffinityEnabled	boolean	是否支持连接服务的终端节点域名就近解析。取值： true（默认值）：是。 false：否。	true
ServiceId	string	终端节点服务的 ID。	epsrv-hp3vpx8yqxblby3i****
Zones	array	服务资源所属的可用区列表。
	string	服务资源所属的可用区。	cn-huhehaote-b
ServiceBusinessStatus	string	终端节点服务的业务状态，取值： Normal：正常。 FinancialLocked：欠费锁定。	Normal
ServiceName	string	终端节点服务的名称。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	终端节点服务的状态，取值： Creating：创建中。 Pending：修改中。 Active：可用。 Deleting：删除中。	Active
ConnectBandwidth	integer	默认连接带宽峰值。单位：Mbps。取值范围：100~10240。	3072
RegionId	string	终端节点服务所属的地域。	cn-huhehaote
ServiceType	string	终端节点类型。 Interface：表示接口终端节点，您可以添加传统型负载均衡 CLB（Classic Load Balancer）、应用型负载均衡 ALB（Application Load Balancer）和网络型负载均衡 NLB（Network Load Balancer ）的服务资源类型。 GatewayLoadBalancer：表示网关型负载均衡终端节点，您可以添加网关型负载均衡 GWLB（Gateway Load Balancer）作为服务资源。	Interface
ServiceResourceType	string	服务资源类型，取值： slb：表示服务资源类型为传统型负载均衡 CLB（Classic Load Balancer）。 alb：表示服务资源类型为应用型负载均衡 ALB（Application Load Balancer）。 nlb ：表示服务资源类型为网络型负载均衡 NLB（Network Load Balancer ）。 gwlb : 表示服务资源类型为网关型负载均衡 GWLB（Gateway Load Balancer）。	slb
ServiceSupportIPv6 `deprecated`	boolean	终端节点服务是否支持 IPv6 功能。取值： true：是。 false（默认值）：否。	false
ResourceGroupId	string	资源组 ID。	rg-acfmy*****
AddressIpVersion	string	协议版本。取值： IPv4：IPv4 类型。 DualStack：双栈类型。	IPv4
SupportedRegionSet	array<object>
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string
RegionBusinessStatus	string
SupportedRegionId	string

示例

正常返回示例

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*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "",
      "RegionBusinessStatus": "",
      "SupportedRegionId": ""
    }
  ]
}

错误码

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

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

变更历史

更多信息，参考变更详情。