Help Center/ CloudPond/ API Reference/ API/ Areas/ Querying Supported Areas
Updated on 2025-12-08 GMT+08:00
View PDF
Share

Querying Supported Areas

Function

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

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

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

    ies::listZones

    List

    -

    -
    • ies:zone:list

    -

URI

GET /v1/{domain_id}/zones

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID in the path.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Page size.

marker

No

String

Pagination identifier.

sort_key

No

Array of strings

Sorting field.

sort_dir

No

Array of strings

Sorting order. The options are as follows:

  • desc: descending order

  • asc: ascending order

Request Parameters

Table 3 Request header parameters

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 converted to uppercase letters.

name

String

Area name.
Table 6 PageInfo

Parameter

Type

Description

next_marker

String

Next page marker.

current_count

Integer

Number of records on the current page.

Example Requests

Example request for listing the supported areas

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

Example Responses

Status code: 200

successful operation

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

Status Codes

Status Code

Description

200

successful operation

Error Codes

See Error Codes.

Parent topic: Areas