AI 助理
备案控制台
文档
输入文档关键字查找
首页 云数据库 MongoDB 版 开发参考 API参考指南 API目录 连接管理 AllocateNodePrivateNetworkAddress - 为云数据库分片集群实例节点申请内网连接地址

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

更新时间：
产品详情
相关技术圈
我的收藏

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

接口说明

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

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ZoneIdstring否

实例所属的可用区 ID。

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

分片集群实例 ID。

dds-bp1fa5efaa93****
NodeIdstring是

Shard 节点 ID 或 ConfigServer 节点 ID。

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

账户名。

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

    账户密码。

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    上一篇：ReleasePublicNetworkAddress - 释放实例公网地址下一篇：ReleaseNodePrivateNetworkAddress - 释放节点或节点内网连接地址
    文档推荐