Call ListInstanceUserPermissions to query user permissions on an instance - Data Management - Alibaba Cloud - Data Management

Queries the permissions of a user on an instance.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover 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***
InstanceId	string	Yes	The ID of the instance. Call the ListInstances or GetInstance operation to query the instance ID.	174****
UserName	string	No	The nickname of the user. Call the ListUsers or GetUser operation to query the user nickname. Note The value of the NickName parameter is that of the UserName parameter.	test_nick_name
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The number of entries per page.	100

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of returned entries.	1
RequestId	string	The ID of the request.	7D162AAE-6501-5691-BF14-D7018F662895
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
UserPermissions	object
UserPermission	array<object>	The user permissions on the instance.
	array<object>
UserId	string	The ID of the user.	51****
UserNickName	string	The nickname of the user.	test_nick_name
InstanceId	string	The ID of the instance.	174****
PermDetails	object
PermDetail	array<object>	The permission details.
	object
OriginFrom	string	The user who granted the permissions.	XXX授权
PermType	string	The permission type. Valid values: LOGIN: the logon permissions PERF: the query permissions on the instance	LOGIN
ExpireDate	string	The time when the permissions expire.	2020-12-12 00:00:00
CreateDate	string	The time when the permissions were granted.	2019-12-12 00:00:00
UserAccessId	string	The ID of the authorization record.	773****
ExtraData	string	This parameter is reserved.	XXX
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "7D162AAE-6501-5691-BF14-D7018F662895",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "UserPermissions": {
    "UserPermission": [
      {
        "UserId": "51****",
        "UserNickName": "test_nick_name",
        "InstanceId": "174****",
        "PermDetails": {
          "PermDetail": [
            {
              "OriginFrom": "XXX授权",
              "PermType": "LOGIN",
              "ExpireDate": "2020-12-12 00:00:00",
              "CreateDate": "2019-12-12 00:00:00",
              "UserAccessId": "773****",
              "ExtraData": "XXX"
            }
          ]
        }
      }
    ]
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.