Overview
You can call this API to query the SSL configuration of an instance.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET api/v2/instances/{instanceId}/security/ssl
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | The SSL configuration. |
| data.autoUpdate | String | The automatic update status of the SSL certificate. Valid values: OPEN and CLOSE. |
| data.caUrl | String | The download URL of the CA root certificate. |
| data.certValid | Boolean | Indicates whether the certificate is valid. |
| data.certificationType | String | The type of the certificate. |
| data.enableSSL | String | The SSL status. Valid values: OPEN and CLOSE. |
| data.forceSSL | String | The forced SSL connection status. Valid values: OPEN and CLOSE. |
| data.forceSSLSupport | Boolean | Indicates whether to enable forced SSL connections. |
| data.instanceId | String | The ID of the instance. |
| data.status | String | The SSL status. Valid values: OPEN and CLOSE. |
| data.validPeriod | String | The validity period of the SSL certificate (UTC time). |
| requestId | String | The ID of the request. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/ssl'
Response example
JSON format
{
"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
}