All Products
Search

This Product

    Data Management:GrantUserPermission

    Document Center

    Data Management:GrantUserPermission

    Last Updated:Aug 28, 2026

    Grants permissions on an instance, a database, or a table to a user.

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

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    The ID of the tenant.

    Note

    To view the tenant ID, 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***
    UserId

    string

    Yes

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

    Note

    The user ID is different from your Alibaba Cloud account ID.

    51****
    DsType

    string

    Yes

    The type of object for which to grant permissions. Valid values:

    • INSTANCE: permissions on instances

    • DATABASE: permissions on physical databases

    • LOGIC_DATABASE: permissions on logical databases

    • TABLE: permissions on physical tables

    • LOGIC_TABLE: permissions on logical tables

    DATABASE
    InstanceId

    integer

    No

    The instance ID. Required if you grant instance-level permissions. You can call the ListInstances or GetInstance operation to query the instance ID.

    174****
    DbId

    string

    No

    The database ID. You can call the ListDatabases operation to query a physical database ID and the ListLogicDatabases operation to query a logical database ID.

    Note

    The DatabaseId parameter uses the same value as DbId.

    1***
    Logic

    boolean

    No

    Whether the database is a logical database. Required if you grant database-level permissions. Valid values:

    • true: The database is a logical database.

    • false: The database is a physical database.

    false
    TableId

    string

    No

    The table ID. Required if you grant table-level permissions. You can call the ListTables operation to query the table ID.

    132***
    TableName

    string

    No

    The table name. Required if you grant table-level permissions.

    table_name
    PermTypes

    string

    Yes

    The permission type. Separate multiple permission types with commas (,). Valid values:

    • QUERY: the query permissions

    • EXPORT: the export permissions

    • CORRECT: the change permissions

    • LOGIN: the logon permissions

    • PERF: the query permissions on the performance details of the instance

    QUERY
    ExpireDate

    string

    Yes

    The permission expiration time.

    2021-12-12 00:00:00

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    A99CD576-1E18-4E86-931E-C3CCE56DC030
    ErrorCode

    string

    The error code.

    UnknownError
    ErrorMessage

    string

    The error message.

    UnknownError
    Success

    boolean

    Whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "A99CD576-1E18-4E86-931E-C3CCE56DC030",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.