All Products
Search

This Product

    Data Management:AddAuthorityTemplateItems

    Document Center

    Data Management:AddAuthorityTemplateItems

    Last Updated:Aug 28, 2026

    Adds instances, databases, and tables to a specified permission template.

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

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TemplateId

    integer

    Yes

    The ID of the permission template. You can call the CreateAuthorityTemplate operation to obtain this ID.

    15***
    Items

    array<object>

    Yes

    The resources to add to the permission template.

    object

    No

    The resource details.

    InstanceId

    integer

    No

    The instance ID. You can call the ListInstances or GetInstance operation to obtain this ID.

    Note

    This parameter is required if the ResourceType parameter is set to INSTANCE.

    237****
    DbId

    integer

    No

    The database ID. A database can be either physical or logical.

    Note

    This parameter is required if the ResourceType parameter is set to META_DB, LOGIC_DB, META_TABLE, or LOGIC_TABLE.

    2478****
    TableName

    string

    No

    The table name. You can call the ListTables operation to obtain this name.

    Note

    This parameter is required if the ResourceType parameter is set to META_TABLE or LOGIC_TABLE.

    test_table
    ResourceType

    string

    Yes

    The type of resource to add. Valid values:

    • INSTANCE: instance

    • LOGIC_DB: logical database

    • META_DB: physical database

    • LOGIC_TABLE: logical table

    • LOGIC_TABLE: physical table

    INSTANCE
    PermissionTypes

    array

    No

    The permission types.

    string

    No

    The permission type. Valid values:

    • QUERY: the query permission

    • EXPORT: the data export permission

    • CORRECT: the data change permission

    • LOGIN: the logon permission

    • PERF: the performance query permission

    QUERY,CORRECT
    Tid

    integer

    No

    The tenant ID.

    Note

    To view the tenant ID, log on to the Data Management (DMS) console and hover over the profile icon 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 elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    3D3FB827-E667-50DB-AD59-C83F8237FECB
    ErrorCode

    string

    The error code returned if the request failed.

    UnknownError
    ErrorMessage

    string

    The error message returned if the request failed.

    UnknownError
    Data

    boolean

    Indicates whether the resources were added to the permission template.

    true
    Success

    boolean

    Indicates whether the request was successful.

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "3D3FB827-E667-50DB-AD59-C83F8237FECB",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Data": true,
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.