ListAuthorizedInstancesForUser - Data Management - Alibaba Cloud Documentation Center

Queries the instances on which the specified user has permissions.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListAuthorizedInstancesForUser	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user. 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 database 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 type of databases. 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 to return on each page.	20
Tid	long	No	The ID of the tenant. 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 parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	B7DB89CC-017D-5503-8953-38FFE241A618
Instances	array<object>	The list of instances on which the user has permissions.
instances	object	The instances on which the user has permissions.
InstanceId	string	The ID of the instance.	21****
Host	string	The endpoint that is used to connect to the instance.	rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com
Port	string	The port number that is used to connect to the instance.	3306
DbType	string	The database engine that the instance runs.	MySQL
UserId	string	The user IDs.	51****
UserName	string	The user name.	user_test
InstanceAlias	string	The alias of the instance.	DMS_TEST
EnvType	string	The type of the environment to which the database instance belongs.	product
PermissionDetail	object	The details of permissions. The format of the permission details varies with the permission source. For example, if the permission 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, the value of this parameter includes the policy name and the operations that are allowed for the user.

Examples

Sample success responses

JSONformat

{
  "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": ""
      }
    }
  ]
}

Error codes

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