DescribeDBPrivilegeByAccount

下载PDF

最后更新时间：2025-10-28 22:49:40

DescribeDBPrivilegeByAccount

最后更新时间： 2025-10-28 22:49:40

下载PDF

1. API Description

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

This API is used to query information on the databases and permissions associated with the account.

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: DescribeDBPrivilegeByAccount.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
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-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Instance ID, in the format of mssql-njj2mtpl.
AccountName	Yes	String	Account name.
DBName	No	String	Database name associated with the account.
Limit	No	Integer	The number of returned entries per page in pagination mode. Value range: 1-100. The default value is 20.
Offset	No	Integer	Page number in pagination mode. The default value is 0.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of databases.
DBList	Array of DBPrivilege	Database permission list.
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 Querying Information on the Databases and Permissions Associated with the Account

This example shows you how to query information on the databases and permissions associated with the account.

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeDBPrivilegeByAccount
&Limit=20
&Offset=0
&InstanceId=mssql-mz23h8n7
&AccountName=acc_test
&<Common request parameters>

Output Example

{
    "Response": {
        "DBList": [
            {
                "DBName": "db6_new",
                "Privilege": "DBOwner"
            },
            {
                "DBName": "db5_new",
                "Privilege": "ReadOnly"
            },
            {
                "DBName": "db4_new",
                "Privilege": "ReadWrite"
            },
            {
                "DBName": "db2_new",
                "Privilege": "ReadOnly"
            },
            {
                "DBName": "bigData",
                "Privilege": "DBOwner"
            }
        ],
        "RequestId": "0d8e4888-f464-11ed-8347-525400853186",
        "TotalCount": 5
    }
}

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
FailedOperation.DBError	Database error.
InternalError.GcsError	GCS API error.
ResourceNotFound.InstanceNotFound	The instance does not exist.
ResourceNotFound.ParamsNotFound	Parameter not found.
ResourceUnavailable.DBInvalidStatus	Invalid database status.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud