切換MongoDB實例的網絡類型。
接口說明
- 該接口適用于副本集實例和分片集群實例，暫不支持單節點實例。且僅支持經典網絡類型轉換至 VPC 網絡類型。
- 該接口僅支持 MongoDB 4.2 及以下版本的本地盤版實例。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dds:ModifyDBInstanceNetworkType | update |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
| ZoneId | string | 是 | 可用區 ID，您可以通過調用 DescribeRegions 接口查詢可用區 ID。 | cn-hangzhou-b |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "D0E605FD-6ECE-5FBE-84A4-99AAB1B8****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 500 | InstanceVpcAuthMode.NotSupported | Instance VpcAuthMode is NotSupported. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |