文档首页/ 智能体身份/ API参考/ API/ 工作负载身份/ 查询工作负载身份详情
更新时间:2026-11-04 GMT+08:00
分享

查询工作负载身份详情

功能介绍

根据工作负载身份名称查询指定工作负载身份的详细信息,包括名称、URN、授权类型、创建者、标签等。

URI

GET /v1/workload-identities/{workload_identity_name}

表1 路径参数

参数

是否必选

参数类型

描述

workload_identity_name

是

String

参数解释:

工作负载身份名称,用于唯一标识一个工作负载身份。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

workload_identity

WorkloadIdentity object

参数解释:

工作负载身份的详细信息,包含名称、URN、授权类型、API密钥凭证、创建者、创建时间、更新时间和标签等。

取值范围:

不涉及。

表3 WorkloadIdentity

参数

参数类型

描述

workload_identity_id

String

参数解释:

工作负载身份的唯一标识。

取值范围:

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

name

String

参数解释:

工作负载身份名称,用于唯一标识一个工作负载身份。

取值范围:

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

urn

String

参数解释:

工作负载身份的唯一资源名称(URN),由系统自动生成,用于全局唯一标识一个工作负载身份。

取值范围:

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

allowed_resource_oauth2_return_urls

Array of strings

参数解释:

工作负载身份关联的资源OAuth2回调地址列表。

取值范围:

符合URL格式的字符串,必须以协议开头(如https://),长度为1~2048个字符。

authorizer_type

String

参数解释:

授权类型,用于指定工作负载身份的入站请求身份验证方式。不同的授权类型对应不同的授权配置。

取值范围:

  • CUSTOM_JWT:自定义JWT授权,通过外部身份提供商的JWT令牌进行身份验证。

  • IAM:IAM授权,通过华为云IAM服务进行身份验证。

  • API_KEY:API Key授权,通过预置的API密钥进行身份验证。

  • NONE:无授权,不进行入站请求身份验证。

api_key_secret

Secret object

参数解释:

凭证信息,包含凭证ID和凭证名称。用于API Key授权方式下,标识存储在CSMS(凭证管理服务)中的API密钥凭证。

取值范围:

不涉及。

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

参数解释:

自定义标签列表。

取值范围:

不涉及。

表4 Secret

参数

参数类型

描述

secret_id

String

参数解释:

凭证ID,唯一标识CSMS中的凭证。

取值范围:

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

secret_name

String

参数解释:

凭证名称,CSMS中存储的凭证名称。

取值范围:

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

表5 CreatedBy

参数

参数类型

描述

type

String

参数解释:

工作负载身份创建者类型,标识创建者是由用户还是由服务创建的。

取值范围:

  • CUSTOMER:由用户创建。

  • SERVICE:由服务自动创建。

identifier

String

参数解释:

工作负载身份创建者标识。当创建者类型为CUSTOMER时,标识为用户的账号ID;当创建者类型为SERVICE时,标识为服务名称。

取值范围:

不涉及。

表6 Tag

参数

参数类型

描述

key

String

参数解释:

标签键,用于标识标签的名称。

取值范围:

可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合,长度为1~128个字符。

value

String

参数解释:

标签值,用于标识标签的具体内容。

取值范围:

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

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

加密后的认证失败信息,可以通过STS5解密接口进行解密。

取值范围:

不涉及。

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

加密后的认证失败信息,可以通过STS5解密接口进行解密。

取值范围:

不涉及。

请求示例

查询工作负载身份详情。

GET https://{endpoint}/v1/workload-identities/{workload_identity_name}

响应示例

状态码:200

{
  "workload_identity" : {
    "workload_identity_id" : "684a2c3e5f1b9d0e7a3c4f56",
    "name" : "my_workload_identity",
    "urn" : "agentIdentity:<region>:<account-id>:workloadIdentity:workloadIdentityDirectory/<workload-directory-id>/<workload-identity-name>",
    "allowed_resource_oauth2_return_urls" : [ "https://example.com/oauth2/callback" ],
    "authorizer_type" : "API_KEY",
    "api_key_secret" : {
      "secret_id" : "285624f5-5958-4f36-b171-168303615bce",
      "secret_name" : "test-secret"
    },
    "created_by" : {
      "type" : "SERVICE",
      "identifier" : "service.AgentRuntime"
    },
    "created_at" : "2025-01-01 00:00:00",
    "updated_at" : "2025-01-02 00:00:00",
    "tags" : [ {
      "key" : "key-1",
      "value" : "value-1"
    } ]
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

404

未找到相应的资源。

错误码

请参见错误码。

相关文档