機能の概要
指定されたOceanBase Cloudデータベースインスタンス内の特定のテナント配下にあるデータベースの説明情報を変更します。データベースの識別と管理を容易にするために、説明を設定または更新できます。
呼び出しの詳細
APIの利用条件
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/databases/{databaseName}/databaseDescription
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
| databaseName | String | はい | データベース名 | test_db |
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID | d04eabba**** |
Body
リクエストボディは必須で、application/json形式を使用します。このインターフェースは上書き更新を実行します。空のオブジェクト{}を渡しても、元の説明は削除されます。
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| description | String | いいえ | データベースの説明。最大256文字。空でない文字列は元の説明を上書きし、空文字列は説明を削除します。このフィールドを省略したりnullを指定したりすると、説明は同様に削除されます(NULLに設定され、元の値は保持されません)。 | 業務取引データベース |
レスポンスパラメータ
フィールド |
タイプ |
説明 |
値の例 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | なし |
| data.requestId | String | リクエストID | d04eabba**** |
| data.description | 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 PUT 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/databases/{databaseName}/databaseDescription?requestId=d04eabba****' \
-H 'Content-Type: application/json' \
-d '{
"description": "業務取引データベース"
}'
データベースの説明をクリアする場合、リクエストボディを以下の内容に設定します:
{
"description": ""
}
レスポンス例
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"requestId": "d04eabba****",
"description": "業務取引データベース"
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": {}
}