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

查询策略集关联的实体列表

功能介绍

查询指定策略集关联的实体(网关和令牌保管库)列表。支持分页查询,可通过limit和marker参数控制返回结果的数量和起始位置。

URI

GET /v1/policy-engines/{policy_engine_id}/attachments

表1 路径参数

参数

是否必选

参数类型

描述

policy_engine_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1~200。

默认取值:

100。

marker

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

attachments

Array of PolicyEngineAttachmentSummary objects

参数解释:

策略集关联列表。

取值范围:

不涉及。

page_info

PageInfo object

参数解释:

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

取值范围:

不涉及。

表4 PolicyEngineAttachmentSummary

参数

参数类型

描述

entity_type

String

参数解释:

可关联到策略集的实体类型。

取值范围:

  • GATEWAY:网关

  • TOKEN_VAULT:Token Vault

entity_id

String

参数解释:

关联实体的唯一标识符。

取值范围:

不涉及。

mode

String

参数解释:

策略集的强制模式。LOG_ONLY模式下策略集会根据策略评估每个操作并记录是否允许或拒绝的跟踪,但不强制执行决策。ENFORCE模式下策略集会根据策略评估操作并通过允许或拒绝来强制执行决策。

取值范围:

  • LOG_ONLY:仅记录模式,策略集评估操作但不强制执行决策。建议在启用强制执行前使用此模式测试和验证策略。

  • ENFORCE:强制执行模式,策略集评估操作并强制执行决策。

attached_at

String

参数解释:

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

取值范围:

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

表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解密接口进行解密。

取值范围:

不涉及。

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

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

取值范围:

不涉及。

请求示例

  • 查询策略集关联的实体列表。

    GET https://{endpoint}/v1/policy-engines/{policy_engine_id}/attachments
  • 分页查询策略集关联的实体列表。

    GET https://{endpoint}/v1/policy-engines/{policy_engine_id}/attachments?limit=10&marker=xxx

响应示例

状态码:200

{
  "attachments" : [ {
    "entity_type" : "GATEWAY",
    "entity_id" : "b2fc0463-8b28-46c5-87ba-6267295ffc57",
    "mode" : "LOG_ONLY",
    "attached_at" : "2025-01-01 00:00:00"
  }, {
    "entity_type" : "TOKEN_VAULT",
    "entity_id" : "default",
    "mode" : "ENFORCE",
    "attached_at" : "2025-01-02 00:00:00"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : "marker"
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

404

未找到相应的资源。

错误码

请参见错误码。

相关文档