文档

ListBasicEndpoints - 查询基础型全球加速实例的终端节点列表

更新时间:

调用ListBasicEndpoints接口查询基础型全球加速实例的终端节点列表。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
ClientTokenstring

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

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

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

待查询的基础型全球加速实例终端节点所属的终端节点组 ID。

epg-bp1dmlohjjz4kqaun****
EndpointTypestring

待查询的基础型全球加速实例终端节点类型。取值:

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

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

ep-bp14sz7ftcwwjgrdm****
Namestring

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

名称长度为 1~128 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)下划线(_)和短划线(-)。

ep01
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~50。默认值:10

10

返回参数

名称类型描述示例值
object

返回参数列表。

RequestIdstring

请求 ID。

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

列表条目数。

1
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsstring

分批次查询时每次显示的条目数。

10
Endpointsobject []

基础型全球加速实例终端节点列表。

AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****
EndpointGroupIdstring

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

epg-bp1dmlohjjz4kqaun****
EndpointIdstring

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

ep-bp14sz7ftcwwjgrdm****
Namestring

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

ep01
EndpointTypestring

终端节点类型。

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

终端节点的地址。

eni-bp1a05txelswuj8g****
EndpointSubAddressstring

终端节点辅助地址。

当终端节点类型为 ECSENINLB 时,返回该参数。

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

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

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

当终端节点类型为 ECSENINLB 时,返回该参数。其中,终端节点类型为 NLB 时,仅返回 primary 类型。

primary
EndpointZoneIdstring

终端节点的可用区 ID。

目前,仅当终端节点类型为 NLB 时,返回该参数。

cn-hangzhou-g
Statestring

终端节点状态。

  • init:初始化。
  • active:可用。
  • updating:配置中。
  • binding:绑定中。
  • unbinding:解绑中。
  • deleting:删除中。
  • bound:已绑定。
active

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": "1",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": "10",
  "Endpoints": [
    {
      "AcceleratorId": "ga-bp17frjjh0udz4qz****",
      "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "Name": "ep01",
      "EndpointType": "ENI",
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointSubAddress": "172.16.XX.XX",
      "EndpointSubAddressType": "primary",
      "EndpointZoneId": "cn-hangzhou-g",
      "State": "active"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈