Call the CreateAuthorityTemplate API to create a permission template - Data Management - Alibaba Cloud - Data Management

Operation description

Requires the DBA or administrator system role in Data Management (DMS). For more information about system roles, see View system roles.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the permission template.	test_template.
Description	string	No	The description of the permission template.	This template is used for testing.
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
AuthorityTemplateView	object	The details of the permission template.
TemplateId	integer	The ID of the permission template.	1563
Name	string	The name of the permission template.	test_template.
CreatorId	integer	The user ID of the template creator.	12***
Description	string	The description of the permission template.	This template is used for testing.
CreateTime	string	The time when the permission template was created, in the yyyy-MM-DD HH:mm:ss format.	2023-01-11 14:17:33
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Tid	integer	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "AuthorityTemplateView": {
    "TemplateId": 1563,
    "Name": "test_template.",
    "CreatorId": 0,
    "Description": "This template is used for testing.",
    "CreateTime": "2023-01-11 14:17:33"
  },
  "Success": true,
  "Tid": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.