修改MongoDB實例的連接地址和端口。
接口說明
支持修改連接地址和端口的實例類型如下：
- 支持修改本地盤和云盤版實例的連接地址。
- 分片集群僅支持修改 Mongos 節點的連接地址。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dds:ModifyDBInstanceConnectionString | update |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID。 說明
當本參數傳入的是分片集群實例 ID 時，還需要傳入 NodeId 參數。
| dds-bpxxxxxxxx |
| NodeId | string | 否 | 分片集群實例中的 Mongos 節點 ID，每次調用僅能傳入一個 Mongos 節點 ID。 說明
當 DBInstanceId 參數傳入的是分片集群實例 ID 時，本參數才可用。
| s-bpxxxxxxxx |
| CurrentConnectionString | string | 是 | 當前連接地址，即待修改的連接地址。 | s-bpxxxxxxxx.mongodb.rds.aliyuncs.com |
| NewConnectionString | string | 是 | 新的連接地址，要求如下：
說明
僅需傳入連接地址的前綴部分，前綴以外的部分不可修改。
| aliyuntest111 |
| NewPort | integer | 否 | 新的端口，端口范圍需要在 1000~65535 之間。 說明
當 DBInstanceId 參數傳入的是云盤實例 ID 時，本參數才可用。
| 3310 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "FF36A84C-0694-42D0-861D-C383E8E4FAAF"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | NewConnectionString.NotSupport | Specified newConnectionString is not supported. | - |
| 400 | MissingParameter | currentConnectionString is mandatory for this action. | - |
| 400 | InvalidConnectionStringOrPort.Duplicate | Specified connection string or port already exists. | 指明的連接串或port信息已存在，請檢查后重新提交。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-08 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-17 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-10-17 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-03-31 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |