1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
创建数据库账号
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateInstanceUser。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例id 示例值:cmgo-**** |
| UserName | 是 | String | 用户名 示例值:testuser1 |
| Password | 否 | String | 密码 示例值:* |
| EncryptedPassword | 否 | String | 加密后的密码(与Password二选一) 示例值:o**DJ67kN52GK8oC49foA+rXHRLrL6t2N7*CiKTN/mGSkMfD |
| Database | 否 | String | 认证数据库(用户所属数据库) 示例值:admin |
| Roles.N | 否 | Array of Role | 角色列表(新方式,可包含内置角色和自定义角色) |
| AuthRole.N | 否 | Array of Auth | 权限列表(旧方式) |
| Description | 否 | String | 自定义描述 示例值:测试用 |
| EnablePasswordRotation | 否 | Integer | 是否开启密码轮转(0-不开启,1-开启) 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Integer | 异步任务ID 示例值:1750660112001309 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建用户
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstanceUser
<公共请求参数>
{
"InstanceId": "cmgo-********",
"UserName": "testuser1",
"Password": "*********",
"EncryptedPassword": "***o*****DJ67kN52GK8oC49foA**+rXHRLrL6t2N7***CiKTN/mGSkMfDIh7vSrArnyk3ccBpG***Q***SUP/6uGotJaRLmN**O*B*1b1f**Cd7cEg*G3d****W*****v*a*V*l1w**68*btB*U*jH*******+cRO**PEhB**fEUgJ*mW************SrsUf***xPpL8E*q2x4Lljb*m*****+VLJL*7**UfFz**YSX48+Co*dAO*******1/*hGeCf**09yV0gJHa+zyas4Arbrr*Y5tEG3Ox**fh***gIrBBeEx1ZY**VnFBRs+699JijqQRlnZcZTl5WH**w==",
"Database": "admin",
"Description": "测试用",
"EnablePasswordRotation": 0
}
输出示例
{
"Response": {
"FlowId": 1750660112001309,
"RequestId": "81b1c606-daa6-4778-aedf-84dc896469d2"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.NotFoundInstance | 未找到实例。 |