tencent cloud

Feedback

DescribeAccountPrivileges

Last updated: 2023-08-23 14:23:11

1. API Description

Domain name for API request: cynosdb.tencentcloudapi.com.

This API is used to query the existing permissions of an 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: DescribeAccountPrivileges.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
AccountName Yes String Account name
Host Yes String Host
Db Yes String When the database name is “*”, the value specified in Type and TableName will be ignored, indicating that the user's global permissions are being modified.
Type Yes String Object type in a specified database. Valid values: table, *.
TableName No String The database name can be specified when Type is 'table'.

3. Output Parameters

Parameter Name Type Description
Privileges Array of String The list of permissions, such as ["select","update","delete","create","drop","references","index","alter","show_db","create_tmp_table","lock_tables","execute","create_view","show_view","create_routine","alter_routine","event","trigger"]
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the existing permissions of an account

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges&ClusterId=cynosdbmysql-xxxxxxxx&Host=xxx&AccountName=xxx&Db=xxx&Type=table&TableName=xx&<common request parameters>

Output Example

{
    "Response": {
        "Privileges": [
            "select",
            "update",
            "delete",
            "create",
            "drop",
            "references",
            "index",
            "alter",
            "show_db",
            "create_tmp_table",
            "lock_tables",
            "execute",
            "create_view",
            "show_view",
            "create_routine",
            "alter_routine",
            "event",
            "trigger"
        ],
        "RequestId": "167350"
    }
}

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

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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetSecurityGroupDetailFailed Failed to get the security group information.
InternalError.GetSubnetFailed Failed to get the subnet.
InternalError.GetVpcFailed Failed to get the VPC.
InternalError.ListInstanceFailed Failed to query instances by security group.
InternalError.OperateWanFail Public network operation failed.
InternalError.OperationNotSupport Unsupported operation.
InternalError.QueryDatabaseFailed Failed to query the database.
InternalError.SystemError Internal system error.
InvalidParameter.IsolateNotAllowed The current instance cannot be isolated.
InvalidParameterValue.AccountExist The account already exists.
InvalidParameterValue.AccountNotExistError The instance doesn’t have an account.
InvalidParameterValue.DBTypeNotFound Unsupported instance type.
InvalidParameterValue.FlowNotFound Taskflow ID doesn’t exist.
InvalidParameterValue.IllegalInstanceName The instance name contains invalid characters.
InvalidParameterValue.IllegalOrderBy Invalid sort by field.
InvalidParameterValue.IllegalPassword The password does not meet the requirement.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.InternalAccount The operation is not allowed for system account.
InvalidParameterValue.InvalidDBVersion Invalid instance version.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
InvalidParameterValue.InvalidSpec Invalid instance specification.
InvalidParameterValue.ParamError Incorrect parameter.
InvalidParameterValue.RegionZoneUnavailable The selected region and AZ are unavailable.
InvalidParameterValue.StoragePoolNotFound No related storage pool found.
InvalidParameterValue.SubnetNotFound The selected subnet could not be found.
InvalidParameterValue.VpcNotFound The selected VPC could not be found.
LimitExceeded.UserInstanceLimit The number of instances exceeds the limit.
OperationDenied.InstanceStatusDeniedError For the instance in this status, the operation is not allowed.
OperationDenied.ServerlessClusterStatusDenied For the serverless cluster in this status, the operation is not allowed.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceUnavailable.InstanceLockFail Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support