切换MongoDB实例的网络类型。
接口说明
该接口适用于副本集实例和分片集群实例,暂不支持单节点实例。且仅支持经典网络类型转换至VPC网络类型。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:ModifyDBInstanceNetworkType | WRITE |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。 |
dds-bp11483712c1**** |
NetworkType | string | 是 |
实例要切换的目标网络类型,取值说明:
|
VPC |
VpcId | string | 否 |
专有网络ID。
说明
当NetworkType参数配置为VPC时,需要配置该参数。
|
vpc-bp1n3i15v90el48nx**** |
VSwitchId | string | 否 |
专有网络中的交换机ID。
说明
当NetworkType参数配置为VPC时,需要配置该参数。
|
vsw-bp1vj604nj5a9zz74**** |
RetainClassic | string | 否 |
切换网络类型为VPC时,设置是否保留原经典网络地址,取值说明:
说明
|
False |
ClassicExpiredDays | integer | 否 |
切换网络类型为VPC时,设置保留原经典网络地址的时长。取值为14、30、60、120,单位为天。
说明
当NetworkType参数配置为VPC且RetainClassic参数配置为True时,需要配置该参数。
|
30 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D0E605FD-6ECE-5FBE-84A4-99AAB1B8****"
}
错误码
Http code | 错误码 | 错误信息 |
---|---|---|
500 | InstanceVpcAuthMode.NotSupported | Instance VpcAuthMode is NotSupported. |
访问错误中心查看更多错误码。