1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
查询资源基础权限。
查询云函数、云存储和数据库表的基础权限配置。支持单个资源查询和批量查询。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeResourcePermission。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| EnvId | 是 | String | 环境 ID 示例值:test-1gahsf0*** |
| ResourceType | 是 | String | 资源类型:function-云函数、storage-云存储、table-SQL型数据库表、collection-文档型数据库表 <br>示例值:table。示例值:table |
| Resources.N | 否 | Array of String | 资源标识列表。云函数不传或传空数组、云存储传存储桶名、数据库表传表名,不能超过100条。 示例值:["users"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeResourcePermissionResult | 查询资源权限返回结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量查询SQL型数据库表的基础权限
查询SQL型数据库表users的基础权限
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcePermission
<公共请求参数>
{
"EnvId": "**test-1gahsf0*********",
"ResourceType": "table",
"Resources": [
"users"
]
}
输出示例
{
"Response": {
"Data": {
"PermissionList": [
{
"Permission": "ADMINWRITE",
"Resource": "users",
"ResourceType": "table"
}
],
"TotalCount": 2
},
"RequestId": "b71b3f05-0735-4320-9ef2-40b888bc42d0"
}
}
示例2 批量查询云存储桶的基础权限
查询桶的基础权限
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcePermission
<公共请求参数>
{
"EnvId": "**test-1gahsf09********",
"ResourceType": "storage",
"Resources": [
"us***"
]
}
输出示例
{
"Response": {
"Data": {
"PermissionList": [
{
"Permission": "READONLY",
"Resource": "us***",
"ResourceType": "storage",
"SecurityRule": ""
}
],
"TotalCount": 1
},
"RequestId": "76cee3db-ce4e-4428-9de0-04e1d5d6c1b8"
}
}
示例3 批量查询文档型数据库表的基础权限
查询文档型数据库表testte的基础权限
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcePermission
<公共请求参数>
{
"EnvId": "**test-1gahsf0*********",
"ResourceType": "collection",
"Resources": [
"testte"
]
}
输出示例
{
"Response": {
"Data": {
"PermissionList": [
{
"Permission": "READONLY",
"Resource": "testte",
"ResourceType": "collection",
"SecurityRule": ""
}
],
"TotalCount": 1
},
"RequestId": "68c382a1-fb7a-4e43-b0f4-7f153c9c9bf2"
}
}
示例4 查询云函数的安全规则
查询云函数的安全规则
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcePermission
<公共请求参数>
{
"EnvId": "**test-1gahsf0*********",
"ResourceType": "function"
}
输出示例
{
"Response": {
"Data": {
"PermissionList": [
{
"Permission": "CUSTOM",
"Resource": "",
"ResourceType": "function",
"SecurityRule": "{\n \"*\": {\n \"invoke\": true }\n}"
}
],
"TotalCount": 1
},
"RequestId": "8b4c9ee3-152e-44a5-a97a-5afff7571a22"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ResourceNotExist | ResourceNotFound.ResourceNotExist |