Updated on 2022-10-13 GMT+08:00

Querying Regions Associated with a User

Function

Query regions associated with a user.

URI

GET /v2/servicerequest/customers/regions

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total_count

Integer

Specifies the total number.

Minimum value: 0

Maximum value: 2147483647

region_infos

Array of Region objects

Specifies the region information.

Table 3 Region

Parameter

Type

Description

region_id

String

Specifies the region ID.

Minimum length: 1

Maximum length: 64

region_name

String

Specifies the region name.

Minimum length: 1

Maximum length: 64

Example Request

GET https://{endpoint}/v2/servicerequest/customers/regions

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "total_count" : 2,
  "region_infos" : [ {
    "region_id" : "1",
    "region_name" : "1"
  }, {
    "region_id" : "2",
    "region_name" : "2"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.