1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
本接口(RunCommands)用于执行文档型数据库命令。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:RunCommands。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| MgoCommands.N | 是 | Array of MgoCommandParam | 待执行命令 |
| Tag | 否 | String | 实例ID 示例值:tnt-xxxx |
| EnvId | 否 | String | 环境id 示例值:lowcode-123 |
| MongoConnector | 否 | MongoConnector | Mongo连接器实例信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of String | 返回结果,返回结果为一个json字符串 注意:此字段可能返回 null,表示取不到有效值。 示例值:["string"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询一条数据
输入示例
https://tcb.tencentcloudapi.com/?Action=RunCommands
&Tag=tnt-nl7hjzasw
&MgoCommands.0.TableName=luke_test
&MgoCommands.0.CommandType=QUERY
&MgoCommands.0.Command={"find":"test","filter":{"_id":{"$eq":"1"}}}"}
&<公共请求参数>
输出示例
{
"Response": {
"Data": [
"[\"{\\\"_id\\\":\\\"1\\\",\\\"category\\\":\\\"Web\\\",\\\"tags\\\":[\\\"JavaScript\\\",\\\"C#\\\"],\\\"date\\\":{\\\"$date\\\":{\\\"$numberLong\\\":\\\"1572937669786\\\"}}}\"]"
],
"RequestId": "25785311-b03c-48d3-af34-36ff65e62d4a"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.Timeout | FailedOperation.Timeout |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidDoc | InvalidParameterValue.InvalidDoc |
| LimitExceeded.NoValidConnection | LimitExceeded.NoValidConnection |
| LimitExceeded.OutOfResultSizeLimit | 超过响应大小限制 |
| ResourceNotFound.Connector | 连接器未找到,请创建连接器或检查连接器参数是否正确 |
| ResourceNotFound.Table | 表未找到,请创建表或检查表名参数是否正确 |
| ResourceUnavailable.MongoIsolated | MongoDB集群已隔离,由于集群已被隔离写入被禁止,请跳转MongoDB控制台查看详情 |
| ResourceUnavailable.ResourceOverdue | 资源过期。 |