Overview
You can call this API to modify the SSL link encryption configuration of an OceanBase cluster instance. You can enable, disable, or update the SSL certificate.
API details
Constraints
The caller must have an AccessKey for accessing APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/instances/{instanceId}/security/ssl
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster instance. |
Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| requestId | String | Yes | The request ID for tracking. |
Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| enableSSL | String | No | The SSL status. Valid values: OPEN (enable SSL encryption), CLOSE (update the certificate), and UPDATE (disable SSL encryption). |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | The SSL configuration data. |
| data.instanceId | String | The instance ID. |
| data.enableSSL | String | The modified SSL status. |
| requestId | String | The request ID. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
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"}'
Response example
JSON format
{
"data": {
"enableSSL": "CLOSE",
"instanceId": "ob6l4mko5n281s"
},
"requestId": "fa1286c6-df42-4234-9231-462bcbee1924",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}