All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeAccountAuthority

Last Updated:Nov 12, 2024

Queries the permissions of an account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeAccountAuthorityget
  • DBCluster
    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBClusterIdstringYes

The cluster ID.

cc-bp1p816075e21****
AccountNamestringYes

The name of the database account.

test

Response parameters

ParameterTypeDescriptionExample
object
DdlAuthorityboolean

Indicates whether the database account has DDL permissions. Valid values:

  • true: has DDL permissions.
  • false: does not have DDL permissions.
true
DmlAuthoritystring

Indicates whether the database account has DML permissions. Valid values:

  • all
  • readOnly,modify
all
RequestIdstring

The request ID.

F5178C10-1407-4987-9133-DE4DC9119F75
TotalDatabasesarray

All databases.

TotalDatabasesstring

All databases.

db1,db2
TotalDictionariesarray

All dictionaries.

TotalDictionariesstring

All dictionaries.

dt1,dt2
AllowDictionariesarray

Dictionaries to which permissions have been granted.

AllowDictionariesstring

Dictionaries to which permissions have been granted.

dt1
AllowDatabasesarray

Databases to which permissions have been granted.

AllowDatabasesstring

Databases to which permissions have been granted.

db1
AccountNamestring

The name of the database account.

test

Examples

Sample success responses

JSONformat

{
  "DdlAuthority": true,
  "DmlAuthority": "all",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "TotalDatabases": [
    "db1,db2"
  ],
  "TotalDictionaries": [
    "dt1,dt2"
  ],
  "AllowDictionaries": [
    "dt1"
  ],
  "AllowDatabases": [
    "db1"
  ],
  "AccountName": "test"
}

Error codes

HTTP status codeError codeError messageDescription
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.
503ServiceUnavailableAn error occurred while processing your request.An error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-25API Description Update. The Error code has changedView Change Details