文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 修改副本集跨网段访问配置
更新时间：2024-09-03 GMT+08:00
查看PDF
分享

修改副本集跨网段访问配置

功能介绍

修改副本集跨网段访问配置。

接口约束

该接口支持如下数据库实例。

  • GeminiDB Mongo

冻结实例，异常实例不支持该操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

client_network_ranges

是

Array of strings

客户端所在网段。

  • 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。
  • 例如配置的源端网段为192.168.0.0/xx，则xx的输入值必须在8到32之间。
  • 源端ECS连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

  • URI样例 
    POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/9136fd2a9fcd405ea4674276ce36dae8in10/client-network
  • 修改客户端所在网段为"192.168.0.0/16" 
    { 
  "client_network_ranges" : [ "192.168.0.0/16" ] 
}

响应示例

状态码： 202

Accepted

{ 
  "job_id" : "89638f5e-0780-497c-b3c0-4d0968383e19" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档