Queries a list of address pools.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| alidns:SearchCloudGtmAddressPools | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AcceptLanguage | string | No | The language of the response. Valid values:
| en-US |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | 1ae05db4-10e7-11ef-b126-00163e24**22 |
| PageNumber | integer | No | Current page number, starting from 1, default is 1. | 1 |
| PageSize | integer | No | The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20. | 20 |
| AddressPoolName | string | No | Address pool name, supports fuzzy search for the entered address pool name. | AddressPool-1 |
| AddressPoolType | string | No | Address pool type, supports precise query for address pool types:
| IPv4 |
| EnableStatus | string | No | Address pool enable status, supports precise query of address pool enable status:
| enable |
| Remark | string | No | Address pool remarks, supporting fuzzy search for the input remarks. | test |
| HealthStatus | string | No | The health state of the address pool. You can enter a health state for exact search. Valid values: ok: The health state of the address pool is normal and all addresses that are referenced by the address pool are available. ok_alert: The health state of the address pool is warning and some of the addresses that are referenced by the address pool are unavailable. However, the address pool is deemed normal. In this case, only the available addresses are returned for Domain Name System (DNS) requests. exceptional: The health state of the address pool is abnormal and some or all of the addresses that are referenced by the address pool are unavailable. In this case, the address pool is deemed abnormal. | ok |
| AvailableStatus | string | No | Address pool availability status, supporting precise queries for address pool availability:
| available |
Response parameters
Examples
Sample success responses
JSONformat
{
"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-895280232254422016",
"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-895182181143688192",
"WeightValue": 1,
"SerialNumber": 1,
"RequestSource": "default",
"Name": "Address-1",
"Type": "IPv4",
"Address": "223.5.XX.XX",
"AttributeInfo": "Not supported in the current version.",
"Remark": "test",
"EnableStatus": "enable",
"AvailableMode": "auto",
"ManualAvailableStatus": "available",
"AvailableStatus": "available",
"HealthStatus": "ok",
"HealthJudgement": "any_ok",
"HealthTasks": {
"HealthTask": [
{
"Port": 80,
"TemplateId": "mtp-89518052425100**80",
"TemplateName": "IPv4-Ping"
}
]
}
}
]
},
"Remark": "test"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.