文档

GetVpcEndpointAttribute - 获取终端节点属性信息

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

获取属性信息的终端节点所属的地域 ID。

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

cn-huhehaote
EndpointIdstring

获取属性信息的终端节点 ID。

ep-hp33b2e43fays7s8****

返回参数

名称类型描述示例值
object
Payerstring

付费方。取值:

  • Endpoint:服务使用方。

  • EndpointService:服务提供方。

Endpoint
EndpointDomainstring

终端节点域名。

ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com
RequestIdstring

请求 ID。

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

终端节点的创建时间。

2021-09-24T18:00:07Z
ResourceOwnerboolean

终端节点和终端节点服务是否同一账号。取值:

  • true:是。

  • false:否。

true
EndpointBusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
EndpointDescriptionstring

终端节点描述。

This is my Endpoint.
ServiceIdstring

终端节点关联的终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
EndpointStatusstring

终端节点状态。取值:

  • Creating:创建中。

  • Active:可用。

  • Pending:修改中。

  • Deleting:删除中。

Active
VpcIdstring

终端节点所属的专有网络 ID。

vpc-fdfhkjafhjvcvdjf****
EndpointNamestring

终端节点名称。

test
ZonePrivateIpAddressCountlong

每个可用区 ENI 的私网 IP 的数量。仅取值:1

1
EndpointTypestring

终端节点类型。

取值:Interface,表示接口终端节点,其中终端节点服务的服务资源类型为应用型负载均衡 ALB(Application Load Balancer)、传统型负载均衡 CLB(Classic Load Balancer)或网络型负载均衡 NLB(Network Load Balancer )。

Interface
ServiceNamestring

终端节点关联的终端节点服务的名称。

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidthinteger

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

1024
EndpointIdstring

终端节点 ID。

ep-hp33b2e43fays7s8****
RegionIdstring

终端节点所属的地域 ID。

cn-huhehaote
ConnectionStatusstring

终端节点连接状态。取值:

  • Pending:修改中。

  • Connecting:连接中。

  • Connected:已连接。

  • Disconnecting:断开连接中。

  • Disconnected:未连接。

  • Deleting:删除中。

  • ServiceDeleted:对应的终端节点服务已删除。

Connected
ZoneAffinityEnabledboolean

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

  • true:是。

  • false:否。

true
ResourceGroupIdstring

资源组 ID。

rg-acfmz7nocpei***

示例

正常返回示例

JSON格式

{
  "Payer": "Endpoint",
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "CreateTime": "2021-09-24T18:00:07Z",
  "ResourceOwner": true,
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-fdfhkjafhjvcvdjf****",
  "EndpointName": "test",
  "ZonePrivateIpAddressCount": 1,
  "EndpointType": "Interface",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 1024,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "RegionId": "cn-huhehaote",
  "ConnectionStatus": "Connected",
  "ZoneAffinityEnabled": true,
  "ResourceGroupId": "rg-acfmz7nocpei***",
  "PolicyDocument": ""
}

错误码

HTTP status code错误码错误信息描述
400EndpointNotFoundThe specified Endpoint does not exist.当前终端节点未找到。
400EndpointConnectionNotFoundThe specified endpoint connection does not exist.当前终端节点连接未找到。

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

变更历史

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