文档

ModifyDBInstanceDescription - 修改实例名称

修改MongoDB实例名称。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 如需修改分片集群实例中的 Shard 节点或 Mongos 节点的名称,还需要传入 NodeId 参数。
dds-bp2234****
NodeIdstring

分片集群实例中 Shard 节点 ID 或 Mongos 节点 ID。

说明 DBInstanceId 传入的是分片集群实例 ID 时,本参数才可用。
d-bp89067****
DBInstanceDescriptionstring

实例名称。

说明
  • 不能以http://https://开头。
  • 以中文、英文字母开头。
  • 可以包含中文、英文字符、下划线(_)、短划线(-)和数字,字符长度 2~256 个字符。
  • testdata

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    06F8F642-4009-4FFC-80C4-9D67DBF7B74E

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "06F8F642-4009-4FFC-80C4-9D67DBF7B74E"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidDBInstanceDescription.MalformedSpecified parameter DBInstanceDescription is not valid.节点名称不合法

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈