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

Querying Areas Where CloudPond Is Available

Function

This API is used to list the areas where CloudPond is available.

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

URI

GET /v1/{domain_id}/zones

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

zones

Array of ZoneDetail objects

Area list.

page_info

PageInfo object

Pagination information.
Table 5 ZoneDetail

Parameter

Type

Description

code

String

Area code, for example, CN. The value is case-insensitive and is centrally converted to uppercase letters.

name

String

Area 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

Querying areas where CloudPond is available

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

Example Response

Status code: 200

successful operation

{
  "zones" : [ {
    "name" : "China",
    "code" : "CN"
  } ],
  "page_info" : {
    "current_count" : 1
  }
}

Status Code

Status Code

Description

200

successful operation

Error Codes

For details, see Error Codes.

Parent topic: Areas