Address
添加地址池地址
被如下接口引用：CreateAddressPool, DescribeAddressPoolDetail, DescribeAddressPoolList, ModifyAddressPool。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Addr | String | 是 | 地址值：只支持ipv4、ipv6和域名格式； 不支持回环地址、保留地址、内网地址与腾讯保留网段 示例值：20.1.24.242 |
| IsEnable | String | 是 | 是否启用:DISABLED不启用；ENABLED启用 示例值：ENABLED |
| AddressId | Integer | 否 | 地址id 示例值：1 |
| Location | String | 否 | 地址名称 示例值：德国慕尼黑 |
| Status | String | 否 | OK正常，DOWN故障，WARN风险，UNKNOWN探测中，UNMONITORED未知 示例值：探测状态 |
| Weight | Integer | 否 | 权重，流量策略为WEIGHT时，必填；范围1-100 注意：此字段可能返回 null，表示取不到有效值。 示例值：5 |
| CreatedOn | Timestamp ISO8601 | 否 | 创建时间 示例值：2021-08-17T17:32:23+08:00 |
| UpdatedOn | Timestamp ISO8601 | 否 | 修改时间 示例值：2021-08-17T17:32:23+08:00 |
AddressLocation
地址所属地域
被如下接口引用：DescribeAddressLocation。
| 名称 | 类型 | 描述 |
|---|---|---|
| Addr | String | ip地址 示例值：1.1.1.1.1 |
| Location | String | 所属地域 示例值：局域网-未知-未知 |
AddressPool
地址池
被如下接口引用：DescribeAddressPoolList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PoolId | Integer | 否 | 地址池 id 示例值：5 |
| PoolName | String | 否 | 地址池名 示例值：测试地址池2 |
| AddrType | String | 否 | 地址池地址类型：IPV4、IPV6、DOMAIN 示例值：IPV4 |
| TrafficStrategy | String | 否 | 流量策略: WEIGHT负载均衡，ALL解析全部 示例值：ALL |
| MonitorId | Integer | 否 | 监控器id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Status | String | 否 | OK正常，DOWN故障，WARN风险，UNKNOWN未知 示例值：OK |
| AddressNum | Integer | 否 | 地址数 示例值：1 |
| MonitorGroupNum | Integer | 否 | 探点数 示例值：1 |
| MonitorTaskNum | Integer | 否 | 探测任务数 示例值：1 |
| InstanceInfo | Array of InstanceInfo | 否 | 实例相关信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"InstanceId":"gtm-dsdd123xdo","InstanceName":"测试实例"}] |
| AddressSet | Array of Address | 否 | 地址池地址信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"AddressId":32,"Addr":"2.2.2.2","Location":"","Status":"UNKNOWN","IsEnable":"ENABLED","Weight":null,"CreatedOn":"2025-07-09 21:03:16","UpdatedOn":"2025-07-09 21:03:16"}] |
| CreatedOn | Timestamp ISO8601 | 否 | 创建时间 示例值：2021-08-17T17:32:23+08:00 |
| UpdatedOn | Timestamp ISO8601 | 否 | 更新时间 示例值：2021-08-17T17:32:23+08:00 |
AddressPoolDetail
地址池详情
被如下接口引用：DescribeAddressPoolDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PoolId | Integer | 否 | 地址池 id 示例值：5 |
| PoolName | String | 否 | 地址池名 示例值：测试地址池2 |
| AddrType | String | 否 | 地址池地址类型：IPV4、IPV6、DOMAIN 示例值：IPV4 |
| TrafficStrategy | String | 否 | 流量策略: WEIGHT负载均衡，ALL解析全部 示例值：ALL |
| MonitorId | Integer | 否 | 监控器id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| CreatedOn | Timestamp ISO8601 | 否 | 创建时间 示例值：2021-08-17T17:32:23+08:00 |
| UpdatedOn | Timestamp ISO8601 | 否 | 更新时间 示例值：2021-08-17T17:32:23+08:00 |
CostItem
计费项
被如下接口引用：DescribeDetectPackageDetail, DescribeDetectTaskPackageList, DescribeInstancePackageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| CostName | String | 计费项名称 示例值：sv-xxx |
| CostValue | Integer | 计费项值 示例值：1 |
DetectTaskPackage
探测任务套餐
被如下接口引用：DescribeDetectTaskPackageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 资源id 示例值：task-aabbb |
| ResourceType | String | 资源类型 TASK 探测任务 示例值：TASK |
| Quota | Integer | 额度 示例值：1 |
| CurrentDeadline | String | 套餐过期时间 示例值：2023-12-20 12:00:00 |
| CreateTime | String | 套餐创建时间 示例值：2023-12-20 12:00:00 |
| IsExpire | Integer | 是否过期0否1是 示例值：0 |
| Status | String | 状态 ENABLED: 正常 ISOLATED: 隔离 DESTROYED：销毁 REFUNDED：已退款 示例值：ENABLED |
| AutoRenewFlag | Integer | 是否自动续费0不1是 示例值：1 |
| Remark | String | 备注 示例值：这是备注 |
| CostItemList | Array of CostItem | 计费项 |
| Group | Integer | 探测任务类型：100系统设定；200计费；300管理系统；110D监控迁移的免费任务；120容灾切换任务 注意：此字段可能返回 null，表示取不到有效值。 示例值：200 |
DetectorGroup
探测组
被如下接口引用：DescribeDetectors。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Gid | Integer | 是 | 线路组id GroupLineId 示例值：8 |
| GroupType | String | 否 | bgp, international, isp 示例值：bgp |
| GroupName | String | 否 | 组名 示例值：深圳市 |
| InternetFamily | String | 否 | ipv4, ipv6 示例值：ipv4 |
| PackageSet | Array of String | 否 | 支持的套餐类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：["FREE","STANDARD","ULTIMATE"] |
GroupLine
线路列表
被如下接口引用：DescribeDnsLineList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DnsLineId | Integer | 是 | 分组线路id 示例值：1 |
| Parent | Integer | 是 | 父节点 0为根节点 示例值：0 |
| LineName | String | 是 | 线路名 示例值：境外地区 |
| LineId | String | 是 | 10=9 DNSPod 线路 id 示例值：线路id |
| Useful | Boolean | 是 | 是否已使用过 示例值：0 |
| SubGroup | Integer | 是 | 0为未使用 示例值：子分组 |
| LinePackage | Integer | 否 | 权限标识 示例值：1 |
| Weight | Integer | 否 | 1 示例值：权重 |
Instance
返回实例
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例id 示例值：gtm-xxx |
| InstanceName | String | 否 | 实例名 示例值：instanceName |
| ResourceId | String | 否 | 资源 id 示例值：gtmins-xxxxxx |
| Domain | String | 否 | 业务域名 示例值：igtm-a101.com |
| AccessType | String | 否 | Cname域名接入方式 CUSTOM: 自定义接入域名 SYSTEM: 系统接入域名 示例值：CUSTOM |
| AccessDomain | String | 否 | 接入域名 示例值：gtmtest.com |
| AccessSubDomain | String | 否 | 接入子域名 示例值：gtm-access |
| GlobalTtl | Integer | 否 | 全局记录过期时间 示例值：600 |
| PackageType | String | 否 | 套餐类型 FREE: 免费版 STANDARD：标准版 ULTIMATE：旗舰版 示例值：FREE |
| WorkingStatus | String | 否 | 实例运行状态 NORMAL: 健康 FAULTY: 有风险 DOWN: 宕机 UNKNOWN: 未知 示例值：NORMAL |
| Status | String | 否 | 实例状态，ENABLED: 正常，DISABLED: 禁用 示例值：ENABLED |
| IsCnameConfigured | Boolean | 否 | 是否cname接入：true已接入；false未接入 示例值：true |
| Remark | String | 否 | 备注 示例值： 备注 |
| StrategyNum | Integer | 否 | 策略数量 示例值：7 |
| AddressPoolNum | Integer | 否 | 绑定地址池个数 示例值：2 |
| MonitorNum | Integer | 否 | 绑定监控器数量 示例值：2 |
| PoolId | Integer | 否 | 地址池id 示例值：1 |
| PoolName | String | 否 | 地址池名称 示例值：地址池1 |
| CreatedOn | String | 否 | 实例创建时间 示例值：2023-12-20 12:00:00 03:11:46 |
| UpdatedOn | String | 否 | 实例更新时间 示例值：2023-12-20 12:00:00 03:11:46 |
InstanceConfig
实例配置详情
被如下接口引用：ModifyInstanceConfig。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceName | String | 是 | 实例名称 示例值：实例名称 |
| Domain | String | 是 | 业务域名 示例值：maingtm.com |
| AccessType | String | 是 | CUSTOM: 自定义接入域名，SYSTEM: 系统接入域名 示例值：CUSTOM |
| Remark | String | 是 | 备注 示例值：备注信息 |
| GlobalTtl | Integer | 是 | 全局记录过期时间 示例值：600 |
| AccessDomain | String | 否 | 接入主域名 示例值：gtmtest.com |
| AccessSubDomain | String | 否 | 接入子域名 示例值：gtm-access |
InstanceDetail
返回实例
被如下接口引用：DescribeInstanceDetail, ModifyInstanceConfig。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例id 示例值：gtminstance1 |
| InstanceName | String | 否 | 实例名 示例值：instanceName |
| Domain | String | 否 | 业务域名 示例值：maintest.com |
| AccessType | String | 否 | Cname域名接入方式 CUSTOM: 自定义接入域名 SYSTEM: 系统接入域名 示例值：CUSTOM |
| AccessSubDomain | String | 否 | 接入子域名 示例值：gtm-access |
| AccessDomain | String | 否 | 接入域名 示例值：gtmtest.com |
| GlobalTtl | Integer | 否 | 解析生效时间 示例值：600 |
| PackageType | String | 否 | 套餐类型 FREE: 免费版 STANDARD：标准版 ULTIMATE：旗舰版 示例值：FREE |
| WorkingStatus | String | 否 | 实例运行状态 NORMAL: 健康 FAULTY: 有风险 DOWN: 宕机 UNKNOWN: 未知 示例值：NORMAL |
| Status | String | 否 | 实例状态，ENABLED: 正常；DISABLED: 禁用 示例值：ENABLED |
| IsCnameConfigured | Boolean | 否 | cname是否接入：true已接入；false未接入 示例值：true |
| Remark | String | 否 | 备注 示例值：这是备注 |
| StrategyNum | Integer | 否 | 策略数量 示例值：2 |
| AddressPoolNum | Integer | 否 | 绑定地址池个数 示例值：2 |
| MonitorNum | Integer | 否 | 绑定监控器数量 示例值：2 |
| ResourceId | String | 否 | 实例绑定套餐资源id 示例值：ins-oxrvmnl4yrd |
| NotifyEventSet | Array of String | 否 | 订阅事件列表 示例值：[{"owner_uin":"10012894645"}] |
| CreatedOn | String | 否 | 实例创建时间 示例值：2023-12-20 12:00:00 03:11:46 |
| UpdatedOn | String | 否 | 实例更新时间 示例值：2023-12-20 12:00:00 03:11:46 |
InstanceInfo
实例相关信息
被如下接口引用：DescribeAddressPoolList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例id 示例值：gtm-xxx |
| InstanceName | String | 否 | 实例名称 示例值：实例1 |
InstancePackage
实例套餐
被如下接口引用：DescribeInstancePackageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 实例套餐资源id 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-aaaa |
| InstanceId | String | 实例id 示例值：gtminstance1 |
| InstanceName | String | 实例名 示例值：instanceName |
| PackageType | String | 套餐类型 FREE: 免费版 STANDARD：标准版 ULTIMATE：旗舰版 示例值：FREE |
| CurrentDeadline | String | 套餐过期时间 示例值：2023-12-20 12:00:00 |
| CreateTime | String | 套餐创建时间 示例值：2023-12-20 12:00:00 |
| IsExpire | Integer | 是否过期0否1是 示例值：0 |
| Status | String | 实例状态 ENABLED: 正常 DISABLED: 禁用 示例值：ENABLED |
| AutoRenewFlag | Integer | 是否自动续费0不1是 示例值：1 |
| Remark | String | 备注 示例值：这是备注 |
| CostItemList | Array of CostItem | 计费项 |
| MinCheckInterval | Integer | 最小检查间隔时间s 示例值：60 |
| MinGlobalTtl | Integer | 最小TTL s 示例值：600 |
| TrafficStrategy | Array of String | 流量策略类型：ALL返回全部，WEIGHT权重 示例值：ALL |
| ScheduleStrategy | Array of String | 策略类型：LOCATION按地理位置调度，DELAY按延迟调度 示例值：LOCATION |
MainAddressPool
主力地址池
被如下接口引用：CreateStrategy, DescribeStrategyDetail, ModifyStrategy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AddressPools | Array of MainPoolWeight | 是 | 集合中的地址池id与权重，数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"PoolId":314,"Weight":1}] |
| MainAddressPoolId | Integer | 否 | 地址池集合id 示例值：1 |
| MinSurviveNum | Integer | 否 | 切换阀值，不能大于主力集合内地址总数 示例值：1 |
| TrafficStrategy | String | 否 | 切换策略:ALL解析所有地址；WEIGHT：负载均衡。当为ALL时，解析地址的权重值为1；当为WEIGHT时；权重为地址池权重*地址权重 示例值：ALL |
MainPoolWeight
主力地址池id与权重
被如下接口引用：CreateStrategy, ModifyStrategy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PoolId | Integer | 是 | 地址池id 示例值：1 |
| Weight | Integer | 否 | 权重 注意：此字段可能返回 null，表示取不到有效值。 示例值：50 |
MonitorDetail
监控器详情
被如下接口引用：DescribeMonitorDetail, DescribeMonitors。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MonitorId | Integer | 否 | 探测规则id 示例值：1 |
| MonitorName | String | 否 | 监控器名称 示例值：监控器1 |
| Uin | String | 否 | 所属用户 示例值：10012894645 |
| DetectorGroupIds | Array of Integer | 否 | 监控节点id组 示例值：[2,5,8] |
| CheckProtocol | String | 否 | 探测协议 PING TCP HTTP HTTPS 示例值：PING |
| CheckInterval | Integer | 否 | 探测周期 示例值：60 |
| PingNum | Integer | 否 | 发包数量 示例值：50 |
| TcpPort | Integer | 否 | tcp端口 示例值：80 |
| Host | String | 否 | 探测 host 示例值：www.baidu.com |
| Path | String | 否 | 探测路径 示例值：/path |
| ReturnCodeThreshold | Integer | 否 | 返回值阈值 示例值：500 |
| EnableRedirect | String | 否 | 是否开启3xx重定向跟随 ENABLED DISABLED 示例值：DISABLED |
| EnableSni | String | 否 | 是否启用 sni ENABLED DISABLED 示例值：DISABLED |
| PacketLossRate | Integer | 否 | 丢包率上限 示例值：30 |
| Timeout | Integer | 否 | 探测超时 示例值：200 |
| FailTimes | Integer | 否 | 失败次数 示例值：50 |
| FailRate | Integer | 否 | 失败率上限100 示例值：50 |
| CreatedOn | String | 否 | 创建时间 示例值：2021-08-17T17:32:23+08:00 |
| UpdatedOn | String | 否 | 更新时间 示例值：2021-08-17T17:32:23+08:00 |
| DetectorStyle | String | 否 | 监控节点类型 AUTO INTERNAL OVERSEAS IPV6 ALL 示例值：AUTO |
| DetectNum | Integer | 否 | 探测次数 示例值：0 |
| ContinuePeriod | Integer | 否 | 持续周期数 示例值：1 |
Quota
配额
被如下接口引用：DescribeQuotas。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TaskQuota | Integer | 否 | 探测任务配额 示例值：2 |
| PoolQuota | Integer | 否 | 地址池配额 示例值：20 |
| AddressQuota | Integer | 否 | 地址配额 示例值：25 |
| MonitorQuota | Integer | 否 | 探点资源数 示例值：1 |
| MessageQuota | Integer | 否 | 消息资源数 示例值：1 |
| UsedTaskQuota | Integer | 否 | 已使用探测任务数 示例值：1 |
| UsedFreeInstanceNum | Integer | 否 | 已使用体验实例数 示例值：1 |
| UsedBillInstanceNum | Integer | 否 | 已使用付费实例 示例值：1 |
| FreePackageNum | Integer | 否 | 体验套餐总数 示例值：1 |
| UsedBillPackageNum | Integer | 否 | 已使用付费套餐数 示例值：1 |
| BillPackageNum | Integer | 否 | 付费套餐总数 示例值：1 |
ResourceFilter
查询时过滤条件。
被如下接口引用：DescribeAddressPoolList, DescribeDetectTaskPackageList, DescribeInstanceList, DescribeInstancePackageList, DescribeStrategyList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤字段名，支持的列表如下： - type：主资源类型，CDN。 - instanceId：IGTM实例ID。此为必传参数，未传将导致接口查询失败。 示例值：InstanceId |
| Value | Array of String | 是 | 过滤字段值。 示例值：gtm-xxxxxxxx |
| Fuzzy | Boolean | 否 | 是否启用模糊查询，仅支持过滤字段名为domain。 模糊查询时，Value长度最大为1，否则Value长度最大为5。(预留字段，暂未使用) 示例值：Ture |
Source
解析线路
被如下接口引用：CreateStrategy, DescribeStrategyDetail, DescribeStrategyList, ModifyStrategy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DnsLineId | Integer | 是 | 解析请求来源线路id 示例值：1 |
| Name | String | 否 | 解析请求来源线路名 示例值：境外 |
Strategy
地址池
被如下接口引用：DescribeStrategyList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 是 | 实例id 示例值：gtminstance1 |
| Name | String | 是 | 策略名 示例值：第一条策略 |
| Source | Array of Source | 是 | 地址来源 注意：此字段可能返回 null，表示取不到有效值。 示例值：测试地址池2 |
| StrategyId | Integer | 否 | 策略id 示例值：1 |
| Status | String | 否 | 健康状态：ok健康、warn风险、down故障 示例值：warn |
| ActivateMainPoolId | Integer | 否 | 生效的主力池id，null则为未知 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ActivateLevel | Integer | 否 | 当前生效地址池所在级数，为0则代表兜底生效，null则为未知 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ActivePoolType | String | 否 | 当前生效地址池集合类型：main主力；fallback兜底 示例值：main |
| ActiveTrafficStrategy | String | 否 | 当前生效地址池流量策略：all解析所有；weight负载均衡 示例值：all |
| MonitorNum | Integer | 否 | 监控器数量 示例值：1 |
| IsEnabled | String | 否 | 是否开启：ENABLED开启；DISABLED关闭 示例值：ENABLED |
| KeepDomainRecords | String | 否 | 是否保留线路：enabled保留，disabled不保留，只保留默认线路 示例值：enabled |
| SwitchPoolType | String | 否 | 调度模式：AUTO默认；PAUSE仅暂停不切换 示例值：AUTO |
| CreatedOn | Timestamp ISO8601 | 否 | 创建时间 示例值：2021-08-17T17:32:23+08:00 |
| UpdatedOn | Timestamp ISO8601 | 否 | 更新时间 示例值：2021-08-17T17:32:23+08:00 |
StrategyDetail
策略详情
被如下接口引用：DescribeStrategyDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 是 | 实例id 示例值：gtminstance1 |
| StrategyId | Integer | 是 | 策略id 示例值：1 |
| Name | String | 是 | 策略名 示例值：第一条策略 |
| Source | Array of Source | 是 | 线路 注意：此字段可能返回 null，表示取不到有效值。 示例值： [{"Name": "默认", "GroupLineId": 1}] |
| MainAddressPoolSet | Array of MainAddressPool | 是 | 主力地址池集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"MainAddressPoolId":5,"AddressPools":[{"PoolId":314,"Weight":null}],"MinSurviveNum":1,"TrafficStrategy":"WEIGHT"}] |
| FallbackAddressPoolSet | Array of MainAddressPool | 是 | 兜底地址池id 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"AddressPools":[{"PoolId":1}]}] |
| KeepDomainRecords | String | 否 | 是否保留线路：enabled保留，disabled不保留，只保留默认线路 示例值：enabled |
| ActivateMainPoolId | Integer | 否 | 生效主力地址池id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| CreatedOn | Timestamp ISO8601 | 否 | 创建时间 示例值：2021-08-17T17:32:23+08:00 |
| UpdatedOn | Timestamp ISO8601 | 否 | 更新时间 示例值：2021-08-17T17:32:23+08:00 |
| SwitchPoolType | String | 否 | 调度模式：AUTO默认；PAUSE仅暂停不切换 示例值：AUTO |
