ListPermissions

Download PDF

Last updated:2026-03-02 12:26:30

ListPermissions

Last updated: 2026-03-02 12:26:30

Download PDF

1. API Description

Domain name for API request: wedata.intl.tencentcloudapi.com.

Retrieve authorizable permission details.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ListPermissions.
Version	Yes	String	Common Params. The value used for this API: 2025-08-06.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-hongkong, ap-jakarta, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
Resource	No	PrivilegeResource	Resource. ResourceType: originates from the ResourceType returned by the GetGrantPrivilegesSTD API in the TCCATALOG module, and change to capitalize the first letter, such as METALAKE corresponding to METALAKE. ResourceUri depends on ResourceType. fixed as default for Metalake. use the three-segment format of catalog for other categories, such as. -Metalake, fixed as default. -Catalog. specifies the catalogName. -Schema. valid values: catalogName.SchemaName. -Table. specifies catalogName.SchemaName.TableName.
Filters.N	No	Array of SecurityFilter	Filtering conditions (this parameter is not supported).
OrderFields.N	No	Array of OrderField	Sorting field (this parameter is not supported).
Page	No	Page	Page parameter (this parameter is not supported).

3. Output Parameters

Parameter Name	Type	Description
Data	GetResourcePrivilegeDetailRsp	Obtain resource permission details. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 openapi Permission List

openapi permission list

Input Example

POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListPermissions
<Common request parameters>

{
    "Resource": {
        "ResourceType": "Catalog",
        "ResourceUri": "sa_tb"
    }
}

Output Example

{
    "Response": {
        "Data": {
            "Details": [
                {
                    "PermissionDetails": [
                        {
                            "CatalogID": "",
                            "CatalogName": "",
                            "Description": "",
                            "DisplayName": "use schema",
                            "Granted": false,
                            "Inherited": false,
                            "InheritedObject": {
                                "ResourceType": "Catalog",
                                "ResourceUri": "sa_tb"
                            },
                            "IsEdit": false,
                            "IsManage": false,
                            "IsMetaDataPermission": false,
                            "IsRead": false,
                            "Name": "USE_SCHEMA",
                            "WorkSpaceID": "",
                            "WorkSpaceName": ""
                        }
                    ],
                    "Resource": {
                        "ResourceType": "Catalog",
                        "ResourceUri": "sa_tb"
                    },
                    "SubjectDetails": [
                        {
                            "SubjectType": "User",
                            "SubjectTypeDisplayName": "User",
                            "SubjectValue": "700002285834",
                            "SubjectValueDisplayName": "linaszzhang"
                        }
                    ]
                }
            ],
            "TotalCount": 4
        },
        "RequestId": "3d9fc7dc-2155-4227-a7ec-456dc39d99f2"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InternalError.InvalidParameter	Missing required parameters or invalid parameters.
InvalidParameter	Parameter error.
InvalidParameter.InvalidParamsError	Illegal parameter.
InvalidParameterValue	Parameter value error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud