DescribeCloudGtmAddress - 获取地址配置信息_云解析DNS(DNS)-阿里云帮助中心

根据传入参数获取地址配置信息。

调试

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

授权信息

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

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

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

请求参数

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	唯一请求识别码。	B57C121B-A45F-44D8-A9B2-13E5A5044195
AddressId	string	地址 ID，地址唯一标识码。	addr-89518218114368****
CreateTime	string	地址创建时间。	2024-03-23T13:09Z
CreateTimestamp	long	创建时间（时间戳）。	1527690629357
UpdateTime	string	地址配置的最后修改时间。	2024-03-29T13:20Z
UpdateTimestamp	long	修改时间（时间戳）。	1527690629357
Name	string	地址名称。	test
Type	string	地址类型： IPv4 IPv6 domain	IPv4
Address	string	IP 地址或者域名。	223.5.XX.XX
AttributeInfo	string	地址归属信息。	当前版本不支持此参数，不会返回地址归属信息。
Remark	string	备注。	test1
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：所有探测模板全部探测正常。	p50_ok
HealthTasks	array<object>	健康探测任务列表。
HealthTask	object	地址引用的健康探测任务列表。
Port	integer	健康检查探测的目标地址服务端口，当健康检查选择 Ping 协议时，不支持服务端口的配置。	80
TemplateId	string	地址关联的健康探测模板 ID。	mtp-89518052425100****
TemplateName	string	健康探测模板名称。	Ping-IPv4
MonitorStatus	string	健康探测模板探测任务状态： ok：正常。 alert：告警。 no_data：无数据，一般是健康探测任务刚创建，探测任务数据暂未采集到。	ok

示例

正常返回示例

JSON格式

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AddressId": "addr-89518218114368****\n",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "test",
  "Type": "IPv4",
  "Address": "223.5.XX.XX",
  "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
  "Remark": "test1",
  "EnableStatus": "enable",
  "AvailableMode": "auto",
  "ManualAvailableStatus": "available",
  "AvailableStatus": "available",
  "HealthStatus": "ok",
  "HealthJudgement": "p50_ok",
  "HealthTasks": {
    "HealthTask": [
      {
        "Port": 80,
        "TemplateId": "mtp-89518052425100****",
        "TemplateName": "Ping-IPv4",
        "MonitorStatus": "ok"
      }
    ]
  }
}

错误码

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