Overview
This API modifies the SSL encryption configuration of an OceanBase Cloud database instance. You can enable or disable SSL connections, 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 |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | OceanBase cluster ID. | obcluster-***** |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID used for tracking. | d04eabba**** |
Body
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | No | OceanBase cluster ID. | obcluster-***** |
| enableSSL | String | No | SSL status. Valid values: OPEN (enable SSL encryption), CLOSE (disable SSL encryption), and UPDATE (update the certificate). | CLOSE |
| UID | String | No | User ID. | 20000600**** |
| User_ID | String | No | User ID. | 20000600**** |
| requestId | String | No | Request ID used for tracking. | dc302d76-66b5-48d8-ab53-a035******** |
| callerType | String | No | Caller type. | sub |
| accessKeyId | String | No | AccessKey ID. | ak-xxxxx**** |
| securityToken | String | No | Security token. | sts-token-xxxxxxxx |
| callerUid | String | No | Caller ID. | 20000600**** |
| callerBid | String | No | Caller BID. | xxxxxx |
| stsTokenCallerUid | String | No | STS token caller UID. | 20000600**** |
| stsTokenCallerBid | String | No | STS token caller BID. | xxxxxx |
| acceptLanguage | String | No | Language used in the request or response. | zh-CN |
| pageNumber | Integer | No | Page number. | 1 |
| pageSize | Integer | No | Page size. | 10 |
| mergedCallerBid | String | No | Merged caller business identity ID. | xxxxxx |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request succeeded. | true |
| errorCode | String | Error code. | INVALID_PARAMETER |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Business data returned as an object. | None |
| data.instanceId | String | OceanBase cluster ID. | obcluster-***** |
| data.enableSSL | String | Modified SSL status. | CLOSE |
| cost | Number | Time taken. | 1.0 |
| server | String | Server address, typically the IP address of an OBServer node. | 10.0.0.10 |
| requestId | String | Request ID. | d04eabba**** |
| totalCount | Number | Total number of records. | 100.0 |
| extra | Object | Additional information. | {} |
Examples
Request example
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"}'
Response example
JSON format
{
"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": "{}"
}