1. 接口描述
接口请求域名： tdmysql.tencentcloudapi.com 。
本接口（DescribeUserPrivileges）提供查询用户的权限功能
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUserPrivileges。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID，形如：tdsql3-5baee8df。 示例值：tdsql3-5baee8df |
| Host | 是 | String | 用户允许的访问 host，用户名+host唯一确定一个账号。 示例值：localhost |
| UserName | 是 | String | 登录用户名。 示例值：mysql.sys |
| DbName | 是 | String | 数据库名。如果为 *，表示查询全局权限（即 *.*），此时忽略 Type 和 Object 参数 示例值：sys |
| Object | 否 | String | 具体的 Type 的名称，例如 Type 为 table 时就是具体的表名。DbName 和 Type 都为具体名称，则 Object 表示具体对象名，不能为 * 或者为空 示例值：sys_config |
| ObjectType | 否 | String | 类型,可以填入 table 、 view 、 proc 、 func 和 *。当 DbName 为具体数据库名，Type为 * 时，表示查询该数据库权限（即db.*），此时忽略 Object 参数 示例值：table |
| ColName | 否 | String | 当 Type=table 时，ColName 为 * 表示查询表的权限，如果为具体字段名，表示查询对应字段的权限 示例值：123 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Privileges | Array of String | 权限列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"SELECT"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserPrivileges
<公共请求参数>
{
"UserName": "qt4s_test",
"InstanceId": "tdsql3-0b2f04e0",
"Object": "sbtest10",
"Host": "%",
"DbName": "test",
"ObjectType": "table"
}输出示例
{
"Response": {
"Privileges": [],
"RequestId": "40b596e8-0b33-48ce-bd61-a2a5891a0920"
}
}示例2 123
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserPrivileges
<公共请求参数>
{
"UserName": "字符串",
"InstanceId": "tdsql3-267841d2",
"Object": "字符串",
"ColName": "字符串",
"Host": "%",
"DbName": "字符串",
"ObjectType": "字符串"
}输出示例
{
"Response": {
"Privileges": [],
"RequestId": "cae0499f-194e-4fec-a46a-9c42eaaeb753"
}
}示例3 321
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserPrivileges
<公共请求参数>
{
"UserName": "字符串",
"InstanceId": "tdsql3-267841d2",
"Object": "字符串",
"ColName": "字符串",
"Host": "%",
"DbName": "字符串",
"ObjectType": "字符串"
}输出示例
{
"Response": {
"Privileges": [],
"RequestId": "7ac86126-4006-43aa-9dad-267e2f5ff0d8"
}
}示例4 null
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserPrivileges
<公共请求参数>
{
"UserName": "qt4s_test",
"InstanceId": "tdsql3-789a2481",
"Host": "%",
"DbName": "test",
"ObjectType": "table"
}输出示例
{
"Response": {
"Privileges": null,
"RequestId": "949d8d5e-3622-4a81-9c47-7af93613eeb5"
}
}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.DBQueryPrivilegesError | 查询用户权限错误。 |
| InvalidParameterValue.CheckHostError | host校验失败。 |
| InvalidParameterValue.CheckNameError | 名称校验失败。 |
| OperationDenied.InstanceStatusError | 实例状态错误。 |
