All Products
Search
Document Center

ApsaraDB for OceanBase:ModifyInstanceSSL

Last Updated:Sep 12, 2024

You can call this operation to modify the Secure Sockets Layer (SSL) setting for an OceanBase cluster instance.

Operation description

There is currently no authorization information disclosed in the API.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
EnableSSLstringYes

The operation to modify the SSL status. Valid values:

  • open: Enable SSL encryption.

  • update: Update the CA certificate.

  • close: Disable SSL encryption.

open

Response parameters

ParameterTypeDescriptionExample
object

The return result.

RequestIdstring

The ID of the request.

EE205C00-30E4-****-****-87E3A8A2AA0C
InstanceSSLobject

The SSL setting of the OceanBase cluster instance.

InstanceIdstring

The ID of the OceanBase cluster.

ob317v4uif****
EnableSSLstring

The operation to modify the SSL status. Valid values:

  • open: Enable SSL encryption.

  • update: Update the CA certificate.

  • close: Disable SSL encryption.

open

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "InstanceSSL": {
    "InstanceId": "ob317v4uif****",
    "EnableSSL": "open"
  }
}

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-06The Error code has changedView Change Details