All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeAccountAuthority

Last Updated:Mar 01, 2024

Queries the permissions of an account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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.

string

All databases.

db1,db2
TotalDictionariesarray

All dictionaries.

string

All dictionaries.

dt1,dt2
AllowDictionariesarray

Dictionaries to which permissions have been granted.

string

Dictionaries to which permissions have been granted.

dt1
AllowDatabasesarray

Databases to which permissions have been granted.

string

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
No change history