DescribeDnsGtmInstances - 获取GTM实例列表

获取实例列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alidns:DescribeDnsGtmInstances

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Lang

string

部分返回参数语言。默认值:en。取值范围:en,zh,ja。

en

PageNumber

integer

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

1

PageSize

integer

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

1

Keyword

string

查询关键字,支持实例 ID、实例名称模糊搜索。

test

ResourceGroupId

string

资源组 ID。

rg-testgroupid

返回参数

名称

类型

描述

示例值

object

PageSize

integer

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

1

RequestId

string

唯一请求识别码。

84314904-D047-4176-A0EC-256D7F68C7F5

PageNumber

integer

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

1

GtmInstances

array<object>

GTM 实例列表。

object

PaymentType

string

付费类型:

  • Subscription:预付费

Subscription

ExpireTime

string

实例到期时间。

2020-10-14T06:58Z

CreateTime

string

实例创建时间。

2020-10-14T06:58Z

SmsQuota

integer

短信通知总数。

1

InstanceId

string

实例 id。

gtm-cn-wwo3a3hbz**

Config

object

实例配置信息。

Ttl

integer

全局 TTL。

60

AlertGroup

string

报警组(List的 JSON 格式)。

["test1","test2"]

PublicZoneName

string

公网接入域名。

gtm-cn-wwo3a3hbz**.dns-example.top

CnameType

string

cname 接入域名类型:

  • PUBLIC:公网型

PUBLIC

StrategyMode

string

访问策略模式:

  • LATENCY:基于延时

  • GEO:基于地理位置

GEO

InstanceName

string

实例名称。

instanceTest

PublicCnameMode

string

公网 cname 接入方式:

  • CUSTOM:自定义

  • SYSTEM_ASSIGN:系统分配(此功能已关闭)

CUSTOM

AlertConfig

array<object>

报警通知方式。

object

SmsNotice

string

是否配置短信通知:

  • true:已配置

  • false|null: 未配置

true

NoticeType

string

报警事件类型:

  • ADDR_ALERT:地址不可用

  • ADDR_RESUME:地址恢复可用

  • ADDR_POOL_GROUP_UNAVAILABLE:地址池集合不可用

  • ADDR_POOL_GROUP_AVAILABLE:地址池集合恢复可用

  • ACCESS_STRATEGY_POOL_GROUP_SWITCH:主备地址池切换

ADDR_ALERT

EmailNotice

string

是否配置邮件通知:

  • true:已配置

  • false|null:未配置

true

DingtalkNotice

string

是否配置钉钉报警通知:

  • true:已配置

  • false|null:未配置

true

PublicUserDomainName

string

公网用户业务域名。

dns-example.top

PublicRr

string

公网接入主机名

test.rr

ExpireTimestamp

integer

实例到期时间(时间戳)。

1602658709000

ResourceGroupId

string

资源组 Id。

resourceGroupid123

VersionCode

string

实例版本。

standard

UsedQuota

object

已使用的配额。

EmailUsedCount

integer

已发送邮件总数。

100

TaskUsedCount

integer

已创建探测任务数。

100

SmsUsedCount

integer

已发送短信总数。

100

DingtalkUsedCount

integer

已发送钉钉总数。

100

TaskQuota

integer

探测任务总数。

1

CreateTimestamp

integer

创建时间戳。

1602658709000

TotalPages

integer

总页数。

123

TotalItems

integer

总个数。

100

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "PageNumber": 1,
  "GtmInstances": [
    {
      "PaymentType": "Subscription",
      "ExpireTime": "2020-10-14T06:58Z",
      "CreateTime": "2020-10-14T06:58Z",
      "SmsQuota": 1,
      "InstanceId": "gtm-cn-wwo3a3hbz**",
      "Config": {
        "Ttl": 60,
        "AlertGroup": "[\"test1\",\"test2\"]",
        "PublicZoneName": "gtm-cn-wwo3a3hbz**.dns-example.top",
        "CnameType": "PUBLIC",
        "StrategyMode": "GEO",
        "InstanceName": "instanceTest",
        "PublicCnameMode": "CUSTOM",
        "AlertConfig": [
          {
            "SmsNotice": "true",
            "NoticeType": "ADDR_ALERT",
            "EmailNotice": "true",
            "DingtalkNotice": "true"
          }
        ],
        "PublicUserDomainName": "dns-example.top",
        "PublicRr": "test.rr"
      },
      "ExpireTimestamp": 1602658709000,
      "ResourceGroupId": "resourceGroupid123",
      "VersionCode": "standard",
      "UsedQuota": {
        "EmailUsedCount": 100,
        "TaskUsedCount": 100,
        "SmsUsedCount": 100,
        "DingtalkUsedCount": 100
      },
      "TaskQuota": 1,
      "CreateTimestamp": 1602658709000
    }
  ],
  "TotalPages": 123,
  "TotalItems": 100
}

错误码

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

变更历史

更多信息,参考变更详情