GetAuthorityTemplate - Data Management - Alibaba Cloud Documentation Center

Queries the information about a permission template.

Operation description

You must be a Data Management (DMS) administrator or a database administrator (DBA). For more information about how to view system roles, see View system roles.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetAuthorityTemplate	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	long	Yes	The ID of the permission template.	1563
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
AuthorityTemplateView	object	The details of the permission template.
TemplateId	long	The ID of the permission template.	1563
CreatorId	long	The ID of the user who created the permission template.	12***
Name	string	The name of the permission template.	TestTemplate
Description	string	The description of the permission template.	This template is used for business testing.
CreateTime	string	The time when the permission template was created. The time is in the yyyy-MM-DD HH:mm:ss format.	2023-01-01 00:00:00
AuthorityTemplateItemList	array<object>	The resource information in the permission template.
AuthorityTemplateItem	object
ItemId	long	The ID of the resource.	12***
TemplateId	long	The ID of the permission template.	1563
ModifierId	long	The ID of the user who modified the resource.	51***
ResourceType	string	The type of the resource. Valid values: INSTANCE: instance LOGIC_DB: logical database META_DB: physical database LOGIC_TABLE: logical table SINGLE_TABLE: physical table	INSTANCE
InstanceId	long	The ID of the instance.	188****
DbId	long	The ID of the database.	43***
TableName	string	The name of the table.	ExampleTable
Attribute	string	Other information. For example, you can add the logon permission on an instance to the permission template.	"permissionTypes": [ "LOGIN" ]
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Tid	long	The ID of the tenant.	3***

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "AuthorityTemplateView": {
    "TemplateId": 1563,
    "CreatorId": 0,
    "Name": "TestTemplate\n",
    "Description": "This template is used for business testing.\n",
    "CreateTime": "2023-01-01 00:00:00",
    "AuthorityTemplateItemList": {
      "AuthorityTemplateItem": [
        {
          "ItemId": 0,
          "TemplateId": 1563,
          "ModifierId": 0,
          "ResourceType": "INSTANCE",
          "InstanceId": 0,
          "DbId": 0,
          "TableName": "ExampleTable",
          "Attribute": "\"permissionTypes\": [\n            \"LOGIN\"\n          ]"
        }
      ]
    }
  },
  "Success": true,
  "Tid": 0
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-10-19	The response structure of the API has changed	View Change Details
2023-09-20	The internal configuration of the API is changed, but the call is not affected	View Change Details