機能説明
クラスタインスタンスのSSL通信暗号化設定状態と証明書情報を照会するために使用されます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/security/ssl
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Object | SSL設定データ |
| data.autoUpdate | String | SSL証明書の自動更新状態。指定可能な値：OPEN、CLOSE |
| data.caUrl | String | CAルート証明書のダウンロードURL |
| data.certValid | Boolean | 証明書が有効かどうか |
| data.certificationType | String | 証明書の種類 |
| data.enableSSL | String | SSL状態。指定可能な値：OPEN、CLOSE |
| data.forceSSL | String | SSL接続の強制状態。指定可能な値：OPEN、CLOSE |
| data.forceSSLSupport | Boolean | SSL接続の強制がサポートされているかどうか |
| data.instanceId | String | インスタンスID |
| data.status | String | SSLステータス。選択可能な値：OPEN、CLOSE |
| data.validPeriod | String | SSL証明書の有効期間（UTC時刻） |
| requestId | String | リクエストID |
| success | Boolean | リクエストが成功したかどうか |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/ssl?requestId={requestId}'
レスポンス例
JSON 形式
{
"data": {
"autoUpdate": "OPEN",
"caUrl": "https://oceanbase-aliyun-docs.oss-cn-hangzhou.aliyuncs.com/mc_certification/OceanBase-CA.zip",
"certValid": true,
"certificationType": "SSL",
"enableSSL": "OPEN",
"forceSSL": "CLOSE",
"forceSSLSupport": true,
"instanceId": "obxxx",
"status": "OPEN",
"validPeriod": "2026-12-10T04:11:13Z"
},
"requestId": "99675121-1a0f-464f-b206-4b43905c67b7",
"success": true
}