Help Center/ GeminiDB/ API Reference/ API v3/ Instances/ Enabling or Disabling SSL
Updated on 2026-09-22 GMT+08:00
View PDF
Share

Enabling or Disabling SSL

Function

This API is used to enable or disable SSL.

Constraints

  • This API supports the following instances:
    • GeminiDB Cassandra
    • GeminiDB Mongo
    • GeminiDB Influx
    • GeminiDB Redis
  • Enabling or disabling SSL is not supported for frozen or abnormal instances.
  • The instance will be restarted after SSL is enabled or disabled on it. Exercise caution when you enable or disable SSL.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:switchSSL

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:switchSSL

    -

URI

POST /v3/{project_id}/instances/{instance_id}/ssl-option

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ssl_option

Yes

String

Definition

Whether SSL is enabled

Constraints

N/A

Range

  • on: SSL is enabled by default.
  • off: SSL is disabled by default.

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Example Requests

  • Enabling SSL 
    POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 

{ 
  "ssl_option" : "on" 
}
  • Disabling SSL 
    POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 

{ 
  "ssl_option" : "off" 
}

Example Responses

Status code: 202

Accepted

{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances