DescribeCloudGtmAddressReference - 获取地址被引用的信息 - 云解析 DNS

根据传入参数获取地址被引用的地址池、GTM3.0实例信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
alidns:DescribeCloudGtmAddressReference	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
AcceptLanguage	string	否	返回信息的语言类型： zh-CN：中文 en-US（默认值）：英文	zh-CN
ClientToken	string	否	用户生成的请求 token。用于保证请求的幂等性。注意由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	否	地址 ID，唯一标识地址。	addr-89518218114368****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	唯一请求识别码。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
AddressId	string	地址 ID，唯一标识地址。	addr-89564584963974****
Name	string	地址名称。	Address-1
Address	string	IP 地址或域名。	223.5.XX.XX
AddressPools	array<object>	地址池列表。
AddressPool	object	地址池信息。
AddressPoolId	string	地址池 ID。	pool-89528023225442****
AddressPoolName	string	地址池名称。	AddressPool-1
InstanceConfigs	array<object>	引用地址池的实例列表。
InstanceConfig	object	引用地址池的实例配置信息。
InstanceId	string	全局流量管理 3.0 实例 ID。	gtm-cn-zz11t58****
InstanceName	string	实例名称。	test
ConfigId	string	域名实例配置 ID，相同接入域名、相同的 GTM 实例可以同时配置 A 和 AAAA 记录，此情况下相同的 GTM 实例会出现 2 个域名实例配置，ConfigId 可以唯一标识域名实例配置。	config-00****
VersionCode	string	全局流量管理 3.0 实例版本： standard：标准版 ultimate：旗舰版	ultimate
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 值。	30
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
Remark	string	备注。	test
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
Remark	string	地址池的备注。	pool-1

示例

正常返回示例

JSON格式

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AddressId": "addr-89564584963974****",
  "Name": "Address-1",
  "Address": "223.5.XX.XX",
  "AddressPools": {
    "AddressPool": [
      {
        "AddressPoolId": "pool-89528023225442****",
        "AddressPoolName": "AddressPool-1",
        "InstanceConfigs": {
          "InstanceConfig": [
            {
              "InstanceId": "gtm-cn-zz11t58****",
              "InstanceName": "test",
              "ConfigId": "config-00****",
              "VersionCode": "ultimate",
              "ScheduleZoneName": "example.com\n",
              "ScheduleHostname": "www",
              "ScheduleDomainName": "www.example.com",
              "ScheduleRrType": "A",
              "Ttl": 30,
              "AddressPoolLbStrategy": "round_robin",
              "SequenceLbStrategyMode": " preemptive",
              "AvailableStatus": "available",
              "EnableStatus": "enable",
              "HealthStatus": "ok",
              "Remark": "test"
            }
          ]
        },
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Remark": "pool-1"
      }
    ]
  }
}

错误码

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