调用DescribeDnsGtmInstance获取实例详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDnsGtmInstance

系统规定参数。取值:DescribeDnsGtmInstance。

InstanceId String instance1

实例ID。

Lang String en

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

返回数据

名称 类型 示例值 描述
Config Struct

实例配置信息。

AlertConfig Array of AlertConfig

报警通知方式。

AlertConfig
EmailNotice Boolean true

是否配置邮件通知:

  • true:已配置
  • false|null : 未配置
NoticeType String ADDR_ALERT

报警事件类型:

  • ADDR_ALERT:地址不可用
  • ADDR_RESUME:地址恢复可用
  • ADDR_POOL_GROUP_UNAVAILABLE:地址池集合不可用
  • ADDR_POOL_GROUP_AVAILABLE:地址池集合恢复可用
  • ACCESS_STRATEGY_POOL_GROUP_SWITCH:主备地址池切换
  • MONITOR_NODE_IP_CHANGE:监控节点IP地址变更
SmsNotice Boolean true

是否配置短信通知:

  • true:已配置
  • false|null : 未配置
AlertGroup String alertgroup1

报警组。

CnameType String public

cname接入域名类型:

  • PUBLIC: 公网型
InstanceName String instancetest1

实例名称。

PubicZoneName String gtmtestinstance.example.com

公网接入域名。

PublicCnameMode String custom

公网cname接入方式:

  • CUSTOM: 自定义
  • SYSTEM_ASSIGN: 系统分配
PublicUserDomainName String example.com

公网用户业务域名。

StrategyMode String GEO

访问策略模式:

  • LATENCY:基于延时
  • GEO:基于地理位置
Ttl Integer 1

全局TTL。

CreateTime String 2020-10-14T06:58Z

创建时间。

CreateTimestamp Long 1602656937000

创建时间戳。

ExpireTime String 2020-10-14T06:58Z

到期日。

ExpireTimestamp Long 1602656937000

到期时间戳。

InstanceId String instanceid1

实例id。

PaymentType String Subscription

付费类型

  • Subscription:预付费
RequestId String 84314904-D047-4176-A0EC-256D7F68C7F5

唯一请求识别码。

ResourceGroupId String resourcegroupid1

资源组id。

SmsQuota Integer 100

短信通知总数。

TaskQuota Integer 100

探测任务总数。

UsedQuota Struct

已使用的配额。

EmailUsedCount Integer 123

已发送邮件总数。

SmsUsedCount Integer 123

已发送短信总数。

TaskUsedCount Integer 123

已创建探测任务数。

VersionCode String versioncode1

实例版本。

示例

请求示例

http(s)://alidns.aliyuncs.com/?Action=DescribeDnsGtmInstance
&InstanceId=instance1
&<公共请求参数>

正常返回示例

XML格式

<ExpireTimestamp>1602656937000</ExpireTimestamp>
<VersionCode>versioncode1</VersionCode>
<ResourceGroupId>resourcegroupid1</ResourceGroupId>
<RequestId>84314904-D047-4176-A0EC-256D7F68C7F5</RequestId>
<InstanceId>instanceid1</InstanceId>
<PaymentType>Subscription</PaymentType>
<TaskQuota>100</TaskQuota>
<Config>
    <InstanceName>instancetest1</InstanceName>
    <AlertGroup>alertgroup1</AlertGroup>
    <PubicZoneName>gtmtestinstance.example.com</PubicZoneName>
    <AlertConfig>
        <AlertConfig>
            <SmsNotice>true</SmsNotice>
            <NoticeType>ADDR_ALERT</NoticeType>
            <EmailNotice>true</EmailNotice>
        </AlertConfig>
    </AlertConfig>
    <CnameType>public</CnameType>
    <PublicUserDomainName>example.com</PublicUserDomainName>
    <StrategyMode>GEO</StrategyMode>
    <Ttl>1</Ttl>
    <PublicCnameMode>custom</PublicCnameMode>
</Config>
<CreateTime>2020-10-14T06:58Z</CreateTime>
<ExpireTime>2020-10-14T06:58Z</ExpireTime>
<CreateTimestamp>1602656937000</CreateTimestamp>
<SmsQuota>100</SmsQuota>
<UsedQuota>
    <TaskUsedCount>123</TaskUsedCount>
    <SmsUsedCount>123</SmsUsedCount>
    <EmailUsedCount>123</EmailUsedCount>
</UsedQuota>

JSON格式

{
	"ExpireTimestamp": "1602656937000",
	"VersionCode": "versioncode1",
	"ResourceGroupId": "resourcegroupid1",
	"RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
	"InstanceId": "instanceid1",
    "PaymentType": "Subscription",
	"TaskQuota": "100",
	"Config": {
		"InstanceName": "instancetest1",
		"AlertGroup": "alertgroup1",
		"PubicZoneName": "gtmtestinstance.example.com",
		"AlertConfig": {
			"AlertConfig": [{
				"SmsNotice": "true",
				"NoticeType": "ADDR_ALERT",
				"EmailNotice": "true"
			}]
		},
		"CnameType": "public",
		"PublicUserDomainName": "example.com",
		"StrategyMode": "GEO",
		"Ttl": "1",
		"PublicCnameMode": "custom"
	},
	"CreateTime": "2020-10-14T06:58Z",
	"ExpireTime": "2020-10-14T06:58Z",
	"CreateTimestamp": "1602656937000",
	"SmsQuota": "100",
	"UsedQuota": {
		"TaskUsedCount": "123",
		"SmsUsedCount": "123",
		"EmailUsedCount": "123"
	}
}

错误码

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