All Products
Search
Document Center

Data Management:CreateAuthorityTemplate

Last Updated:Apr 26, 2024

Creates a permission template

Operation description

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

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

The name of the permission template.

Test template.
DescriptionstringNo

The description of the permission template.

This template is used for business testing.
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
AuthorityTemplateViewobject

The details of the permission template.

TemplateIdlong

The ID of the permission template.

1563
Namestring

The name of the permission template.

Test template.
CreatorIdlong

The ID of the user who created the permission template.

12***
Descriptionstring

The description of the permission template.

This template is used for business testing.
CreateTimestring

The time when the permission template was created. The time is in the yyyy-MM-DD HH:mm:ss format.

2023-01-11 14:17:33
Successboolean

Indicates whether the request was successful. Valid values:

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

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

3***

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-10-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-09-17The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.