全部产品
Search
文档中心

数据管理 DMS:ListAuthorityTemplate - 获取权限模板列表

更新时间:Nov 28, 2024

调用ListAuthorityTemplate接口获取权限模板列表,包含模板创建者、模板名称、模板创建者及模板总数等信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
SearchKeystring

填入权限模板名称关键字。

测试模板
PageSizeinteger

每页显示权限模板的数目。取值如下:

  • 5
  • 10
  • 20
10
PageNumberinteger

第几页。

1
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenantListUserTenants 获取该参数的值。

3***

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID,用于定位日志,排查问题。

31853A2B-DC9D-5B39-8492-D2AC8BCF550E
ErrorCodestring

错误码,请求异常时返回。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
Successboolean

请求是否成功。返回值如下:

  • true:请求成功。
  • false:请求失败。
true
Tidlong

租户 ID。

3***
AuthorityTemplateViewListarray<object>

权限模板列表。

AuthorityTemplateViewobject
TemplateIdlong

权限模板 ID。

2592
CreatorIdlong

权限模板创建者 ID。

522****
Namestring

权限模板名称。

权限模板测试
Descriptionstring

权限模板描述信息。

该模板为测试使用。
CreateTimestring

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

2023-10-26 11:37:47
TotalCountlong

权限模板总数。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Tid": 0,
  "AuthorityTemplateViewList": {
    "AuthorityTemplateView": [
      {
        "TemplateId": 2592,
        "CreatorId": 0,
        "Name": "权限模板测试",
        "Description": "该模板为测试使用。",
        "CreateTime": "2023-10-26 11:37:47"
      }
    ]
  },
  "TotalCount": 10
}

错误码

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