Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Enabling or Disabling SSL
Updated on 2025-11-27 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 types of 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 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ssl_option

Yes

String

Explanation:

Whether SSL is enabled

Constraints:

N/A

Values:

  • 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

Explanation:

Task ID.

Values:

N/A

Example Request

  • Enabling SSL
    • URI example 
      POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
    • Enabling SSL 
      { 
  "ssl_option" : "on" 
}
  • Disabling SSL
    • URI example 
      POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
    • Disabling SSL 
      { 
  "ssl_option" : "off" 
}

Example Response

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