Help Center/ Workspace/ API Reference/ Workspace APIs/ Scheduled Tasks/ Obtaining Time Zone Configurations
Updated on 2025-07-14 GMT+08:00

Obtaining Time Zone Configurations

Function

Obtains time zone configurations.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/common/timezones

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

time_zone_name

No

String

Filters by time zone name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

time_zones

Array of Timezones objects

Time zone list.

Table 5 Timezones

Parameter

Type

Description

time_zone_desc

String

Time zone description.

time_zone

String

Time zone offset.

time_zone_name

String

Time zone name.

time_zone_desc_us

String

Time zone description in English.

time_zone_desc_cn

String

Time zone description in Chinese.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

None

Example Responses

Status code: 200

Time zone configuration response.

{
  "time_zones" : [ {
    "time_zone_desc" : "(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei",
    "time_zone" : "GMT+08:00",
    "time_zone_name" : "Asia/Shanghai",
    "time_zone_desc_us" : "(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei",
    "time_zone_desc_cn" : "(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi, and Taipei"
  } ]
}

Status Codes

Status Code

Description

200

Time zone configuration response.

400

The request cannot be understood by the server due to malformed syntax.

403

No operation permissions.

404

No resources found.

500

An internal service error occurred. For details, see the error code description.

Error Codes

See Error Codes.