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":{"CreateConfigurationDatastoreOption":{"description":"数据库对象。","properties":{"mode":{"description":"数据库部署模式,GeminiDB Mongo该参数必选。\n- GeminiDB Mongo 副本集实例取值为\"ReplicaSet\"。","type":"string"},"type":{"description":"数据库类型。\n- GeminiDB Cassandra实例取值为“cassandra”。\n- GeminiDB Mongo实例取值为\"mongodb\"。\n- GeminiDB Influx实例取值为\"influxdb\"。\n- GeminiDB Redis实例取值为\"redis\"。","type":"string"},"version":{"description":"数据库版本。\n- GeminiDB Cassandra实例支持3.11版本,取值为“3.11”。\n- GeminiDB Mongo实例支持4.0版本,取值为\"4.0\"。\n- GeminiDB Influx实例支持1.7版本,取值\"1.7\"。\n- GeminiDB Redis实例支持5.0版本,取值\"5.0\"。","type":"string"}},"required":["type","version"]},"CreateConfigurationRequestBody":{"properties":{"datastore":{"$ref":"#/definitions/CreateConfigurationDatastoreOption"},"description":{"description":"参数模板描述。最长256个字符,不支持>!<\"&'=特殊字符。默认为空。","type":"string"},"name":{"description":"参数模板名称。最长64个字符,只允许大写字母、小写字母、数字、和“-_.”特殊字符。","type":"string"},"values":{"additionalProperties":{"type":"string"},"description":"参数值对象,用户基于默认参数模板自定义的参数值。默认不修改参数值。","example":{"max_connections":"10"},"type":"object"}},"required":["name","datastore"]},"CreateConfigurationResponseBody":{"properties":{"configuration":{"$ref":"#/definitions/CreateConfigurationResult"}},"required":["configuration"]},"CreateConfigurationResult":{"description":"参数模板信息。","properties":{"created":{"description":"创建时间,格式为\"yyyy-MM-ddTHH:mm:ssZ\"。\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"},"datastore_name":{"description":"数据库名称。","type":"string"},"datastore_version_name":{"description":"数据库版本名称。","type":"string"},"description":{"description":"参数模板描述。","type":"string"},"id":{"description":"参数模板ID。","type":"string"},"name":{"description":"参数模板名称。","type":"string"},"updated":{"description":"更新时间,格式为\"yyyy-MM-ddTHH:mm:ssZ\"。\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"}},"required":["id","name","datastore_version_name","datastore_name","created","updated"]},"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"8e2b808fe22248738a09afdf0e08e984","info_version":"v3","method":"post","name":"CreateConfiguration","parameters":{},"paths":{"/v3/{project_id}/configurations":{"post":{"description":"创建参数模板。","operationId":"CreateConfiguration","parameters":[{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"请求体。","in":"body","name":"CreateConfigurationRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateConfigurationRequestBody"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"configuration":{"created":"2017-04-09T08:27:56+0800","datastore_name":"cassandra","datastore_version_name":"3.11","description":"configuration_test","id":"463b4b58d0e84e2b95605dea4552fdpr06","name":"configuration_test","updated":"2017-04-09T08:27:56+0800"}}},"schema":{"$ref":"#/definitions/CreateConfigurationResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"创建参数模板","tags":["参数模板管理"],"x-constraint":"该接口支持如下数据库实例:\n- GeminiDB Cassandra\n- GeminiDB Mongo\n- GeminiDB Influx\n- GeminiDB Redis\n- 创建参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复。\n- values只能传入系统定义的,可修改的参数,其他情况则忽略不处理。","x-is-registered":"N","x-request-examples-1":{"datastore":{"type":"cassandra","version":"3.11"},"description":"configuration_test","name":"configuration_test","values":{"autocommit":"OFF","max_connections":"10"}},"x-request-examples-description-1":"","x-request-examples-url-1":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建参数模板","tags":"参数模板管理","uri":null,"version":"2.0"}