全部产品
Search
文档中心

云解析 DNS:DescribeGtmInstanceAddressPools - 获取GTM实例地址池列表(旧版)

更新时间:May 28, 2024

获取GTM实例地址池列表。

调试

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

授权信息

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

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

请求参数

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

语言。

en
InstanceIdstring

GTM 实例 ID。

gtmtest
PageNumberinteger

当前页码,起始值为 1,默认为 1

1
PageSizeinteger

分页查询时设置的每页行数,最大值 100,默认为 20

20

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时设置的每页行数,最大值 100,默认为 20

20
RequestIdstring

唯一请求识别码。

6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumberinteger

当前页数,起始值为 1,默认为 1。

1
TotalPagesinteger

总页数。

1
TotalItemsinteger

总个数。

2
AddrPoolsobject []

地址池列表。

Typestring

地址池类型:

  • IP:IP 地址
  • DOMAIN:域名
IP
Statusstring

地址池可用状态:

  • AVAILABLE:可用
  • NOT_AVAILABLE:不可用
AVAILABLE
UpdateTimestring

更新时间。

2017-12-28T13:08Z
CreateTimestring

创建时间。

2017-12-28T13:08Z
MonitorConfigIdstring

监控配置 ID。

100abc
MinAvailableAddrNuminteger

最小可用地址数量。

2
UpdateTimestamplong

更新时间(时间戳)。

1527690629357
MonitorStatusstring

监控状态。其中:

  • OPEN:开启
  • CLOSE:关闭
  • UNCONFIGURED:未配置
OPEN
AddrPoolIdstring

地址池 ID。

hrbpnf
Namestring

地址池名称。

test
AddrCountinteger

地址数量。

2
CreateTimestamplong

创建时间(时间戳)。

1527690629357

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 2,
  "AddrPools": {
    "AddrPool": [
      {
        "Type": "IP",
        "Status": "AVAILABLE",
        "UpdateTime": "2017-12-28T13:08Z",
        "CreateTime": "2017-12-28T13:08Z",
        "MonitorConfigId": "100abc",
        "MinAvailableAddrNum": 2,
        "UpdateTimestamp": 1527690629357,
        "MonitorStatus": "OPEN",
        "AddrPoolId": "hrbpnf",
        "Name": "test",
        "AddrCount": 2,
        "CreateTimestamp": 1527690629357
      }
    ]
  }
}

错误码

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