huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20240113

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"SwitchSslRequestBody":{"properties":{"ssl_option":{"description":"ss开关选项。\n-“on”,表示NoSQL实例默认开启SSL连接。\n-“off”,表示NoSQL实例默认不启用SSL连接。","type":"string"}},"required":["ssl_option"],"type":"object"},"SwitchSslResponseBody":{"properties":{"job_id":{"description":"任务ID。","type":"string"}},"required":["job_id"],"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"95acb8d286f642bfaaab03231bce87d3","info_version":"v3","method":"post","name":"SwitchSsl","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/ssl-option":{"post":{"description":"切换实例SSL开关。","operationId":"SwitchSsl","parameters":[{"description":"用户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"用户token","in":"header","name":"x-auth-token","required":true,"type":"string"},{"description":"请求body体。","in":"body","name":"SwitchSslRequest","required":true,"schema":{"$ref":"#/definitions/SwitchSslRequestBody"}}],"responses":{"202":{"description":"Accepted","examples":{"application/json":{"job_id":"f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"}},"schema":{"$ref":"#/definitions/SwitchSslResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"切换实例SSL开关","tags":["实例管理"],"x-constraint":"该接口支持如下数据库实例。\n- GeminiDB Mongo副本集4.0\n- GeminiDB Influx\n- GeminiDB Redis\n\n冻结实例,异常实例不支持该操作。\n\n切换SSL后,后台会重启实例,请谨慎操作。","x-is-registered":"N","x-request-examples-1":{"ssl_option":"on"},"x-request-examples-2":{"ssl_option":"off"},"x-request-examples-description-1":"打开SSL开关","x-request-examples-description-2":"关闭SSL开关","x-request-examples-text-1":{"ssl_option":"on"},"x-request-examples-text-2":{"ssl_option":"off"},"x-request-examples-url-1":"POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option","x-request-examples-url-2":"POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"切换实例SSL开关","tags":"实例管理","uri":null,"version":"2.0"}