ListAuthorizedInstancesForUser API Overview - Data Management - Alibaba Cloud - Data Management

Queries the instances on which a 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:ListAuthorizedInstancesForUser

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID. You can call the GetUser operation to query the user ID. Note If IdentityType is set to USER, this parameter is required.	51****
EnvType	string	No	The type of the environment in which the instance is deployed. 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 database type. Valid values: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	MySQL
SearchKey	string	No	The search keyword.	policy_test
PageNumber	string	No	The page number.	1
PageSize	string	No	The number of entries per page.	20
Tid	integer	No	The tenant ID. Note To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. 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, which you can use to query logs and troubleshoot issues.	B7DB89CC-017D-5503-8953-38FFE241A618
Instances	array<object>	The list of instances on which the user has permissions.
	array<object>	The information about each instance.
InstanceId	string	The instance ID.	21****
Host	string	The endpoint used to connect to the instance.	rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com
Port	string	The port number used to connect to the instance.	3306
DbType	string	The database engine that the instance runs.	MySQL
UserId	string	The user ID.	51****
UserName	string	The username.	user_test
InstanceAlias	string	The instance alias.	DMS_TEST
EnvType	string	The environment type of the instance.	product
PermissionDetail	object	The permission details. The format varies by permission source. For example, if the permission source is a normal permission, the following parameters are returned.
DsType	string	The type of the object on which the operation is performed.	DATABASE
PermType	string	The permission type. Valid values: QUERY: the query permission EXPORT: the data export permission CORRECT: the data change permission	CORRECT
ExpireDate	string	The permission expiration time.	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": "B7DB89CC-017D-5503-8953-38FFE241A618",
  "Instances": [
    {
      "InstanceId": "21****",
      "Host": "rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com",
      "Port": "3306",
      "DbType": "MySQL",
      "UserId": "51****",
      "UserName": "user_test",
      "InstanceAlias": "DMS_TEST",
      "EnvType": "product",
      "PermissionDetail": {
        "DsType": "DATABASE",
        "PermType": "CORRECT",
        "ExpireDate": "2024-12-06 10:00:00\n",
        "Message": "权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery"
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.