# 查询自带IP地址池列表 - ListByoipPools
#### 功能介绍
查询自带IP地址池列表。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-ga/ga_03_0000.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ga/ga_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                  | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | ga::listByoipPools | List | -           | -   | - ga:byoippool:list | -      |
     
#### URI
GET /v1/byoip-pools
表1Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                         |
|:---|:---|:---|:---|
| limit  | 否    | Integer | 分页查询每页的资源个数。如果不设置，则默认为500。                                 |
| marker | 否    | String  | 分页查询的起始的资源ID，表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。 必须与limit一起使用。 |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                                              | 描述         |
|:---|:---|:---|
| request_id  | String                                                            | 请求ID。      |
| byoip_pools | Array of [ByoipPool] objects | 自带IP地址池列表。 |
| page_info   | [PageInfo] object             | 分页查询页的信息。  |
   
 表4ByoipPool 
| 参数         | 参数类型   | 描述                                |
|:---|:---|:---|
| id         | String | 自带IP地址池ID。                        |
| cidr       | String | 自带IP地址池的IP网段。                     |
| ip_type    | String | IP地址类型。 取值范围：IPV4、IPV6            |
| created_at | String | 创建时间。                             |
| updated_at | String | 更新时间。                             |
| area       | String | 地区，取值： - OUTOFCM：中国大陆以外 - CM：中国大陆 |
| domain_id  | String | 租户ID。                             |
   
 表5PageInfo 
| 参数            | 参数类型    | 描述                    |
|:---|:---|:---|
| next_marker   | String  | 下一页的marker，为空时表示最后一页。 |
| current_count | Integer | 当前列表中资源数量。            |
   
#### 请求示例
查询自带IP地址池列表。
```
GET https://{ga_endpoint}/v1/byoip-pools
```
#### 响应示例
**状态码：200**
操作成功
```
{
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
  "byoip_pools" : [ {
    "id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
    "cidr" : "208.188.100.0/24",
    "ip_type" : "IPV4",
    "created_at" : "2019-01-08T01:21:37Z",
    "updated_at" : "2019-01-08T01:21:37Z",
    "area" : "OUTOFCM",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24"
  } ],
  "page_info" : {
    "next_marker" : "09e86f09-03fc-440e-8132-03f3e149e979",
    "current_count" : 10
  }
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 操作成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ga/ErrorCode.html)。