All Products
Search
Document Center

Data Management:GetAuthorityTemplateItem

Last Updated:Oct 21, 2024

Queries the resources in 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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdlongYes

The ID of the permission template.

1563
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.

5B96E35F-A58E-5399-9041-09CF9A1E46EA
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
AuthorityTemplateItemListarray<object>

The permission templates.

AuthorityTemplateItemobject
ItemIdlong

The ID of the resource.

12***
TemplateIdlong

The ID of the permission template.

1563
ModifierIdlong

The ID of the user who modifies the resource.

51***
ResourceTypestring

The type of the resource. Valid values:

  • INSTANCE: instance
  • LOGIC_DB: logical database
  • META_DB: physical database
  • LOGIC_TABLE: logical table
  • LOGIC_TABLE: physical table
INSTANCE
InstanceIdlong

The ID of the instance.

188****
DbIdlong

The ID of the database.

43***
TableNamestring

The name of the table.

ExampleTable
Attributestring

The additional information. For example, permissions to log on to an instance are added to the permission template.

"permissionTypes": [ "LOGIN" ]
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": "5B96E35F-A58E-5399-9041-09CF9A1E46EA",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "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 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