按照地址名称、备注信息、地址引用的探测模板或地址DI等信息搜索地址列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
alidns:SearchCloudGtmAddresses |
list |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
AcceptLanguage |
string |
否 |
返回值语言,取值:
|
en-US |
Names |
array |
否 |
地址名称,一般为方便用户区分的名称。 |
|
string |
否 |
地址名称搜索条件,支持同时输入多个关键词进行查询。 |
["address_1", "test"] |
|
NameSearchCondition |
string |
否 |
按地址名称查询时的搜索逻辑(选择地址名称查询时必选参数):
|
or |
AvailableStatus |
string |
否 |
按照地址可用状态条件精确搜索:
|
available |
Type |
string |
否 |
按照地址类型条件精确搜索:
|
IPv4 |
Address |
string |
否 |
按照服务地址条件精确查询,支持 IP 地址或者域名。 |
223.5.XX.XX |
MonitorTemplateName |
string |
否 |
健康探测模板名称。 |
Ping-IPv4 |
EnableStatus |
string |
否 |
按照地址启用状态进行精确查询:
|
enable |
HealthStatus |
string |
否 |
按照地址健康状态进行精确查询:
|
ok |
Remarks |
array |
否 |
地址的备注。 |
|
string |
否 |
地址备注搜索条件,支持同时输入多个关键词进行查询。 |
["", "test"] |
|
RemarkSearchCondition |
string |
否 |
按地址备注查询时的搜索逻辑(选择地址备注查询时必选参数): and:展示输入的搜索条件全部命中的查询结果。 or:展示输入的搜索条件部分或全部命中的查询结果。 |
or |
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 |
总页数。 |
1 |
TotalItems |
integer |
符合查询条件的地址总条目数。 |
15 |
Addresses |
object |
||
Address |
array<object> |
地址列表。 |
|
object |
地址列表。 |
||
AddressId |
string |
地址的 ID,地址唯一标识码。 |
addr-89518218114368**92 |
CreateTime |
string |
地址的创建时间。 |
2024-03-23T13:09Z |
CreateTimestamp |
integer |
地址的创建时间(时间戳)。 |
1527690629357 |
UpdateTime |
string |
地址的最后一次的修改时间。 |
2024-03-29T13:20Z |
UpdateTimestamp |
integer |
地址的最后一次的修改时间(时间戳)。 |
1527690629357 |
Name |
string |
地址名称。 |
Address-1 |
Type |
string |
地址类型:
|
IPv4 |
Address |
string |
IP 地址或者域名。 |
223.5.XX.XX |
AttributeInfo |
string |
地址归属信息,当前版本不支持此参数。 |
当前版本不返回此参数。 |
Remark |
string |
备注。 |
test |
EnableStatus |
string |
地址当前启用状态:
|
enable |
AvailableMode |
string |
地址探测异常切换方式:
|
auto |
ManualAvailableStatus |
string |
当地址探测异常切换模式为 manual 时,地址设置的可用状态:
|
available |
AvailableStatus |
string |
当地址探测异常切换模式为 manual 时,地址设置的可用状态:
|
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 |
健康探测模板名称。 |
IPv4-Ping |
MonitorStatus |
string |
健康探测模板探测任务状态:
|
ok |
示例
正常返回示例
JSON
格式
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"PageNumber": 1,
"PageSize": 20,
"TotalPages": 1,
"TotalItems": 15,
"Addresses": {
"Address": [
{
"AddressId": "addr-89518218114368**92",
"CreateTime": "2024-03-23T13:09Z",
"CreateTimestamp": 1527690629357,
"UpdateTime": "2024-03-29T13:20Z",
"UpdateTimestamp": 1527690629357,
"Name": "Address-1",
"Type": "IPv4",
"Address": "223.5.XX.XX",
"AttributeInfo": "当前版本不返回此参数。",
"Remark": "test",
"EnableStatus": "enable",
"AvailableMode": "auto",
"ManualAvailableStatus": "available",
"AvailableStatus": "available",
"HealthStatus": "ok",
"HealthJudgement": "p50_ok",
"HealthTasks": {
"HealthTask": [
{
"Port": 80,
"TemplateId": "mtp-89518052425100****",
"TemplateName": "IPv4-Ping",
"MonitorStatus": "ok"
}
]
}
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。