機能の概要
OceanBaseクラスタインスタンスのSSLリンク暗号化設定を変更するために使用され、SSL接続の有効化、無効化、またはSSL証書の更新をサポートします。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/security/ssl
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタインスタンスID |
Query
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます |
Body
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| enableSSL | String | いいえ | SSLステータス。オプション値：OPEN（SSL暗号化を有効にする）、CLOSE（証書を更新する）、UPDATE（SSL暗号化を無効にする）。 |
戻り結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Object | SSL設定データ |
| data.instanceId | String | インスタンスID |
| data.enableSSL | String | SSLステータスの変更 |
| requestId | String | リクエストID |
| success | Boolean | リクエストが成功したかどうか |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/ssl?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{"enableSSL":"CLOSE"}'
レスポンス例
JSON 形式
{
"data": {
"enableSSL": "CLOSE",
"instanceId": "ob6l4mko5n281s"
},
"requestId": "fa1286c6-df42-4234-9231-462bcbee1924",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}