根据传入参数获取地址列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
alidns:ListCloudGtmAddresses |
list |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
AcceptLanguage |
string |
否 |
返回值语言,取值:
|
en-US |
ClientToken |
string |
否 |
用户生成的请求 token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。 |
1ae05db4-10e7-11ef-b126-00163e24**** |
Name |
string |
否 |
地址名称。 |
test |
Type |
string |
否 |
地址类型:
|
IPv4 |
Address |
string |
否 |
IP 地址或者域名。 |
223.5.XX.XX |
EnableStatus |
string |
否 |
表示地址当前是否可用:
|
enable |
HealthStatus |
string |
否 |
地址健康检查探测状态:
|
ok |
MonitorTemplateId |
string |
否 |
健康检查模板 ID,健康探测模板的唯一标识码。 |
mtp-89518052425100**** |
PageNumber |
integer |
是 |
当前页数,起始值为 1,默认为 1。 |
1 |
PageSize |
integer |
是 |
分页查询时设置的每页行数,最大值 100,默认为 20。 |
20 |
AddressId |
string |
否 |
地址 ID,地址唯一标识码。 |
addr-89518218114368**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
唯一请求识别码。 |
536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
PageNumber |
integer |
当前页数,起始值为 1,默认为 1。 |
1 |
PageSize |
integer |
分页查询时设置的每页行数,最大值 100,默认为 20。 |
20 |
TotalPages |
integer |
总页数。 |
2 |
TotalItems |
integer |
获取到地址列表中的地址总数。 |
30 |
Addresses |
object |
||
Address |
array<object> |
地址列表。 |
|
object |
地址列表。 |
||
AddressId |
string |
地址 ID,唯一标识该地址。 |
addr-89518218114368**** |
CreateTime |
string |
地址创建时间。 |
2024-03-23T13:09Z |
CreateTimestamp |
integer |
创建时间(时间戳)。 |
1527690629357 |
UpdateTime |
string |
地址修改时间。 |
2024-03-29T13:20Z |
UpdateTimestamp |
integer |
更新时间(时间戳)。 |
1527690824357 |
Name |
string |
地址名称。 |
Address-1 |
Type |
string |
地址类型:
|
IPv4 |
Address |
string |
IP 地址或者域名。 |
223.5.XX.XX |
AttributeInfo |
string |
地址归属信息。 |
当前版本不支持此参数,不会返回地址归属信息。 |
Remark |
string |
备注。 |
app |
EnableStatus |
string |
表示地址当前是否可用:
|
enable |
AvailableMode |
string |
地址探测异常切换方式: auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。 manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。 |
auto |
ManualAvailableStatus |
string |
当地址探测异常切换模式为 manual 时,地址设置的可用状态: available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。 unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。 |
available |
AvailableStatus |
string |
地址可用状态:
|
available |
HealthStatus |
string |
地址健康检查探测状态:
|
ok |
HealthJudgement |
string |
地址健康状态判定条件:
|
p50_ok |
HealthTasks |
object |
||
HealthTask |
array<object> |
健康探测任务列表。 |
|
object |
地址关联的健康探测任务列表。 |
||
Port |
integer |
健康检查探测的目标地址服务端口,当健康检查选择 Ping 协议时,不支持服务端口的配置。 |
80 |
TemplateId |
string |
地址关联的健康探测模板 ID。 |
mtp-89518052425100**** |
TemplateName |
string |
健康探测模板名称。 |
Ping-IPv4 |
MonitorStatus |
string |
健康探测模板探测任务状态:
|
ok |
示例
正常返回示例
JSON
格式
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"PageNumber": 1,
"PageSize": 20,
"TotalPages": 2,
"TotalItems": 30,
"Addresses": {
"Address": [
{
"AddressId": "addr-89518218114368****",
"CreateTime": "2024-03-23T13:09Z",
"CreateTimestamp": 1527690629357,
"UpdateTime": "2024-03-29T13:20Z",
"UpdateTimestamp": 1527690824357,
"Name": "Address-1",
"Type": "IPv4",
"Address": "223.5.XX.XX",
"AttributeInfo": "当前版本不支持此参数,不会返回地址归属信息。",
"Remark": "app",
"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"
}
]
}
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。