根据传入参数搜索地址池列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| alidns:SearchCloudGtmAddressPools | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AcceptLanguage | string | 否 | 返回值语言，取值：
| en-US |
| ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。 | 1ae05db4-10e7-11ef-b126-00163e24**** |
| PageNumber | integer | 否 | 当前页数，起始值为 1，默认为 1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数，最大值 100，默认为 20。 | 20 |
| AddressPoolName | string | 否 | 地址池名称，支持对输入的地址池名称进行模糊搜索。 | AddressPool-1 |
| AddressPoolType | string | 否 | 地址池类型，支持对地址池类型进行精确查询：
| IPv4 |
| EnableStatus | string | 否 | 地址池启用状态，支持对地址池启用状态进行精确查询：
| enable |
| Remark | string | 否 | 地址池备注，支持对输入的备注进行模糊搜索。 | test |
| HealthStatus | string | 否 | 地址池健康状态，支持对地址池健康状态精确查询： ok：正常，地址池引用的所有地址全部可用。 ok_alert：警告，地址池引用的地址部分不可用，但是地址池状态判定为正常。警告状态下，可用的地址池正常解析，不可用的地址池停止解析。 exceptional：异常，地址池引用的地址部分或全部不可用，地址池状态判定为异常。 | ok |
| AvailableStatus | string | 否 | 地址池可用状态，支持对地址池可用状态进行精确查询：
| available |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"PageNumber": 1,
"PageSize": 20,
"TotalPages": 1,
"TotalItems": 11,
"AddressPools": {
"AddressPool": [
{
"CreateTime": "2024-03-15T01:46Z",
"CreateTimestamp": 1527690629357,
"UpdateTime": "024-03-15T01:46Z",
"UpdateTimestamp": 1527690629357,
"AddressPoolId": "pool-89528023225442****",
"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-89518218114368****",
"WeightValue": 1,
"SerialNumber": 1,
"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",
"HealthTasks": {
"HealthTask": [
{
"Port": 80,
"TemplateId": "mtp-89518052425100****",
"TemplateName": "IPv4-Ping"
}
]
}
}
]
},
"Remark": "test"
}
]
}
}错误码
访问错误中心查看更多错误码。