文档首页/ 智能体身份/ API参考/ API/ STS凭证提供商/ 查询STS凭证提供商列表
更新时间:2026-11-04 GMT+08:00
分享

查询STS凭证提供商列表

功能介绍

查询当前账号下的STS凭证提供商列表。支持分页查询,可通过limit和marker参数控制返回结果的数量和起始位置。

URI

GET /v1/sts-credential-providers

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1~200。

默认取值:

100。

marker

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

credential_providers

Array of StsCredentialProviderSummary objects

参数解释:

STS凭证提供商摘要信息。

取值范围:

不涉及。

page_info

PageInfo object

参数解释:

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

取值范围:

不涉及。

表3 StsCredentialProviderSummary

参数

参数类型

描述

credential_provider_id

String

参数解释:

凭证提供商的唯一标识符。

取值范围:

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

name

String

参数解释:

凭证提供商名称,用于唯一标识一个凭证提供商。

取值范围:

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

urn

String

参数解释:

凭证提供商的唯一资源名称(URN)。

取值范围:

不涉及。

agency_urn

String

参数解释:

IAM委托的统一资源名称(URN),用于获取IAM临时凭证,在IAM控制台的「委托」页面中获取,需确保该委托的信任策略允许 AgentIdentity 服务执行 sts:agencies:assume 动作。

取值范围:

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

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。

tags

Array of Tag objects

参数解释:

自定义标签列表。

取值范围:

不涉及。

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

取值范围:

不涉及。

请求示例

  • 查询STS凭证提供商列表。

    GET https://{endpoint}/v1/sts-credential-providers
  • 分页查询STS凭证提供商列表。

    GET https://{endpoint}/v1/sts-credential-providers?limit=10&marker=xxx

响应示例

状态码:200

{
  "credential_providers" : [ {
    "credential_provider_id" : "684a2c3e5f1b9d0e7a3c4f56",
    "name" : "my_stsprovider",
    "urn" : "agentIdentity:<region>:<account-id>:stsCredentialProvider:tokenVault/<token-vault-id>/<name>",
    "agency_urn" : "iam::3fd23817bd85480e8dc4f520075de348:agency:provider",
    "created_at" : "2025-01-01 00:00:00",
    "updated_at" : "2025-01-01 00:00:00",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    } ]
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "marker"
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

错误码

请参见错误码。

相关文档