更新时间:2026-01-09 GMT+08:00

获取策略列表

功能介绍

获取策略列表

调用方法

请参见如何调用API。

URI

GET /v2/{domain_id}/tenant/rule-sets/query

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释:

租户ID,用户的domainId。

约束限制:

不涉及。

取值范围:

32位字符,由数字和字母组成。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释:

偏移量,表示从此偏移量开始查询。

约束限制:

不涉及。

取值范围:

offset大于等于0。

默认取值:

不涉及。

limit

是

Integer

参数解释:

每次查询的条目数量。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

不涉及。

include_tenant_rule_set

是

Boolean

参数解释:

是否包含租户级规则。

约束限制:

不涉及。

取值范围:

  • true:包含租户级规则。

  • false:不包含租户级规则。

默认取值:

不涉及。

name

否

String

参数解释:

策略名称,用于模糊查询。

约束限制:

策略名称仅支持中文、大小写英文字母、数字、‘-’、‘_’。

取值范围:

不超过128个字符。

默认取值:

不涉及。

is_valid

否

Boolean

参数解释:

策略是否有效。

约束限制:

不涉及。

取值范围:

  • true:策略有效。

  • false:策略无效。

默认取值:

不涉及。

type

否

String

参数解释:

策略类型。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cloud_project_id

否

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

32位字符,由数字和字母组成。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Array of RuleSet objects

参数解释:

规则实例列表。

取值范围:

不涉及。

total

Long

参数解释:

规则总数。

取值范围:

不涉及。

表5 RuleSet

参数

参数类型

描述

id

String

参数解释:

规则模板实例ID。

取值范围:

不涉及。

name

String

参数解释:

规则模板实例名称。

取值范围:

不涉及。

type

String

参数解释:

规则实例类型。

取值范围:

不涉及。

version

String

参数解释:

规则实例版本。

取值范围:

不涉及。

operator

String

参数解释:

规则实例最近操作人。

取值范围:

不涉及。

operate_time

Long

参数解释:

规则实例最近操作时间。

取值范围:

不涉及。

is_valid

Boolean

参数解释:

规则实例是否生效。

取值范围:

  • true:规则生效。

  • false:规则不生效。

level

String

参数解释:

规则实例生效级别。

取值范围:

不涉及。

is_public

Boolean

参数解释:

规则实例是否系统级。

取值范围:

  • true:规则实例是系统级。

  • false:规则实例不是系统级。

is_legacy

Boolean

参数解释:

规则实例是1.0的数据。

取值范围:

  • true:规则实例是1.0的数据。

  • false:规则实例不是1.0的数据。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/query?name=&limit=2&offset=1&cloud_project_id=

响应示例

状态码:200

OK

{
  "data" : [ {
    "id" : "30782f30c92e4c1dbc3c596075970d67",
    "name" : "DJtest创建租户级策略-apitest-rKaG",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "67e915e472554f719abe513c28728d9f",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1692695390000
  }, {
    "id" : "4f5fb96022974a2781174584f799d8c2",
    "name" : "DJtest创建租户级策略-apitest-S190",
    "level" : "tenant",
    "is_valid" : true,
    "version" : "61ebfef577c34406b5647ac1d83e7bb8",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1692695390000
  } ],
  "total" : 333
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。