All Products
Search
Document Center

Data Management:UpdateAuthorityTemplate

Last Updated:Nov 28, 2024

Modifies 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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:UpdateAuthorityTemplateupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdlongYes

The ID of the permission template.

1563
NamestringYes

The name of the permission template.

Note You must specify the Name or Description parameter. Otherwise, the API call fails.
Test template.
DescriptionstringYes

The description of the permission template.

Note You must specify the Name or Description parameter. Otherwise, the API call fails.
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.

4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
AuthorityTemplateViewobject

The details of the permission template.

TemplateIdlong

The ID of the permission template.

1563
CreatorIdlong

The ID of the user who created the permission template.

12***
Namestring

The name of the permission template.

Test template.
Descriptionstring

The description of the permission template.

This template is used for business testing.
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.

3***

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "AuthorityTemplateView": {
    "TemplateId": 1563,
    "CreatorId": 0,
    "Name": "Test template.\n",
    "Description": "This template is used for business testing.\n"
  },
  "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 changedView Change Details
2023-09-17The internal configuration of the API is changed, but the call is not affectedView Change Details