修改MongoDB執行個體的串連地址和連接埠。
介面說明
支援修改串連地址和連接埠的執行個體類型如下:
支援修改本地碟和雲端硬碟版執行個體的串連地址。
分區叢集僅支援修改 Mongos 節點的串連地址。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dds:ModifyDBInstanceConnectionString |
update |
*Instance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
| PortModifyOnly |
boolean |
否 |
||
| NetworkType |
string |
否 |
vpc |
|
| ForceModifySuffix |
boolean |
否 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
FF36A84C-0694-42D0-861D-C383E8E4FAAF |
| ModifiedConnectionString |
string |
樣本
正常返回樣本
JSON格式
{
"RequestId": "FF36A84C-0694-42D0-861D-C383E8E4FAAF",
"ModifiedConnectionString": ""
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | NewConnectionString.NotSupport | Specified newConnectionString is not supported. | newConnectionString 格式錯誤。 |
| 400 | InvalidConnectionStringOrPort.Duplicate | Specified connection string or port already exists. | 指明的串連串或port資訊已存在,請檢查後重新提交。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。