Authorized User Retrieval for Databases via API Overview - Data Management - Alibaba Cloud - Data Management

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DbId	string	Yes	The database ID. The database can be a physical database or a logical database. To query the ID of a physical database, call the ListDatabases or SearchDatabase operation. To query the ID of a logical database, call the ListLogicDatabases or SearchDatabase operation.	135***
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.	poc_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. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Use this ID to locate logs and troubleshoot issues.	FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
Users	array<object>	The list of users that have permissions on the specified instance.
	object	The user details.
UserId	string	The user ID.	51****
UserNickName	string	The nickname of the user.	user_test
Uid	string	The UID of the user's Alibaba Cloud account.	164882191****

Examples

Success response

JSON format

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
  "Users": [
    {
      "UserId": "51****",
      "UserNickName": "user_test",
      "Uid": "164882191****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.