# 查询指定条件下的委托及信任委托列表 - ListAgenciesV5 #### 功能介绍 该接口可以用于查询指定条件下的委托及信任委托列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IAM/doc?api=ListAgenciesV5&version=v5)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-iam5/iam_02_1124.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | iam:agencies:listV5 | List | agency \* | - | - | - | #### URI GET /v5/agencies 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 每页显示的条目数量。 **约束限制**： 不涉及。 **取值范围**： 取值范围为\[1,200\]。 **默认取值**： 默认为100。 | | marker | 否 | String | **参数解释**： 服务内部自动生成的分页标记，用于标记本次请求的起始位置，可从上一次分页请求响应体的next_marker获得。 **约束限制**： 不涉及。 **取值范围**： 长度为4到400个字符，只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。 **默认取值**： 不涉及。 | | path_prefix | 否 | String | **参数解释**： 资源路径前缀，由若干段字符串拼接而成。 **约束限制**： 每段先包含一个或多个字母、数字、"."、","、"+"、"@"、"="、"_"或"-"，并以"/"结尾，例如"foo/bar/"。 **取值范围**： 不涉及。 **默认取值**： 默认值为空字符串。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | agencies | Array of [agencies] objects | **参数解释**： 委托及信任委托列表。 **取值范围**： 不涉及。 | | page_info | [page_info] object | **参数解释**： 分页信息。 **取值范围**： 不涉及。 | 表3agencies | 参数 | 参数类型 | 描述 | |:---|:---|:---| | urn | String | **参数解释**： URN(Uniform Resource Name)统一资源名称, [参考链接](https://support.huaweicloud.com/usermanual-iam5/iam_01_1275.html)。 **取值范围**： 不涉及。 | | trust_policy | String | **参数解释**： 信任委托信任策略的策略文档的json格式。 **取值范围**： 不涉及。 | | created_at | String | **参数解释**： 委托或信任委托创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2023-09-13T06:51:20.550Z。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 委托或信任委托描述信息。 **取值范围**： 不涉及。 | | max_session_duration | Integer | **参数解释**： 委托或信任委托最大会话时长（秒）。 **取值范围**： 取值范围为\[3600,43200\]。 | | path | String | **参数解释**： 资源路径，用于组织和分类资源的层级路径，类似于文件系统中的目录结构。 **取值范围**： 由若干段字符串拼接而成，长度为0\~512个字符，每段先包含一个或多个字母、数字、"."、","、"+"、"@"、"="、"_"或"-"，并以"/"结尾，例如"foo/bar/"。 | | agency_id | String | **参数解释**： 委托或信任委托ID。获取方式请参见查询委托列表接口（ListAgenciesV5）或在IAM控制台的委托列表页查看。 **取值范围**： 长度为1到64个字符，只包含字母、数字和"-"的字符串。 | | agency_name | String | **参数解释**： 委托或信任委托名称。 **取值范围**： 长度为1到64个字符，只包含字母、数字、"_"、"+"、"="、","、"."、"@"和"-"的字符串。 | | trust_domain_id | String | **参数解释**： 被委托方账号ID。 **取值范围**： 不涉及。 | | trust_domain_name | String | **参数解释**： 被委托方账号名。 **取值范围**： 不涉及。 | 表4page_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**： 下一次分页调用的起始位置标记，由服务自动生成。 **取值范围**： 不涉及。 | | current_count | Integer | **参数解释**： 本页返回条目数量。 **取值范围**： 不涉及。 | **状态码：403** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 格式为PAP5.XXXX，例如PAP5.0012。 | | error_msg | String | **参数解释**： 错误信息，请参见[错误信息](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： API请求的唯一标识，用于排查接口调用异常。 **取值范围**： 不涉及。 | | encoded_authorization_message | String | **参数解释**： 认证失败时返回的加密详细信息，用于定位认证问题。 可以通过STS5解密接口进行解密，请参见[接口链接](https://support.huaweicloud.com/api-iam5/DecodeAuthorizationMessage.html)。 **取值范围**： 不涉及。 | #### 请求示例 查询所有委托及信任委托列表。 ``` GET https://{endpoint}/v5/agencies ``` #### 响应示例 **状态码：200** ``` { "agencies" : [ { "urn" : "iam::123456789012:agency:example-agency", "trust_policy" : "{\"Version\":\"5.0\",\"Statement\":[{\"Action\":[\"sts:agencies:assume\",\"sts::tagSession\",\"sts::setSourceIdentity\"],\"Effect\":\"Allow\",\"Principal\":{\"IAM\":[\"xxx\"]}}]}", "created_at" : "2023-09-21T01:17:19.590Z", "description" : "description", "max_session_duration" : 3600, "path" : "", "agency_id" : "example-agency-id", "agency_name" : "example-agency-name", "trust_domain_id" : null, "trust_domain_name" : null } ], "page_info" : { "next_marker" : "marker", "current_count" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 403 | 没有操作权限。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。