機能の概要
OceanBase Cloudデータベースインスタンス内のテナントを作成する際に、現在選択可能な文字セットとそれぞれに対応する照合順序(Collation)のリストを照会します。このAPIは、指定されたテナントモード(MySQLまたはOracleなど)に基づいて対応する文字セット情報を返します。取得した情報は、テナント作成時の設定に利用できます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/tenants/charset
リクエストパラメータ
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID | d04eabba**** |
| tenantMode | String | はい | テナントモード。例:MySQLまたはOracle。 | MYSQL |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Array | 業務データ(object) | なし |
| data[].id | Integer | リソースの一意の識別子。 | 244 |
| data[].tenantMode | String | テナントモード。例:MySQLまたはOracle。 | MYSQL |
| data[].charset | String | 文字セット | utf8mb4 |
| data[].collations | Array | 照合順序のリスト。 | なし |
| data[].collations[] | String | 照合順序。 | なし |
| 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/charset?requestId=d04eabba****&tenantMode=MYSQL'
レスポンス例
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": [
{
"id": 244,
"tenantMode": "MYSQL",
"charset": "utf8mb4",
"collations": []
}
],
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": {}
}