全部产品
Search
文档中心

云数据库 MongoDB:AllocateNodePrivateNetworkAddress - 为云数据库分片集群实例节点申请内网连接地址

更新时间:Jan 17, 2023

为云数据库MongoDB分片集群实例的Shard节点或ConfigServer节点申请内网连接地址。

接口说明

本接口仅适用于分片集群实例,更多详情请参见申请Shard/ConfigServer节点连接地址

说明 申请的连接地址仅支持通过内网访问,如需通过公网访问,请调用AllocatePublicNetworkAddress接口申请公网连接地址。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
ZoneId string

实例所属的可用区ID。

说明 您可以调用DescribeDBInstanceAttribute接口查询实例的可用区ID。
cn-hangzhou-b
DBInstanceId string

分片集群实例ID。

dds-bp1fa5efaa93****
NodeId string

Shard节点ID或ConfigServer节点ID。

说明 您可以调用DescribeDBInstanceAttribute接口查询Shard/ConfigServer节点ID。
d-bp124beeb0ac****
AccountName string

账户名。

说明
  • 以小写字母开头,长度为4~16位,由小写字母、数字或下划线组成。
  • 仅在首次申请Shard/ConfigServer地址时,需要设置账户名和账户密码。即所有Shard节点和ConfigServer节点都将使用首次申请地址时设置的账户和密码。
  • 该账户的权限固定为只读权限。
  • shardcsaccount
    AccountPassword string

    账户密码。

    • 密码由大写字母、小写字母、数字、特殊字符中的至少三种组成,特殊字符为!#$%^&*()_+-=
    • 密码长度为8-32位。
    Test123456

    返回参数

    名称 类型 描述 示例值
    object
    RequestId string

    请求ID。

    60EEBD77-227C-5B39-86EA-D89163C5****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****"
    }

    错误码

    Http code 错误码 错误信息 描述
    400 InvalidAccountName.Forbid Specified account name is a keyword. 账户名不正确,关键字不可用于账户名。请修改账户名。

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