调用DescribeDnsGtmInstances获取实例列表。

调试

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

请求参数

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

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

Lang String en

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

PageNumber Integer 1

当前页码。

PageSize Integer 1

页面大小。

Keyword String instance1

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

ResourceGroupId String rg-testgroupid

资源组ID。

返回数据

名称 类型 示例值 描述
GtmInstances Array of GtmInstance

实例列表。

Config Struct

实例配置信息。

AlertConfig Array of AlertConfig

报警通知方式。

EmailNotice String 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:主备地址池切换
SmsNotice String true

是否配置短信通知:

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

报警组。

CnameType String public

cname接入域名类型:

  • PUBLIC: 公网型
InstanceName String instanceTest

实例名称。

PublicCnameMode String custom

公网cname接入方式:

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

公网用户业务域名。

PublicZoneName String gtminstance.example.com

公网接入域名。

StrategyMode String geo

访问策略模式:

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

全局TTL。

CreateTime String 2020-10-14T06:58Z

创建时间。

CreateTimestamp Long 1602658709000

创建时间戳。

ExpireTime String 2020-10-14T06:58Z

到期日。

ExpireTimestamp Long 1602658709000

到期时间戳

InstanceId String instance1

实例id。

PaymentType String Subscription

付费类型:

  • Subscription:预付费
ResourceGroupId String resourceGroupid123

资源组Id。

SmsQuota Integer 1

短信通知总数。

TaskQuota Integer 1

探测任务总数。

UsedQuota Struct

已使用的配额。

EmailUsedCount Integer 100

已发送邮件总数。

SmsUsedCount Integer 100

已发送短信总数。

TaskUsedCount Integer 100

已创建探测任务数。

VersionCode String testVersion1

实例版本。

PageNumber Integer 1

当前页码。

PageSize Integer 1

页面大小。

RequestId String 84314904-D047-4176-A0EC-256D7F68C7F5

唯一请求识别码。

TotalItems Integer 100

总个数。

TotalPages Integer 123

总页数。

示例

请求示例

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

正常返回示例

XML 格式

<PageSize>1</PageSize>
<RequestId>84314904-D047-4176-A0EC-256D7F68C7F5</RequestId>
<PageNumber>1</PageNumber>
<GtmInstances>
    <ExpireTimestamp>1602658709000</ExpireTimestamp>
    <VersionCode>testVersion1</VersionCode>
    <ResourceGroupId>resourceGroupid123</ResourceGroupId>
    <InstanceId>instance1</InstanceId>
    <PaymentType>Subscription</PaymentType>
    <TaskQuota>1</TaskQuota>
    <CreateTime>2020-10-14T06:58Z</CreateTime>
    <ExpireTime>2020-10-14T06:58Z</ExpireTime>
    <CreateTimestamp>1602658709000</CreateTimestamp>
    <SmsQuota>1</SmsQuota>
    <UsedQuota>
        <TaskUsedCount>100</TaskUsedCount>
        <SmsUsedCount>100</SmsUsedCount>
        <EmailUsedCount>100</EmailUsedCount>
    </UsedQuota>
    <Config>
        <InstanceName>instanceTest</InstanceName>
        <AlertGroup>testgroup</AlertGroup>
        <AlertConfig>
            <SmsNotice>true</SmsNotice>
            <NoticeType>ADDR_ALERT</NoticeType>
            <EmailNotice>true</EmailNotice>
        </AlertConfig>
        <CnameType>public</CnameType>
        <PublicUserDomainName>example.com</PublicUserDomainName>
        <PublicZoneName>gtminstance.example.com</PublicZoneName>
        <StrategyMode>geo</StrategyMode>
        <Ttl>1</Ttl>
        <PublicCnameMode>custom</PublicCnameMode>
    </Config>
</GtmInstances>
<TotalPages>123</TotalPages>
<TotalItems>100</TotalItems>

JSON 格式

{
	"PageSize": "1",
	"RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
	"PageNumber": "1",
	"GtmInstances": [{
		"ExpireTimestamp": "1602658709000",
		"VersionCode": "testVersion1",
		"ResourceGroupId": "resourceGroupid123",
		"InstanceId": "instance1",
		"PaymentType": "Subscription",
		"TaskQuota": "1",
		"CreateTime": "2020-10-14T06:58Z",
		"ExpireTime": "2020-10-14T06:58Z",
		"CreateTimestamp": "1602658709000",
		"SmsQuota": "1",
		"UsedQuota": {
			"TaskUsedCount": "100",
			"SmsUsedCount": "100",
			"EmailUsedCount": "100"
		},
		"Config": {
			"InstanceName": "instanceTest",
			"AlertGroup": "testgroup",
			"AlertConfig": [{
				"SmsNotice": "true",
				"NoticeType": "ADDR_ALERT",
				"EmailNotice": "true"
			}],
			"CnameType": "public",
			"PublicUserDomainName": "example.com",
			"PublicZoneName": "gtminstance.example.com",
			"StrategyMode": "geo",
			"Ttl": "1",
			"PublicCnameMode": "custom"
		}
	}],
	"TotalPages": "123",
	"TotalItems": "100"
}

错误码

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