Enabling or Disabling SSL
Function
This API is used to enable or disable SSL.
Constraints
- This API supports the following types of instances:
- 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.
URI
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-option
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID of a user in a region. To obtain this value, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ssl_option |
Yes |
String |
Whether SSL is enabled. The value can be:
|
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Task ID. |
Example Requests
- Enabling SSL
- URI example
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
- Enabling SSL
{ "ssl_option" : "on" }
- URI example
- Disabling SSL
- URI example
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
- Disabling SSL
{ "ssl_option" : "off" }
- URI example
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot