All Products
Search
Document Center

Data Management:RevokeUserPermission

Last Updated:Apr 26, 2024

Revokes the permissions on instances, databases, and tables from a user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:RevokeUserPermissionRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

3***
UserIdstringYes

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

51****
DsTypestringYes

The object type on which the permission you want to revoke from the user. Valid values:

  • INSTANCE: database instances
  • DATABASE: physical databases
  • LOGIC_DATABASE: logical databases
  • TABLE: physical tables
  • LOGIC_TABLE: logical tables
DATABASE
InstanceIdlongNo

The ID of the database instance. You must specify this parameter when you revoke a permission from the database instance. You can call the ListInstances or GetInstance operation to query the database instance ID.

174****
DbIdstringYes

The ID of the database. The database can be a physical database or a logical database.

1860****
LogicbooleanNo

Specifies whether the database is a logical database. Valid values:

  • true: The database is a logical database.
  • false: The database is a physical database.
Note
  • If the database is a logical database, set this parameter to true.
  • If the database is a physical database, set this parameter to false.
  • false
    TableIdstringNo

    The ID of the table. You must specify this parameter when you revoke a permission from the table. You can call the ListTables operation to query the table ID.

    13****
    TableNamestringNo

    The name of the table. You can call the ListTables operation to query the table name.

    table_name
    PermTypesstringYes

    The type of the permission. Valid values:

    • QUERY: the data query permission
    • EXPORT: the data export permission
    • CORRECT: the data change permission
    CORRECT
    UserAccessIdstringYes

    The ID of the permission. You can call the ListUserPermission operation to query the permission ID.

    774****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    A99CD576-1E18-4E86-931E-C3CCE56D****
    ErrorCodestring

    The error code returned.

    MissingUserId
    ErrorMessagestring

    The error message returned.

    UserId is mandatory for this action.
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    true

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "A99CD576-1E18-4E86-931E-C3CCE56D****",
      "ErrorCode": "MissingUserId",
      "ErrorMessage": "UserId is mandatory for this action.",
      "Success": true
    }

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history