huawei-cloud-api-definitions-GaussDB 0.1.20250124

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ModifyGaussMySqlProxyRouteModeRequestBody":{"description":"proxy实例修改路由模式请求体","properties":{"master_weight":{"description":"主节点权重:\n- 如果路由模式为0,取值为0~1000。\n- 如果路由模式为1,取值为0。\n- 如果路由模式为2,取值为1。","format":"int32","type":"integer","x-example":100},"new_node_auto_add_status":{"description":"是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy,请联系客服人员添加白名单,加入白名单后,方可输入该字段。\n\n取值范围:\n- ON:开启。\n- OFF:关闭。","type":"string"},"new_node_weight":{"description":"新增节点的读权重:\n  \n- 如果路由模式为0,新增节点自动加入为ON,取值为0~1000。\n- 如果路由模式不为0或新增节点自动加入为OFF,则可不输入读权重。\n- 如果路由模式不为0或新增节点自动加入为OFF,则可不输入读权重。","format":"int32","type":"integer"},"readonly_nodes":{"description":"只读节点权重配置信息。","items":{"$ref":"#/definitions/ModifyProxyRouteWeightReadonlyNode"},"type":"array"},"route_mode":{"description":"数据库代理路由模式。\n\n取值范围:\n- 0,表示权重负载模式。\n- 1,表示负载均衡模式(数据库主节点不接受读请求)。\n- 2,表示负载均衡模式(数据库主节点接受读请求)。","format":"int32","type":"integer"}},"required":["route_mode"]},"ModifyProxyRouteWeightReadonlyNode":{"description":"只读节点权重配置信息。","properties":{"id":{"description":"只读节点ID。","type":"string","x-example":"9f59e78322ac40c58385ab77c12ef84bno07"},"weight":{"description":"只读节点权重:\n- 如果路由模式为0,取值为0~1000;\n- 如果路由模式为1或2,取值为0或1。","format":"int32","type":"integer","x-example":100}},"required":["id","weight"]},"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]},"MysqlJobId":{"properties":{"job_id":{"description":"任务ID。","example":"6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc","type":"string"}},"required":["job_id"]}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"2d1a2077885a48988dc940f2334020e9","info_version":"v3","method":"put","name":"ModifyGaussMySqlProxyRouteMode","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/route-mode":{"put":{"description":"设置读写分离路由模式。","operationId":"ModifyGaussMySqlProxyRouteMode","parameters":[{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"语言。","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"租户在某一region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID,严格匹配UUID规则。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"61a4ea66210545909d74a05c27a7179ein07"},{"description":"数据库代理ID,严格匹配UUID规则。","in":"path","name":"proxy_id","required":true,"type":"string","x-example":"e87088f0b6a345e79db19d57c41fde15po01"},{"description":"请求体","in":"body","name":"ModifyGaussMySqlProxyRouteModeRequestBody","required":true,"schema":{"$ref":"#/definitions/ModifyGaussMySqlProxyRouteModeRequestBody"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"job_id":"04efe8e2-9255-44ae-a98b-d87c11411890"}},"schema":{"$ref":"#/definitions/MysqlJobId"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"设置读写分离路由模式","tags":["数据库代理"],"x-constraint":"该接口目前公测阶段,如需使用,请提交工单联系客服人员申请权限。","x-is-registered":"N","x-request-examples-1":{"master_weight":100,"readonly_nodes":{"id":"d23535333138462880bfa1838fdfced2no07","weight":200},"route_mode":0},"x-request-examples-2":{"master_weight":0,"readonly_nodes":{"id":"d23535333138462880bfa1838fdfced2no07","weight":1},"route_mode":1},"x-request-examples-3":{"master_weight":1,"readonly_nodes":{"id":"d23535333138462880bfa1838fdfced2no07","weight":0},"route_mode":2},"x-request-examples-description-1":"修改路由模式为0-权重负载模式","x-request-examples-description-2":"修改路由模式为1-负载均衡模式(数据库主节点不接受读请求)","x-request-examples-description-3":"修改路由模式为1-负载均衡模式(数据库主节点不接受读请求)","x-request-examples-url-1":"PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode","x-request-examples-url-2":"PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode","x-request-examples-url-3":"PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"设置读写分离路由模式","tags":"数据库代理","uri":null,"version":"2.0"}