Help Center/ CloudPond/ API Reference/ API/ Regions/ Listing Regions Where CloudPond Is Available
Updated on 2025-10-28 GMT+08:00
View PDF
Share

Listing Regions Where CloudPond Is Available

Function

This API is used to list the regions where CloudPond has been launched.

  • This API supports fine-grained permissions for enterprise projects. For details, see ies:region:list.

URI

GET /v1/{domain_id}/regions

Table 1 URI parameter

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID in the URI.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The number of records on each page.

marker

No

String

Pagination marker.

sort_key

No

Array of strings

Field for sorting.

sort_dir

No

Array of strings

Sorting order. Options:

  • desc: descending order

  • asc: ascending order

Request Parameters

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Language

No

String

Language of the information returned by the API. The default value is zh-cn.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

regions

Array of RegionDetail objects

Region list.

page_info

PageInfo object

Pagination information.
Table 5 RegionDetail

Parameter

Type

Description

region_id

String

The region ID.

display_name

String

The region name.
Table 6 PageInfo

Parameter

Type

Description

next_marker

String

Marker of the next page.

current_count

Integer

The number of records on the current page.

Example Request

Listing regions where CloudPond is available

GET https://{ies_endpoint}/v1/{domain_id}/regions

Example Response

Status code: 200

successful operation

{
  "regions" : [ {
    "region_id" : "cn-south-1",
    "display_name": "CN South-Guangzhou"
  } ],
  "page_info" : {
    "current_count" : 1
  }
}

Status Code

Status Code

Description

200

successful operation

Error Codes

For details, see Error Codes.

Parent topic: Regions