Help Center/ Global Accelerator/ API Reference/ API/ BYOIP Pool/ Querying the BYOIP Pools

Updated on 2025-11-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the BYOIP Pools

Function

This API is used to query the BYOIP pools.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ga::listByoipPools	List	-	-	ga:byoippool:list	-

URI

GET /v1/byoip-pools

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of resources on each page. If this parameter is not specified, the default value is 500.
marker	No	String	Specifies the ID of the resource from which pagination query starts, that is, the ID of the last resource on the previous page. If the parameter is not specified, only resources on the first page are queried. This parameter must be used together with limit.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
byoip_pools	Array of ByoipPool objects	Specifies the BYOIP pools.
page_info	PageInfo object	Specifies the pagination query information.

**Table 4** ByoipPool
Parameter	Type	Description
id	String	Specifies the ID of the BYOIP pool.
cidr	String	Specifies the CIDR block of the BYOIP pool.
ip_type	String	The IP address type. Value range: IPV4 and IPV6
created_at	String	Specifies when the BYOIP pool was created.
updated_at	String	Specifies when the BYOIP pool was updated.
area	String	Specifies the acceleration area. The value can be one of the following: OUTOFCM: Outside the Chinese mainland CM: Chinese mainland
domain_id	String	Specifies the tenant ID.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the marker of the next page. If this parameter is left empty, the resource is on the last page.
current_count	Integer	Specifies the number of resources on the current list.

Example Requests

Request example for querying BYOIP pools.

GET https://{ga_endpoint}/v1/byoip-pools

Example Responses

Status code: 200

Successful operation.

{
  "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
  }
}