# 查询策略列表 #### 功能介绍 查询策略列表。 #### URI GET /v1/policy-engines/{policy_engine_id}/policies 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy_engine_id | 是 | String | **参数解释**： 策略集ID，系统自动生成的唯一标识符。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字及"-"、"_"组成，长度为12\~59个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 每页显示的条目数量，用于控制单次查询返回的工作负载身份数量。 **约束限制**： 不涉及。 **取值范围**： 1\~200。 **默认取值**： 100。 | | marker | 否 | String | **参数解释**： 分页标记，用于指定查询的起始位置，配合limit使用。当返回结果中存在next_marker时，使用该值作为下一次请求的marker参数以获取下一页数据。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字及"+"、"/"、"="、"-"、"_"组成，长度为4\~400个字符。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policies | Array of [PolicySummary] objects | **参数解释**： 策略列表。 **取值范围**： 不涉及。 | | page_info | [PageInfo] object | **参数解释**： 分页信息，包含下一页标记和当前页返回条目数量。 **取值范围**： 不涉及。 | 表4PolicySummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_id | String | **参数解释**： 策略ID，系统自动生成的唯一标识符。 **取值范围**： 只能由英文字母、数字及"-"、"_"组成，长度为1\~128个字符。 | | name | String | **参数解释**： 策略名称，用于标识和区分不同的策略。 **取值范围**： 只能以英文字母开头，由英文字母、数字及"_"组成，长度为1\~48个字符。 | | description | String | **参数解释**： 策略的可读描述。 **取值范围**： 长度为1\~4096个字符。 | | urn | String | **参数解释**： 策略的统一资源名称（URN）。 **取值范围**： 长度为1\~1024个字符。 | | status | String | **参数解释**： 策略的当前状态。 **取值范围**： - CREATING：策略正在创建中 - ACTIVE：策略已激活并可用 - UPDATING：策略正在更新中 - DELETING：策略正在删除中 - CREATE_FAILED：策略创建失败 - UPDATE_FAILED：策略更新失败 - DELETE_FAILED：策略删除失败 | | status_reasons | Array of strings | **参数解释**： 关于策略状态的额外信息，提供关于任何失败或策略创建过程当前状态的详细信息。 **取值范围**： 不涉及。 | | 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。 | | policy_engine_id | String | **参数解释**： 策略集ID，系统自动生成的唯一标识符。 **取值范围**： 只能由英文字母、数字及"-"、"_"组成，长度为12\~59个字符。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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/{policy_engine_id}/policies ``` - 分页查询策略列表。 ``` GET https://{endpoint}/v1/policy-engines/{policy_engine_id}/policies?limit=10&marker=xxx ``` #### 响应示例 **状态码：200** ``` { "policies" : [ { "policy_id" : "285624f5-5958-4f36-b171-168303615bce", "name" : "my_policy_1", "description" : "Example policy for allowing read access to resources", "urn" : "agentIdentity:::policy:policyEngine//", "pending_definition" : { "cedar" : { "statement" : "permit(principal, action, resource);" } }, "active_definition" : { "cedar" : { "statement" : "permit(principal, action, resource);" } }, "status" : "ACTIVE", "created_at" : "2025-01-01 00:00:00", "updated_at" : "2025-01-01 00:00:00", "policy_engine_id" : "285624f5-5958-4f36-b171-168303615bce" }, { "policy_id" : "385624f5-5958-4f36-b171-168303615bcg", "name" : "my_policy_2", "description" : "Example policy for allowing write access to resources", "urn" : "agentIdentity:::policy:policyEngine//", "pending_definition" : { "cedar" : { "statement" : "permit(principal, action, resource);" } }, "active_definition" : { "cedar" : { "statement" : "permit(principal, action, resource);" } }, "status" : "CREATE_FAILED", "status_reasons" : [ "Invalid syntax in statement", "Missing required principal type" ], "created_at" : "2025-01-02 00:00:00", "updated_at" : "2025-01-02 00:00:00", "policy_engine_id" : "285624f5-5958-4f36-b171-168303615bce" } ], "page_info" : { "current_count" : 2, "next_marker" : "marker" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 请求体异常。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentidentity/ErrorCode.html)。