DescribeSystemTimezone

更新时间:
复制 MD 格式

Retrieves the system time zone of a StarRocks instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /webapi/timezone/query HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The ID of the instance.

c-b25e21e24388****

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code of the request.

200

RequestId

string

The ID of the request.

32A44F0D-BFF6-5664-999A-218BBDE74XXX

Success

boolean

Indicates whether the request succeeded.

false

ErrCode

string

The error code.

InvalidParams

ErrMessage

string

The error message.

Invalid params: [instance not exists].

Total

integer

The total number of instances.

100

Data

string

The returned data.

Asia/Shanghai

AccessDeniedDetail

string

Access denied details.

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE74XXX",
  "Success": false,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Total": 100,
  "Data": "Asia/Shanghai",
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.