All Products
Search
Document Center

Data Management:ListInstanceUserPermissions

Last Updated:Nov 28, 2024

Queries the permissions of a user on an instance.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListInstanceUserPermissionslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note To view the ID of the tenant, 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***
InstanceIdstringYes

The ID of the instance. You can call the ListInstances or GetInstance operation to query the ID of the instance.

174****
UserNamestringNo

The nickname of the user. You can call the ListUsers or GetUser operation to query the nickname of the user.

Note The value of the NickName parameter is that of the UserName parameter.
test_nick_name
PageNumberintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

100

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of returned entries.

1
RequestIdstring

The ID of the request.

7D162AAE-6501-5691-BF14-D7018F662895
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
UserPermissionsarray<object>

The permissions of the user on the instance.

UserPermissionobject
UserIdstring

The ID of the user.

51****
UserNickNamestring

The nickname of the user.

test_nick_name
InstanceIdstring

The ID of the instance.

174****
PermDetailsarray<object>

The details of permissions.

PermDetailobject
OriginFromstring

The user who grants the permissions.

xxx authorization
PermTypestring

The type of the permissions. Valid values:

  • LOGIN: the logon permissions
  • PERF: the query permissions on the instance
LOGIN
ExpireDatestring

The time when the permissions expire.

2020-12-12 00:00:00
CreateDatestring

The time when the permissions were granted.

2019-12-12 00:00:00
UserAccessIdstring

The ID of the authorization record.

773****
ExtraDatastring

This parameter is reserved.

XXX
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true

Examples

Sample success responses

JSONformat

{
  "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 authorization",
              "PermType": "LOGIN",
              "ExpireDate": "2020-12-12 00:00:00",
              "CreateDate": "2019-12-12 00:00:00",
              "UserAccessId": "773****",
              "ExtraData": "XXX"
            }
          ]
        }
      }
    ]
  },
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history