文档首页/ 数据安全中心 DSC/ API参考/ API/ 策略模板管理/ 查询安全策略模板 - ShowSecurityPolicyTemplate
更新时间:2026-11-13 GMT+08:00
分享

查询安全策略模板 - ShowSecurityPolicyTemplate

功能介绍

功能介绍:分页查询安全策略模板列表,支持按类型和名称筛选,返回模板总数及列表。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/security-policies/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

参数解释:

策略模板类型

约束限制:

不涉及

取值范围:

  • GDE:加密策略

  • DDM:动脱策略

默认取值:

不涉及

name

否

String

参数解释:

策略模板名称,用于精确查询指定的策略模板

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

offset

否

Integer

参数解释:

偏移量,表示从该偏移量开始查询

约束限制:

不涉及

取值范围:

0-2147483647

默认取值:

0

limit

否

Integer

参数解释:

每页个数

约束限制:

不涉及

取值范围:

1-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Long

参数解释:

总记录数

取值范围:

不涉及

policy_template_list

Array of PolicyTemplate objects

参数解释:

策略模板列表

取值范围:

不涉及

表5 PolicyTemplate

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

安全策略模板名称

取值范围:

不涉及

type

String

参数解释:

策略模板类型,标识策略模板的类别

取值范围:

不涉及

config

PolicyTemplateConfig object

参数解释:

策略配置

取值范围:

不涉及

update_time

Long

参数解释:

策略模板的更新时间,为毫秒级Unix时间戳,表示策略模板最近一次更新的时间点

取值范围:

不涉及

instance_id

String

参数解释:

策略模板关联的实例ID,表示该策略模板所作用的数据实例

取值范围:

不涉及

表6 PolicyTemplateConfig

参数

参数类型

描述

security_level_id

String

参数解释:

策略模板配置ID

取值范围:

不涉及

security_level_name

String

参数解释:

安全等级名称

取值范围:

不涉及

color_number

Integer

参数解释:

颜色编号

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "total" : 1,
  "policy_template_list" : [ {
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "name" : "gde-policy-template-01",
    "type" : "GDE",
    "config" : {
      "security_level_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
      "security_level_name" : "高敏感",
      "color_number" : 1
    },
    "update_time" : 1700000600000,
    "instance_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档