huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20251031

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"]},"UpdateClientNetworkRequestBody":{"properties":{"client_network_ranges":{"description":"客户端所在网段。\n\n- 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置,例如访问副本集的客户端所在网段为192.168.0.0/16,副本集所在的网段为172.16.0.0/24,则需要添加跨网段配置192.168.0.0/16才能正常访问。\n\n- 例如配置的源端网段为192.168.0.0/xx,则xx的输入值必须在8到32之间。\n\n- 源端ECS连接实例的前提是与实例节点网络通信正常,如果网络不通,可以参考对等连接进行相关配置。","items":{"type":"string"},"type":"array"}},"required":["client_network_ranges"],"type":"object"},"UpdateClientNetworkResponseBody":{"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":"c2d715be09ea419999fe92be7c62ea95","info_version":"v3","method":"post","name":"UpdateClientNetwork","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/client-network":{"post":{"description":"修改副本集跨网段访问配置","operationId":"UpdateClientNetwork","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"},{"description":"实例Id,可以调用[5.3.3 查询实例列表和详情](x-wc://file=zh-cn_topic_0000001397299481.xml)接口获取。如果未申请实例,可以调用[5.3.1 创建实例](x-wc://file=zh-cn_topic_0000001397139461.xml)接口创建。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"请求body体。","in":"body","name":"UpdateClientNetworkRequest","required":true,"schema":{"$ref":"#/definitions/UpdateClientNetworkRequestBody"}}],"responses":{"202":{"description":"Accepted","examples":{"application/json":{"job_id":"4008c8914b624785a02ab7966d4d"}},"schema":{"$ref":"#/definitions/UpdateClientNetworkResponseBody"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"修改副本集跨网段访问配置","tags":["实例管理"],"x-constraint":"该接口支持如下数据库实例。\n- GeminiDB Mongo副本集4.0\n\n实例处于异常或冻结状态下不支持该操作。","x-is-registered":"N","x-request-examples-1":{"client_network_ranges":["192.168.0.0/16"]},"x-request-examples-text-1":{"client_network_ranges":["192.168.0.0/16"]},"x-request-examples-url-1":"POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/9136fd2a9fcd405ea4674276ce36dae8in10/client-network","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"修改副本集跨网段访问配置","tags":"实例管理","uri":null,"version":"2.0"}