云数据库 MongoDB 查询角色列表

1. 接口描述

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

获取角色列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceRoles。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例id 示例值：cmgo-********
Database	否	String	数据库名，为空则查询所有数据库的角色示例值：admin
RoleType.N	否	Array of String	角色类型：builtin_database-内置数据库角色，builtin_cluster-内置集群角色，custom-自定义角色，为空则查询所有示例值：["builtin_database"]
RoleName	否	String	角色名称，为空则查询所有角色示例值：test1
SearchKey	否	String	通用搜索关键字，模糊匹配继承角色和权限相关数据库名、角色名、Action名等示例值：t
OrderBy	否	String	排序字段，支持：RoleName，默认为 RoleName 示例值：RoleName
OrderType	否	String	排序方式：asc-升序，desc-降序，默认为 asc 示例值：desc
Offset	否	Integer	分页偏移量，默认为 0 示例值：0
Limit	否	Integer	每页数量，默认为 20，最大 100 示例值：10

3. 输出参数

参数名称	类型	描述
Total	Integer	总数示例值：0
Roles	Array of RoleInfo	角色列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询角色

输入示例

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

{
    "InstanceId": "cmgo-********",
    "Database": "admin",
    "RoleType": [
        "builtin_database"
    ],
    "RoleName": "test1",
    "SearchKey": "t",
    "OrderBy": "RoleName",
    "OrderType": "desc",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Roles": [],
        "Total": 0,
        "RequestId": "c746232b-75d3-4c34-aeef-60af9fd02ab6"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.NotFoundInstance	未找到实例。

查询角色列表

本页目录：