機能の概要
OceanBase Cloudデータベースインスタンスで新しいテナントを作成する際に選択可能なタイムゾーンのリストを照会します。返される結果には、現在の環境のデフォルトタイムゾーンとサポートされているすべてのタイムゾーンオプションが含まれ、各オプションには説明情報が付随しています。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/tenants/timezone
リクエストパラメータ
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID | d04eabba**** |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | なし |
| data.default | String | 現在のリージョンとチャネル設定に基づくデフォルトタイムゾーン。実際の値はレスポンスを参照してください。 | — |
| data.list | Array | 利用可能なタイムゾーンのリスト。 | [{"timeZone":"Asia/Shanghai","description":"(UTC+08:00) Asia/Shanghai"}] |
| data.list[].timeZone | String | タイムゾーンのZone ID。 | Asia/Shanghai |
| data.list[].description | String | タイムゾーンの説明。現在の日付で計算されたUTCオフセットとZone IDを含む。オフセットは夏時間のルールによって変わる。 | (UTC+08:00) Asia/Shanghai |
| cost | Number | 処理時間 | 1.0 |
| server | String | サーバーアドレス。通常はOBServerノードのIPアドレス。 | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
例
リクエスト例
curl --digest -u '<AccessKey ID>:<AccessKey Secret>' -X GET 'https://api-cloud.oceanbase.com/api/v2/instances/tenants/timezone?requestId=d04eabba****' \
-H 'Content-Type: application/json'
レスポンス例
<現在の環境のデフォルトタイムゾーン> は、現在のリージョンとチャネル設定に応じた値を表すプレースホルダーです。APIが返す値そのものではありません。リストの項目からデフォルトタイムゾーンを推定することはできません。
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"default": "<現在の環境のデフォルトタイムゾーン>",
"list": [
{
"timeZone": "Asia/Shanghai",
"description": "(UTC+08:00) Asia/Shanghai"
}
]
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": {}
}