创建账号

最近更新时间:2024-03-12 01:40:16

我的收藏

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口(CreateAccountUser)用于自定义实例访问账号。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAccountUser。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。例如:cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。
示例值:cmgo-7pjedvz7
UserName String 新账号名称。其格式要求如下:
  • 字符范围[1,32]。
  • 可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“”与短划线“-”。

示例值:mong
test
Password String 新账号密码。密码复杂度要求如下:
  • 字符长度范围[8,32]。
  • 至少包含字母、数字和特殊字符(叹号“!”、at"@"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。

示例值:abc123...
MongoUserPassword String mongouser 账号对应的密码。mongouser 为系统默认账号,即为创建实例时,设置的密码。
示例值:Abc123...
UserDesc String 账号备注信息。
示例值:测试账号
AuthRole.N Array of Auth 账号的读写权限信息。

3. 输出参数

参数名称 类型 描述
FlowId Integer 创建任务ID。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 自定义账号

自定义实例账号

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccountUser
<公共请求参数>

{
    "InstanceId": "cmgo-9d0p****",
    "UserName": "test_user",
    "Password": "Abc@123...",
    "MongoUserPassword": "Abc@123...",
    "UserDesc": "测试用户",
    "AuthRole": [
        {
            "Mask": 0,
            "NameSpace": "collection"
        }
    ]
}

输出示例

{
    "Response": {
        "FlowId": 1680767468,
        "RequestId": "1df930fb-eb7e-4e3f-bcab-15a1aa5fede0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.CheckAppIdFailed appId校验失败。
InternalError.PasswordError password与原先记录的password不同。
InvalidParameter 参数错误。
InvalidParameterValue.CheckAppIdFailed appId校验失败。