更新时间:2026-09-23 GMT+08:00
分享

查询委托或信任委托详情 - GetAgencyV5

功能介绍

该接口可以用于查询委托或信任委托详情。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

iam:agencies:getV5

Read

agency *

g:ResourceTag/<tag-key>

-

-

URI

GET /v5/agencies/{agency_id}

表1 路径参数

参数

是否必选

参数类型

描述

agency_id

是

String

参数解释:

委托或信任委托ID。获取方式请参见查询委托列表接口(ListAgenciesV5)或在IAM控制台的委托列表页查看。

约束限制:

不涉及。

取值范围:

长度为1到64个字符,只包含字母、数字和"-"的字符串。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

agency

agency object

参数解释:

委托或信任委托。

取值范围:

不涉及。

表3 agency

参数

参数类型

描述

urn

String

参数解释 :

URN(Uniform Resource Name)统一资源名称, 参考链接。

取值范围:

不涉及。

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

参数解释:

被委托方账号名。

取值范围:

不涉及。

tags

Array of tags objects

参数解释:

自定义标签列表。

取值范围:

不涉及。

表4 tags

参数

参数类型

描述

tag_key

String

参数解释:

标签键。

取值范围:

可以包含任意语种字母、数字、空格以及"_"、"."、":"、"="、"+"、"-"、"@"符号的任意组合,但是首尾不能包含空格以及不能使用"_sys_"为开头,长度范围为[1,128]。

tag_value

String

参数解释:

标签值。

取值范围:

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

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见错误码。

取值范围:

格式为PAP5.XXXX,例如PAP5.0012。

error_msg

String

参数解释:

错误信息,请参见错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

API请求的唯一标识,用于排查接口调用异常。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。

取值范围:

不涉及。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见错误码。

取值范围:

格式为PAP5.XXXX,例如 PAP5.0012。

error_msg

String

参数解释:

错误信息,请参见错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

API 请求的唯一标识,用于排查接口调用异常。

取值范围:

不涉及。

请求示例

查询委托详情。

GET https://{endpoint}/v5/agencies/{agency_id}

响应示例

状态码:200

{
  "agency" : {
    "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,
    "tags" : [ {
      "tag_key" : "key",
      "tag_value" : "value"
    } ]
  }
}

状态码

状态码

描述

200

请求成功。

403

没有操作权限。

404

未找到相应的资源。

错误码

请参见错误码。

相关文档