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"]},"ShrinkInstanceNodeRequestBody":{"properties":{"node_list":{"description":"指定缩容节点的ID,且该节点必须支持节点缩容。如果该字段不传指定缩减的节点ID,将根据系统内部策略缩减指定个数的节点。说明:\n- num与node_list必须有一个字段传值。\n  - 如果node_list传值时,GeminiDB Cassandra长度必须为1~10,GeminiDB Redis 长度必须为1。\n  - 如果num与node_list同时传值时,则以node_list的值为主。\n- 如果node_list取值为空时,缩容以随机节点缩容进行;node_list字段取值不为空,缩容以指定节点ID进行。\n- 节点缩容前,请避免直连节点,以防该节点缩容导致业务中断。","items":{"type":"string"},"type":"array"},"num":{"description":"随机缩减的节点数量。\n- GeminiDB Cassandra实例该字段取值为1~10。\n- GeminiDB Redis该字段取值为1。\n说明:\n如果客户端采用直连节点方式,不推荐使用随机节点缩容。","type":"integer"}}},"ShrinkInstanceNodeResponseBody":{"properties":{"job_id":{"description":"任务ID。","example":"6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc","type":"string"},"order_id":{"description":"订单ID,仅创建包年包月实例时返回该参数。","example":"CS20070721568OVO9","type":"string"}}}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"495974b9487d4f3980e7b74eca010d31","info_version":"v3","method":"post","name":"ShrinkInstanceNode","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/reduce-node":{"post":{"description":"缩容指定集群实例的节点数量。","operationId":"ShrinkInstanceNode","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":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"e73893ef73754465a8bd2e0857bbf13ein06"},{"description":"请求体。","in":"body","name":"EnlargeInstanceRequestBody","required":true,"schema":{"$ref":"#/definitions/ShrinkInstanceNodeRequestBody"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"job_id":"04efe8e2-9255-44ae-a98b-d87cae411890"}},"schema":{"$ref":"#/definitions/ShrinkInstanceNodeResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"缩容指定集群实例的节点数量","tags":["实例管理"],"x-constraint":"- 该接口支持如下数据库实例。\n  - GeminiDB Cassandra包年/包月实例和按需计费实例\n  - GeminiDB Redis按需计费实例\n- GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关,如果目标结果无法满足实例运行所需的磁盘大小,将无法缩容节点。\nGeminiDB Redis主备版实例不支持节点扩容。","x-is-registered":"N","x-request-examples-1":{"num":1},"x-request-examples-description-1":"缩容cassandra节点数量:","x-request-examples-url-1":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein06/reduce-node","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"缩容指定集群实例的节点数量","tags":"实例管理","uri":null,"version":"2.0"}