文档首页/ 智能体身份/ API参考/ API/ 策略集/ 查询策略集列表
更新时间:2026-11-04 GMT+08:00
分享

查询策略集列表

功能介绍

查询策略集列表。支持按类型过滤,可通过limit和marker参数控制返回结果的数量和起始位置。

URI

GET /v1/policy-engines

表1 Query参数

参数

是否必选

参数类型

描述

type

否

String

参数解释:

策略集类型,用于按类型过滤策略集。不指定时返回所有类型的策略集。

约束限制:

不涉及。

取值范围:

  • GATEWAY:用于网关的策略集,可绑定到网关实例。

  • TOKEN_VAULT:用于TokenVault的策略集,只能绑定到TokenVault实例。

默认取值:

不涉及。

limit

否

Integer

参数解释:

每页显示的条目数量,用于控制单次查询返回的工作负载身份数量。

约束限制:

不涉及。

取值范围:

1~200。

默认取值:

100。

marker

否

String

参数解释:

分页标记,用于指定查询的起始位置,配合limit使用。当返回结果中存在next_marker时,使用该值作为下一次请求的marker参数以获取下一页数据。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字及"+"、"/"、"="、"-"、"_"组成,长度为4~400个字符。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

policy_engines

Array of PolicyEngineSummary objects

参数解释:

策略集列表。为 Array of PolicyEngineSummary objects。

取值范围:

不涉及。

page_info

PageInfo object

参数解释:

分页信息,包含下一页标记和当前页返回条目数量。

取值范围:

不涉及。

表3 PolicyEngineSummary

参数

参数类型

描述

policy_engine_id

String

参数解释:

策略集ID,系统自动生成的唯一标识符。

取值范围:

只能由英文字母、数字及"-"、"_"组成,长度为12~59个字符。

name

String

参数解释:

策略集名称,由用户指定且不可变。

取值范围:

只能以英文字母开头,由英文字母、数字及"_"组成,长度为1~48个字符。

type

String

参数解释:

策略集类型,用于按类型过滤策略集。不指定时返回所有类型的策略集。

取值范围:

  • GATEWAY:用于网关的策略集,可绑定到网关实例。

  • TOKEN_VAULT:用于TokenVault的策略集,只能绑定到TokenVault实例。

urn

String

参数解释:

策略集的统一资源名称(URN)。

取值范围:

长度为1~1024个字符。

tags

Array of Tag objects

参数解释:

自定义标签列表。

取值范围:

不涉及。

created_at

String

参数解释:

UTC时间戳,记录资源的创建或更新时间。

取值范围:

使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-01-01T00:00:00Z。

updated_at

String

参数解释:

UTC时间戳,记录资源的创建或更新时间。

取值范围:

使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-01-01T00:00:00Z。

表4 Tag

参数

参数类型

描述

key

String

参数解释:

标签键,用于标识标签的名称。

取值范围:

可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合,长度为1~128个字符。

value

String

参数解释:

标签值,用于标识标签的具体内容。

取值范围:

可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"、"&"符号的任意组合,可以是空字符串,长度为0~255个字符。

表5 PageInfo

参数

参数类型

描述

next_marker

String

参数解释:

下一页标记,配合limit参数使用。如果存在,则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。

取值范围:

只能由英文字母、数字及"+"、"/"、"="、"-"、"_"组成。

current_count

Integer

参数解释:

本页返回的条目数量。

取值范围:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

加密后的认证失败信息,可以通过STS5解密接口进行解密。

取值范围:

不涉及。

请求示例

  • 查询策略集列表。

    GET https://{endpoint}/v1/policy-engines
  • 按类型过滤查询策略集列表。

    GET https://{endpoint}/v1/policy-engines?type=GATEWAY

响应示例

状态码:200

{
  "policy_engines" : [ {
    "policy_engine_id" : "285624f5-5958-4f36-b171-168303615bce",
    "name" : "my_policy_engine_1",
    "type" : "GATEWAY",
    "urn" : "agentIdentity:<region>:<account-id>:policyEngine:<policy-engine-id>",
    "tags" : [ {
      "key" : "environment",
      "value" : "production"
    } ],
    "created_at" : "2025-01-01 00:00:00",
    "updated_at" : "2025-01-02 00:00:00"
  }, {
    "policy_engine_id" : "385624f5-5958-4f36-b171-168303615bcg",
    "name" : "my_policy_engine_2",
    "type" : "TOKEN_VAULT",
    "urn" : "agentIdentity:<region>:<account-id>:policyEngine:<policy-engine-id>",
    "tags" : [ {
      "key" : "team",
      "value" : "platform"
    } ],
    "created_at" : "2025-01-01 00:00:00",
    "updated_at" : "2025-01-02 00:00:00"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : "marker"
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

错误码

请参见错误码。

相关文档