機能の概要
OceanBase CloudデータベースインスタンスのSSL暗号化設定を変更します。SSL接続の有効化、無効化、またはSSL証明書の更新に対応しています。
呼び出しの説明
APIの制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/instances/{instanceId}/security/ssl
リクエストパラメータ
Path
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | 追跡用のリクエストID | d04eabba**** |
Body
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | いいえ | OceanBaseクラスタID | obcluster-***** |
| enableSSL | String | いいえ | SSLステータス。指定可能な値：OPEN（SSL暗号化を有効にする）、CLOSE（SSL暗号化を無効にする）、UPDATE（証明書を更新する）。 | CLOSE |
| UID | String | いいえ | ユーザーID。 | 20000600**** |
| User_ID | String | いいえ | ユーザーID | 20000600**** |
| requestId | String | いいえ | 追跡用のリクエストID | dc302d76-66b5-48d8-ab53-a035******** |
| callerType | String | いいえ | 呼び出し元のタイプ | sub |
| accessKeyId | String | いいえ | アクセスキーID | ak-xxxxx**** |
| securityToken | String | いいえ | セキュリティトークン | sts-token-xxxxxxxx |
| callerUid | String | いいえ | 呼び出し元のID | 20000600**** |
| callerBid | String | いいえ | 呼び出し元のBID | xxxxxx |
| stsTokenCallerUid | String | いいえ | STSトークンの呼び出し元UID | 20000600**** |
| stsTokenCallerBid | String | いいえ | STSトークンの呼び出し元BID | xxxxxx |
| acceptLanguage | String | いいえ | リクエストまたはレスポンスで使用する言語。 | zh-CN |
| pageNumber | Integer | いいえ | ページ番号 | 1 |
| pageSize | Integer | いいえ | ページサイズ | 10 |
| mergedCallerBid | String | いいえ | 統合後の呼び出し元のビジネス識別ID。 | xxxxxx |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | なし |
| data.instanceId | String | OceanBaseクラスタID | obcluster-***** |
| data.enableSSL | String | SSLステータスの変更 | CLOSE |
| 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 '<Your AccessKey ID:AccessKey Secret>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/ssl?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{"enableSSL":"CLOSE"}'
レスポンス例
JSON形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"instanceId": "obcluster-*****",
"enableSSL": "CLOSE"
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}