全部产品
Search

搜索本产品

    数据管理 DMS：GetAuthorityTemplate - 获取权限模板详情

    文档中心

    数据管理 DMS：GetAuthorityTemplate - 获取权限模板详情

    更新时间：Nov 06, 2024

    获取权限模板详情。

    接口说明

    您在数据管理 DMS 中的系统角色为管理员或 DBA。查看系统角色的具体操作，请参见查看我的系统角色。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dms:GetAuthorityTemplateget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    TemplateIdlong是

    权限模板 ID。

    		1563
    Tidlong否

    租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。

    		3***

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    错误码。

    		UnknownError
    ErrorMessagestring

    错误信息。

    		UnknownError
    AuthorityTemplateViewobject

    权限模板的详细信息。

    TemplateIdlong

    权限模板 ID。

    		1563
    CreatorIdlong

    权限模板创建者 ID。

    		12***
    Namestring

    权限模板名称。

    		测试模板。
    Descriptionstring

    模板描述。

    		此模板用于业务测试。
    CreateTimestring

    权限模板的创建时间，时间格式为 yyyy-MM-DD HH:mm:ss。

    		2023-01-01 00:00:00
    AuthorityTemplateItemListarray<object>

    权限模板资源列表。

    AuthorityTemplateItemobject
    ItemIdlong

    资源 ID。

    		12***
    TemplateIdlong

    权限模板 ID。

    		1563
    ModifierIdlong

    资源修改者 ID。

    		51***
    ResourceTypestring

    资源类型。取值如下：

    • INSTANCE：实例。

    • LOGIC_DB：逻辑库。

    • META_DB：物理库。

    • LOGIC_TABLE：逻辑表。

    • SINGLE_TABLE：物理表。

    		INSTANCE
    InstanceIdlong

    实例 ID。

    		188****
    DbIdlong

    数据库 ID。

    		43***
    TableNamestring

    表名。

    		ExampleTable
    Attributestring

    其他补充信息。例如在该权限模板中，添加某个实例的登录权限。

    		"permissionTypes": [ "LOGIN" ]
    Successboolean

    请求是否成功，返回值如下：

    • true：请求成功
    • false：请求失败
    		true
    Tidlong

    租户 ID。

    说明 取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。
    		3***

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "AuthorityTemplateView": {
    "TemplateId": 1563,
    "CreatorId": 0,
    "Name": "测试模板。",
    "Description": "此模板用于业务测试。",
    "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
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-10-19OpenAPI 返回结构发生变更查看变更详情
    2023-09-20API 内部配置变更，不影响调用查看变更详情