DescribeCloudGtmInstanceConfigFullInfo - 获取实例配置完整信息

获取全局流量管理实例配置的完整信息，包括接入域名、告警通知、地址池、地址详细信息等。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

alidns:DescribeCloudGtmInstanceConfigFullInfo

get

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

无

请求参数

名称	类型	必填	描述	示例值
AcceptLanguage	string	否	返回信息的语言类型： zh-CN：中文 en-US（默认值）：英文	en-US
ClientToken	string	否	用户生成的请求 token。用于保证请求的幂等性。注意由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。	1ae05db4-10e7-11ef-b126-00163e24****
InstanceId	string	否	全局流量管理 3.0 实例 ID。	gtm-cn-wwo3a3h****
ConfigId	string	否	域名实例配置 ID。相同接入域名、相同的 GTM 实例可以同时配置 A 和 AAAA 记录，此情况下相同的 GTM 实例会出现 2 个域名实例配置，ConfigId 可以唯一标识域名实例配置。调用 ListCloudGtmInstanceConfigs 接口可查询域名实例对应的 ConfigId 值。	Config-000****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	唯一请求识别码。	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
InstanceId	string	全局流量管理 3.0 实例 ID。	gtm-cn-wwo3a3h****
ConfigId	string	域名实例配置 ID。相同接入域名、相同的 GTM 实例可以同时配置 A 和 AAAA 记录，此情况下相同的 GTM 实例会出现 2 个域名实例配置，ConfigId 可以唯一标识域名实例配置。	Config-000****
CreateTime	string	实例创建时间。	2024-03-15T01:46Z
CreateTimestamp	integer	实例创建时间（时间戳）。	1527690629357
UpdateTime	string	最后一次修改时间。	2024-03-15T01:46Z
UpdateTimestamp	integer	最后一次修改时间（时间戳）。	1527690629357
VersionCode	string	全局流量管理 3.0 实例版本： standard：标准版 ultimate：旗舰版	ultimate
CommodityCode	string	商品编码： dns_gtm_public_cn：中国站商品编码。 dns_gtm_public_intl：国际站商品编码。	dns_gtm_public_cn
InstanceName	string	调度实例名称。	test
ScheduleZoneMode	string	接入域名分配模式： custom：自定义接入域名，用户自定义主机记录，并关联 GTM 实例所在账号下的主域或子域，生成接入域名。 sys_assign：系统默认分配接入域名，本功能已经不支持，请勿选择此模式。	custom
ScheduleZoneName	string	GTM 接入域名的主域（example.com）或子域（a.example.com）。一般为 GTM 实例所在账号下，在云解析 DNS 控制台权威解析中托管的域名。	example.com
ScheduleHostname	string	GTM 接入域名的主机记录。	www
ScheduleDomainName	string	GTM 接入域名。格式为接入域名主机记录（ScheduleHostname 参数值）+主域或子域（ScheduleZoneName 参数值）	www.example.com
ScheduleRrType	string	调度域名的解析记录类型： A：IPv4 地址 AAAA：IPv6 地址 CNAME：域名	A
Ttl	integer	全局 TTL（单位：秒），接入域名解析到地址池中地址的 TTL 值，影响解析记录在运营商 LocalDNS 中的缓存时间，支持自定义 TTL 值。	60
AddressPoolLbStrategy	string	地址池之间的负载均衡策略： round_robin：轮询，对于任何来源的解析请求，返回所有地址池。并且每次对于所有地址池进行轮转排序； sequence：顺序，对于任何来源的解析请求，返回顺序号较小的地址池（顺序号标识地址池返回的优先级，越小优先级越高）。若顺序号较小的地址池不可用时，返回下一个序号较小的地址池。 weight：权重，支持对每个地址池设置不同的权重值，实现解析查询按照权重比例返回地址池。 source_nearest：来源就近，即智能解析功能，GTM 可以根据不同的解析请求来源返回不同的地址池，实现用户就近访问的效果。	round_robin
SequenceLbStrategyMode	string	地址池间负载均衡策略为顺序模式时，前序资源异常恢复服务模式： preemptive：抢占模式，前序资源恢复，优先使用顺序号较小的地址池。 non_preemptive：非抢占模式，前序资源恢复，仍然使用当前地址池。	preemptive
AvailableStatus	string	域名实例服务可用状态： available：可用，域名启用且健康状态为正常，接入域名的服务可用状态为可用。 unavailable：不可用，域名禁用或健康状态为异常，接入域名的服务可用状态为不可用。	available
EnableStatus	string	域名实例的启用状态： enable：启用状态，GTM 实例智能调度策略生效。 disable：禁用状态，GTM 实例智能调度策略不可用。	enable
HealthStatus	string	域名实例健康状态： ok：正常，接入域名引用的所有地址池全部可用。 ok_alert：警告，接入域名引用的所有地址池部分不可用。警告状态下，可用的地址池正常解析，不可用的地址池停止解析。 exceptional：异常，接入域名引用的所有地址池全部不可用。此时，使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析，尽可能帮助客户端获得解析结果。	ok
AlertGroup	string	告警通知组。	[\"云账号报警联系人\"]
AlertConfig	string	告警通知配置。	[{\"NoticeType\":\"addr_alert\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_resume\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_unavailable\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_available\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true}]"
Remark	string	域名实例配置的备注。	test
AddressPools	object
AddressPool	array<object>	地址池列表。
	object	地址池配置信息。
CreateTime	string	地址池创建时间。	2024-03-15T01:46Z
CreateTimestamp	integer	地址池创建时间（时间戳）。	1527690629357
UpdateTime	string	地址池最后一次修改时间。	2024-03-15T01:46Z
UpdateTimestamp	integer	地址池最后一次修改时间（时间戳）。	1527690629357
AddressPoolId	string	地址池 ID，地址池的唯一标识码。	pool-89528023225442****
WeightValue	integer	权重值（1-100 之间的整数，包括 1 和 100），支持对每个地址池设置不同的权重值，实现解析查询按照权重比例返回地址池。	1
SerialNumber	integer	顺序号，对于任何来源的解析请求，返回顺序号较小的地址池（顺序号标识地址池返回的优先级，越小优先级越高）。	1
RequestSource	object
RequestSource	array	解析请求来源列表。
	string	请求来源，是指解析请求的来源，GTM 是根据终端所用 LocalDNS 的出口 IP 进行调度。若 LocalDNS 支持 ECS (edns-client-subnet)，也可以根据访问终端的 IP 进行智能调度。	["default"]
AddressPoolName	string	地址池名称。	AddressPool-1
AddressPoolType	string	地址池类型： IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	地址池中地址间负载均衡策略： round_robin：轮询，对于任何来源的解析请求，返回所有地址。并且每次对于所有地址进行轮转排序。 sequence：顺序，对于任何来源的解析请求，返回顺序号较小的地址（顺序号标识地址返回的优先级，越小优先级越高）。若顺序号较小的地址不可用时，返回下一个序号较小的地址。 weight：权重，支持对每个地址设置不同的权重值，实现解析查询按照权重比例返回地址。 source_nearest：来源就近，即智能解析功能，GTM 可以根据不同的解析请求来源返回不同的地址，实现用户就近访问的效果。	round_robin
SequenceLbStrategyMode	string	地址间负载均衡策略为顺序模式时，前序资源异常恢复服务模式： preemptive：抢占模式，前序资源恢复，优先使用顺序号较小的地址。 non_preemptive：非抢占模式，前序资源恢复，仍然使用当前地址。	preemptive
EnableStatus	string	地址池启用状态： enable：启用状态。 disable：禁用状态。	enable
HealthJudgement	string	地址池健康状态判定条件： any_ok：地址池内至少 1 个地址是可用地址。 p30_ok：地址池内至少 30%地址是可用地址。 p50_ok：地址池内至少 50%地址是可用地址。 p70_ok：地址池内至少 70%地址是可用地址。 all_ok：地址池内地址全部可用。	any_ok
HealthStatus	string	地址池健康状态： ok：正常，地址池引用的所有地址全部可用。 ok_alert：警告，地址池引用的地址部分不可用，但是地址池状态判定为正常。警告状态下，可用的地址池正常解析，不可用的地址池停止解析 exceptional：异常，地址池引用的地址部分或全部不可用，地址池状态判定为异常。	ok
AvailableStatus	string	地址池可用性状态： available：可用。 unavailable：不可用。	available
Addresses	object
Address	array<object>	地址列表。
	object	地址信息。
CreateTime	string	地址创建时间。	2024-03-15T01:46Z
CreateTimestamp	integer	地址创建时间（时间戳）。	1527690629357
UpdateTime	string	地址最后一次修改时间。	2024-03-15T01:46Z
UpdateTimestamp	integer	地址最后一次修改时间（时间戳）。	1527690629357
AddressId	string	地址 ID，唯一标识地址。	addr-89564712295703****
WeightValue	integer	权重值（1-100 内的整数，包括 1 和 100），支持对每个地址设置不同的权重值，实现解析查询按照权重比例返回地址。	1
SerialNumber	integer	顺序号，标识地址返回的优先级，越小优先级越高。	1
RequestSource	object
RequestSource	array	解析请求来源列表。
	string	请求来源，是指解析请求的来源，GTM 是根据终端所用 LocalDNS 的出口 IP 进行调度。若 LocalDNS 支持 ECS (edns-client-subnet)，也可以根据访问终端的 IP 进行智能调度。	["default"]
Name	string	地址名称。	Address-1
Type	string	地址类型： IPv4： IPv4 地址 IPv6： IPv6 地址 domain：域名	IPv4
Address	string	IP 地址或者域名。	223.5.XX.XX
AttributeInfo	string	地址归属信息，当前版本不支持返回此参数。	当前版本不支持返回此参数。
Remark	string	地址备注信息。	test
EnableStatus	string	地址启用状态，表示地址当前是否可用： enable：启用状态。 disable：禁用状态。	enable
AvailableMode	string	地址探测异常切换方式： auto：自动模式（根据健康检查探测结果确定，探测异常停止解析，探测正常恢复解析）。 manual：手动模式（异常状态下停止解析，健康检查正常也不会恢复解析；正常状态下恢复解析，健康检查异常也只是告警，但不会停止解析）。	auto
ManualAvailableStatus	string	当地址探测异常切换模式为 manual 时，地址设置的可用状态： available：正常，此状态下该地址正常解析，健康检查异常也只是告警，但不会停止解析。 unavailable：异常，此状态下停止解析，健康检查正常也不会恢复解析。	available
AvailableStatus	string	地址可用状态： available：地址可用。 unavailable：地址不可用。	available
HealthStatus	string	地址健康探测状态： ok：地址引用的健康探测模板探测任务全部正常。 ok_alert：地址引用的健康探测模板探测任务部分异常，但地址判定为正常状态。 ok_no_monitor：地址没有引用任何健康探测模板，状态正常。 exceptional：地址引用的健康探测模板探测任务部分或全部异常，且地址判定为异常状态。	ok
HealthJudgement	string	地址健康状态判定条件： any_ok：所有探测模板至少一个探测正常。 p30_ok：所有探测模板至少 30%探测正常。 p50_ok：所有探测模板至少 50%探测正常。 p70_ok：所有探测模板至少 70%探测正常。 all_ok：所有探测模板全部探测正常。	any_ok
SeqNonPreemptiveSchedule	boolean	是否是顺序（非抢占）模式调度对象，针对于融合云纳管场景： true：是 false：不是	false
SeqNonPreemptiveSchedule	boolean	是否是顺序（非抢占）模式调度对象，针对于融合云纳管场景： true：是 false：不是	false

示例

正常返回示例

JSON格式

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "InstanceId": "gtm-cn-wwo3a3h****",
  "ConfigId": "Config-000****",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "VersionCode": "ultimate",
  "CommodityCode": "dns_gtm_public_cn",
  "InstanceName": "test",
  "ScheduleZoneMode": "custom",
  "ScheduleZoneName": "example.com",
  "ScheduleHostname": "www",
  "ScheduleDomainName": "www.example.com",
  "ScheduleRrType": "A",
  "Ttl": 60,
  "AddressPoolLbStrategy": "round_robin",
  "SequenceLbStrategyMode": "preemptive",
  "AvailableStatus": "available",
  "EnableStatus": "enable",
  "HealthStatus": "ok",
  "AlertGroup": "[\\\"云账号报警联系人\\\"]",
  "AlertConfig": "[{\\\"NoticeType\\\":\\\"addr_alert\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_resume\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_unavailable\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_available\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true}]\"",
  "Remark": "test",
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442****",
        "WeightValue": 1,
        "SerialNumber": 1,
        "RequestSource": {
          "RequestSource": [
            "[\"default\"]"
          ]
        },
        "AddressPoolName": "AddressPool-1",
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-89564712295703****",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "当前版本不支持返回此参数。",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  }
}

错误码

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

变更历史

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