文档

ModifyDBInstanceConnectionString - 修改实例的连接地址和端口

修改MongoDB实例的连接地址。

接口说明

支持修改连接地址和端口的实例类型如下:

  • 支持修改本地盘和云盘版实例的连接地址。
  • 仅支持修改云盘版实例的端口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:ModifyDBInstanceConnectionStringWrite
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 当本参数传入的是分片集群实例 ID 时,还需要传入 NodeId 参数。
dds-bpxxxxxxxx
NodeIdstring

分片集群实例中的 Mongos 节点 ID,每次调用仅能传入一个 Mongos 节点 ID。

说明 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数才可用。
s-bpxxxxxxxx
CurrentConnectionStringstring

当前连接地址,即待修改的连接地址。

s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NewConnectionStringstring

新的连接地址,以小写字母开头,由字母、数字组成,长度为 8~64 个字符。

说明 仅需传入连接地址的前缀部分,前缀以外的部分不可修改。
aliyuntest111
NewPortinteger

新的端口,端口范围需要在 1000~65535 之间。

说明 DBInstanceId 参数传入的是云盘实例 ID 时,本参数才可用。
3310

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

FF36A84C-0694-42D0-861D-C383E8E4FAAF

示例

正常返回示例

JSON格式

{
  "RequestId": "FF36A84C-0694-42D0-861D-C383E8E4FAAF"
}

错误码

HTTP status code错误码错误信息
400NewConnectionString.NotSupportSpecified newConnectionString is not supported.
400MissingParametercurrentConnectionString is mandatory for this action.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:Category
2023-10-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Category
2023-03-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:NewPort
  • 本页导读 (1)
文档反馈