ListDatabaseUserPermssions - Data Management

Queries the permissions of users on a database.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListDatabaseUserPermssions	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	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	Specifies 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 parameters

Parameter	Type	Description	Example
	object
TotalCount	long	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	array<object>	The details of user permissions.
UserPermission	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	Indicates 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	array<object>	The details of user permissions.
PermDetail	object
OriginFrom	string	The description of the entity that authorizes the permission.	xxx grant
PermType	string	The type of the permission. Valid values: QUERY: the query permissions EXPORT: the export permissions CORRECT: the 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 that is used to search for the database.	xxx
Alias	string	The alias of the database instance.	instance_alias
Success	boolean	Indicates whether the request is successful.	true

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history