# 查询工作负载身份列表 #### 功能介绍 查询当前账号下的工作负载身份列表。支持分页查询，可通过limit和marker参数控制返回结果的数量和起始位置。 #### URI GET /v1/workload-identities 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 每页显示的条目数量，用于控制单次查询返回的工作负载身份数量。 **约束限制**： 不涉及。 **取值范围**： 1\~200。 **默认取值**： 100。 | | marker | 否 | String | **参数解释**： 分页标记，用于指定查询的起始位置，配合limit使用。当返回结果中存在next_marker时，使用该值作为下一次请求的marker参数以获取下一页数据。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字及"+"、"/"、"="、"-"、"_"组成，长度为4\~400个字符。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | workload_identities | Array of [WorkloadIdentitySummary] objects | **参数解释**： 工作负载身份摘要信息列表。 **取值范围**： 不涉及。 | | page_info | [PageInfo] object | **参数解释**： 分页信息，包含下一页标记和当前页返回条目数量。 **取值范围**： 不涉及。 | 表3WorkloadIdentitySummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | workload_identity_id | String | **参数解释**： 工作负载身份的唯一标识。 **取值范围**： 只能由英文字母、数字及"-"、"_"组成，长度为1\~64个字符。 | | name | String | **参数解释**： 工作负载身份名称，用于唯一标识一个工作负载身份。 **取值范围**： 只能由英文字母、数字及"-"、"_"组成，长度为1\~56个字符。 | | urn | String | **参数解释**： 工作负载身份的唯一资源名称（URN），由系统自动生成，用于全局唯一标识一个工作负载身份。 **取值范围**： 只能由英文字母、数字及"/"、"="、"_"、":"、"-"组成，长度为16\~1500个字符。 | | authorizer_type | String | **参数解释**： 授权类型，用于指定工作负载身份的入站请求身份验证方式。不同的授权类型对应不同的授权配置。 **取值范围**： - CUSTOM_JWT：自定义JWT授权，通过外部身份提供商的JWT令牌进行身份验证。 - IAM：IAM授权，通过华为云IAM服务进行身份验证。 - API_KEY：API Key授权，通过预置的API密钥进行身份验证。 - NONE：无授权，不进行入站请求身份验证。 | | created_by | [CreatedBy] object | **参数解释**： 工作负载身份的创建者信息，包含创建者类型和创建者标识。 **取值范围**： 不涉及。 | | 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 | **参数解释**： 自定义标签列表。 **取值范围**： 不涉及。 | 表4CreatedBy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 工作负载身份创建者类型，标识创建者是由用户还是由服务创建的。 **取值范围**： - CUSTOMER：由用户创建。 - SERVICE：由服务自动创建。 | | identifier | String | **参数解释**： 工作负载身份创建者标识。当创建者类型为CUSTOMER时，标识为用户的账号ID；当创建者类型为SERVICE时，标识为服务名称。 **取值范围**： 不涉及。 | 表5Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键，用于标识标签的名称。 **取值范围**： 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合，长度为1\~128个字符。 | | value | String | **参数解释**： 标签值，用于标识标签的具体内容。 **取值范围**： 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"、"\&"符号的任意组合，可以是空字符串，长度为0\~255个字符。 | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**： 下一页标记，配合limit参数使用。如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。 **取值范围**： 只能由英文字母、数字及"+"、"/"、"="、"-"、"_"组成。 | | current_count | Integer | **参数解释**： 本页返回的条目数量。 **取值范围**： 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | | encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 | #### 请求示例 - 查询工作负载身份列表。 ``` GET https://{endpoint}/v1/workload-identities ``` - 分页查询工作负载身份列表。 ``` GET https://{endpoint}/v1/workload-identities?limit=10&marker=xxx ``` #### 响应示例 **状态码：200** ``` { "workload_identities" : [ { "workload_identity_id" : "684a2c3e5f1b9d0e7a3c4f56", "name" : "workload_identity_1", "urn" : "agentIdentity:::workloadIdentity:workloadIdentityDirectory//", "authorizer_type" : "CUSTOM_JWT", "created_by" : { "type" : "SERVICE", "identifier" : "service.AgentRuntime" }, "created_at" : "2025-01-01 00:00:00", "updated_at" : "2025-01-01 00:00:00", "tags" : [ { "key" : "key-1", "value" : "value-1" } ] }, { "workload_identity_id" : "684a2c3e5f1b9d0e7a3c4f57", "name" : "workload_identity_2", "urn" : "agentIdentity:::workloadIdentity:workloadIdentityDirectory//", "authorizer_type" : "API_KEY", "created_by" : { "type" : "CUSTOMER", "identifier" : 12345678901234567890 }, "created_at" : "2025-01-02 00:00:00", "updated_at" : "2025-01-03 00:00:00", "tags" : [ { "key" : "key-2", "value" : "value-2" } ] } ], "page_info" : { "current_count" : 2, "next_marker" : "marker" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 请求体异常。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentidentity/ErrorCode.html)。