全部产品
Search
文档中心

全球加速:GetBasicAccelerateIpEndpointRelation - 查询基础型全球加速实例的加速IP或终端节点的绑定信息

更新时间:Jul 31, 2024

调用GetBasicAccelerateIpEndpointRelation接口查询基础型全球加速实例的加速IP或终端节点的绑定信息。

调试

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

授权信息

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

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

请求参数

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

全球加速所在的地域 ID,仅取值cn-hangzhou

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****
EndpointIdstring

基础型全球加速实例的终端节点 ID。

说明 EndpointIdAccelerateIpId 不能同时为空。
ep-bp14sz7ftcwwjgrdm****
AccelerateIpIdstring

基础型全球加速实例的加速 IP 实例 ID。

说明 EndpointIdAccelerateIpId 不能同时为空。
gaip-bp1****

返回参数

名称类型描述示例值
object

返回参数列表。

EndpointIdstring

基础型全球加速实例的终端节点 ID。

ep-bp14sz7ftcwwjgrdm****
EndpointNamestring

基础型全球加速实例终端节点的名称。

ep01
EndpointTypestring

终端节点类型。

  • ENI:阿里云弹性网卡。
  • SLB:阿里云 CLB 实例。
  • ECS:阿里云 ECS 实例。
  • NLB:阿里云 NLB 实例。
ENI
EndpointAddressstring

终端节点的地址。

eni-bp1a05txelswuj8g****
EndpointSubAddressstring

终端节点辅助地址。

当加速 IP 所绑定终端节点类型为 ECSENINLB 时,返回该参数。

  • 当终端节点类型为 ECS 时,EndpointSubAddress 为主网卡的辅助私网 IP 或主网卡的主私网 IP。
  • 当终端节点类型为 ENI 时,EndpointSubAddress 为辅助网卡的辅助私网 IP 或辅助网卡的主私网 IP。
  • 当终端节点类型为 NLB 时,EndpointSubAddress 为 NLB 后端服务器的主私网 IP。
172.16.XX.XX
EndpointSubAddressTypestring

终端节点辅助地址的类型。

  • primary:终端节点辅助地址的类型为主私网 IP。
  • secondary:终端节点辅助地址的类型为辅助私网 IP。

当加速 IP 所绑定终端节点类型为 ECSENINLB 时,返回该参数。其中,终端节点类型为 NLB 时,仅返回 primary 类型。

primary
EndpointZoneIdstring

终端节点所在可用区 ID。

目前,仅当加速 IP 所绑定终端节点类型为 NLB 时,返回该参数。

cn-hangzhou-g
AccelerateIpIdstring

基础型全球加速实例的加速 IP 实例 ID。

gaip-bp1****
IpAddressstring

基础型全球加速实例的加速 IP。

116.132.XX.XX
Statestring

基础型全球加速实例的加速 IP 和终端节点绑定状态。

返回 active,表示已绑定。

active
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp11v53zfftax68b0daws

示例

正常返回示例

JSON格式

{
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "EndpointName": "ep01",
  "EndpointType": "ENI",
  "EndpointAddress": "eni-bp1a05txelswuj8g****",
  "EndpointSubAddress": "172.16.XX.XX",
  "EndpointSubAddressType": "primary",
  "EndpointZoneId": "cn-hangzhou-g",
  "AccelerateIpId": "gaip-bp1****",
  "IpAddress": "116.132.XX.XX",
  "State": "active",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": " ga-bp11v53zfftax68b0daws"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史