ListAuthorizedDatabasesForUser API Overview - Data Management - Alibaba Cloud - Data Management

Queries the databases on which the specified user has permissions.

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:ListAuthorizedDatabasesForUser

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID. You can call the GetUser operation to obtain this ID.	51****
EnvType	string	No	The environment type of the database instance. Valid values: product: production environment. dev: development environment. pre: pre-release environment. test: test environment. sit: system integration testing (SIT) environment. uat: user acceptance testing (UAT) environment. pet: stress testing environment. stag: staging environment.	product
DbType	string	No	The type of databases. Valid values: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	MySQL
Logic	boolean	No	Whether the database is a logical database. Valid values: true.: The database is a logical database false: The database is a physical database.	false
SearchKey	string	No	The search keyword.	policy_test
PageNumber	string	No	The page number.	1
PageSize	string	No	The number of entries to return on each page.	20
Tid	integer	No	The ID of the tenant.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	012AE0B5-4B52-532F-BD7C-1EE9F182089B
Databases	array<object>	The databases on which the user has permissions.
	array<object>	The database information.
DbId	string	The database ID.	254****
SchemaName	string	The database name.	poc_testdb
SearchName	string	The name used to search for the database.	poc
InstanceId	string	The instance ID.	235****
Logic	boolean	Indicates whether the database is a logical database. Valid values: true.: The database is a logical database false: The database is a physical database.	false
DbType	string	The engine of the database.	MYSQL
UserId	string	The user ID.	51****
EnvType	string	The environment type of the database instance.	product
PermissionDetail	object	The permission details. The format varies by permission source. For example, if the source is a normal permission, the following parameters are returned.
DsType	string	The type of object on which the operation is performed.	DATABASE
PermType	string	The type of the permission. Valid values: QUERY: the query permission EXPORT: the data export permission CORRECT: the data change permission	CORRECT
ExpireDate	string	The time when the permission expires.	2024-12-06 10:00:00
Message	string	If the permission source is a permission policy, this parameter includes the policy name and the allowed operations.	权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery

Examples

Success response

JSON format

{
  "RequestId": "012AE0B5-4B52-532F-BD7C-1EE9F182089B",
  "Databases": [
    {
      "DbId": "254****",
      "SchemaName": "poc_testdb",
      "SearchName": "poc",
      "InstanceId": "235****",
      "Logic": false,
      "DbType": "MYSQL",
      "UserId": "51****",
      "EnvType": "product",
      "PermissionDetail": {
        "DsType": "DATABASE",
        "PermType": "CORRECT",
        "ExpireDate": "2024-12-06 10:00:00",
        "Message": "权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery"
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.