huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20240127

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"]},"ListConfigurationsResponseBody":{"properties":{"configurations":{"items":{"$ref":"#/definitions/ListConfigurationsResult"},"type":"array"},"count":{"description":"总记录数。","type":"integer"},"quota":{"description":"用户可创建的自定义参数模板最大数量。","type":"integer"}},"required":["configurations","count","quota"]},"ListConfigurationsResult":{"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"},"mode":{"description":"数据库实例类型。\nGeminiDB Cassandra集群类型为\"Cluster\"。\nGeminiDB Mongo副本集类型为\"ReplicaSet\"。\nGeminiDB Mongo集群类型为\"Sharding\"。\nGeminiDB Influx集群类型为\"Cluster\"。\nGeminiDB Influx单节点类型为\"InfluxdbSingle\"。\nGeminiDB Redis集群类型为“Cluster”。\nGeminiDB Redis主备类型为“Replication”。","type":"string"},"name":{"description":"参数模板名称。","type":"string"},"updated":{"description":"更新时间,格式为\"yyyy-MM-ddTHH:mm:ssZ\"。\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"},"user_defined":{"description":"是否是用户自定义参数模板:\n- false,表示为系统默认参数模板。\n- true,表示为用户自定义参数模板。","type":"boolean"}},"required":["id","name","datastore_version_name","datastore_name","created","updated","mode","user_defined"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"2eff1e506fa54e1a84d61cce3b19be00","info_version":"v3","method":"get","name":"ListConfigurationTemplates","parameters":{},"paths":{"/v3.1/{project_id}/configurations":{"get":{"description":"获取参数模板列表,包括所有数据库的默认参数模板和用户创建的参数模板。","operationId":"ListConfigurationTemplates","parameters":[{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"项目ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"索引位置,偏移量。\n  - 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。\n  - 取值必须为数字,不能为负数。","in":"query","name":"offset","type":"integer","x-example":0},{"description":"查询个数上限值。\n- 取值范围: 1~100。\n- 不传该参数时,默认查询前100条信息。","in":"query","name":"limit","type":"integer","x-example":100}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"configurations":[{"created":"2019-05-15T11:53:34+0000","datastore_name":"cassandra","datastore_version_name":"3.11","description":"configuration_test","id":"887ea0d1bb0843c49e8d8e5a09a95652pr06","mode":"Cluster","name":"configuration_test","updated":"2019-05-15T11:53:34+0000","user_defined":true},{"created":"2019-05-27T03:38:51+0000","datastore_name":"cassandra","datastore_version_name":"3.11","description":"Default parameter group for cassandra 3.11","id":"3bc1e9cc0d34404b9225ed7a58fb284epr06","mode":"Cluster","name":"Default-Cassandra-3.11","updated":"2019-05-27T03:38:51+0000","user_defined":false}],"count":2,"quota":100}},"schema":{"$ref":"#/definitions/ListConfigurationsResponseBody"}},"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","x-is-registered":"Y","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/configurations?offset=0&limit=10","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取参数模板列表","tags":"参数模板管理","uri":null,"version":"2.0"}