ListDatabaseUserPermissions Overview - Data Management - Alibaba Cloud - Data Management

Queries user permissions on a specified database.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListDatabaseUserPermssions

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see Manage DMS tenants.	-1
PermType	string	Yes	The type of the permission. Valid values: DATABASE: permissions on databases TABLE: permissions on tables COLUMN: permissions on fields	DATABASE
DbId	string	Yes	The ID of the database.	123
Logic	boolean	No	Whether the database is a logical database.	false
UserName	string	No	The nickname of the user.	search_user_name
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The ID of the request.	68075D06-7406-4887-83A7-F558A4D28C13
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
UserPermissions	object
UserPermission	array<object>	The details of user permissions.
	array<object>
DbId	string	The ID of the database.	1234
TableName	string	The name of the table.	table_name
UserId	string	The ID of the user.	14324
SchemaName	string	The name of the database.	xxx@xxxx:3306
Logic	boolean	Whether the database is a logical database.	false
UserNickName	string	The nickname of the user.	user_nick_name
InstanceId	string	The ID of the instance.	1443
PermDetails	object
PermDetail	array<object>	The details of user permissions.
	object
OriginFrom	string	The description of the entity that authorizes the permission.	xxx grant
PermType	string	The type of the permission. Valid values: QUERY: query permissions EXPORT: export permissions CORRECT: change permissions	QUERY
ExpireDate	string	The time when the permissions expire.	2020-12-12 00:00:00
CreateDate	string	The time when the permission was created.	2019-12-12 00:00:00
UserAccessId	string	The ID of the authorization record.	13434
ExtraData	string	The extra information. This parameter is reserved.	DEFAULT
EnvType	string	The type of the environment to which the database belongs.	product
ColumnName	string	The name of a column.	column_name
DbType	string	The type of the database engine.	mysql
DsType	string	The type of resources on which the user has permissions.	DATABASE
TableId	string	The ID of the table.	42345
SearchName	string	The name used to search for the database.	xxx
Alias	string	The alias of the database instance.	instance_alias
Success	boolean	Whether the request is successful.	true

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "68075D06-7406-4887-83A7-F558A4D28C13",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "UserPermissions": {
    "UserPermission": [
      {
        "DbId": "1234",
        "TableName": "table_name",
        "UserId": "14324",
        "SchemaName": "xxx@xxxx:3306",
        "Logic": false,
        "UserNickName": "user_nick_name",
        "InstanceId": "1443",
        "PermDetails": {
          "PermDetail": [
            {
              "OriginFrom": "xxx grant",
              "PermType": "QUERY",
              "ExpireDate": "2020-12-12 00:00:00",
              "CreateDate": "2019-12-12 00:00:00",
              "UserAccessId": "13434",
              "ExtraData": "DEFAULT"
            }
          ]
        },
        "EnvType": "product",
        "ColumnName": "column_name",
        "DbType": "mysql",
        "DsType": "DATABASE",
        "TableId": "42345",
        "SearchName": "xxx",
        "Alias": "instance_alias"
      }
    ]
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.