调用DescribeDnsGtmInstance获取GTM实例详情_云解析DNS(DNS)-阿里云帮助中心

通过实例ID获取实例详情。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alidns:DescribeDnsGtmInstance

get

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	部分返回参数语言。默认值：en。取值范围：en、zh、ja。	en
InstanceId	string	是	实例 ID。可通过调用 DescribeDnsGtmInstances 获取	gtm-cn-wwo3a3hbz**

返回参数

名称	类型	描述	示例值
	object
ExpireTimestamp	integer	实例到期时间（时间戳）。	1602656937000
RequestId	string	唯一请求识别码。	84314904-D047-4176-A0EC-256D7F68C7F5
ResourceGroupId	string	资源组 id。	resourc*****
InstanceId	string	实例 id。	gtm-cn-wwo3a3hbz**
TaskQuota	integer	探测任务总数。	100
Config	object	实例配置信息。
Ttl	integer	全局 TTL。	60
AlertGroup	string	报警组(List的 JSON 格式)。	["test1","test2"]
CnameType	string	cname 接入域名类型： PUBLIC: 公网型	PUBLIC
StrategyMode	string	访问策略模式： LATENCY：基于延时 GEO：基于地理位置	GEO
InstanceName	string	实例名称。	test
PublicCnameMode	string	公网 cname 接入方式： CUSTOM: 自定义 SYSTEM_ASSIGN: 系统分配（此功能已关闭）	CUSTOM
AlertConfig	object
AlertConfig	array<object>	报警通知方式。
	object
SmsNotice	boolean	是否配置短信通知： true：已配置 false｜null : 未配置	true
NoticeType	string	报警事件类型： ADDR_ALERT：地址不可用 ADDR_RESUME：地址恢复可用 ADDR_POOL_GROUP_UNAVAILABLE：地址池集合不可用 ADDR_POOL_GROUP_AVAILABLE：地址池集合恢复可用 ACCESS_STRATEGY_POOL_GROUP_SWITCH：主备地址池切换 MONITOR_NODE_IP_CHANGE：监控节点 IP 地址变更	ADDR_ALERT
EmailNotice	boolean	是否配置邮件通知： true：已配置 false｜null : 未配置	true
DingtalkNotice	boolean	是否配置钉钉通知： true：已配置 false｜null ：未配置	true
PublicUserDomainName	string	公网用户业务域名。	example.com
PubicZoneName	string	公网接入域名。	gtm-cn-wwo3a3hbz**.example.com
PublicRr	string	公网接入主机名	test.rr
CreateTime	string	实例创建时间。	2020-10-14T06:58Z
SmsQuota	integer	短信通知总数。	100
VersionCode	string	实例版本。	standard
PaymentType	string	付费类型 Subscription：预付费	Subscription
ExpireTime	string	到期日。	2020-10-14T06:58Z
CreateTimestamp	integer	实例创建时间（时间戳）。	1602656937000
UsedQuota	object	已使用的配额。
EmailUsedCount	integer	已发送邮件总数。	123
TaskUsedCount	integer	已创建探测任务数。	123
SmsUsedCount	integer	已发送短信总数。	123
DingtalkUsedCount	integer	已发送钉钉总数。	123

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。