获取智能体版本详情 - ShowCoreAgentVersion
功能介绍
根据agent_id和version获取智能体某个历史版本的完整配置快照。
适用场景:
查看某个历史版本的完整配置详情。
对比不同版本之间的配置差异。
基于历史版本重建智能体配置。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:managedAgent:showCoreAgentVersion | Read | managedAgent * | g:ResourceTag/<tag-key> | - | - |
URI
GET /v1/core/agents/{agent_id}/versions/{version}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| agent_id | 是 | String | 参数解释: 智能体ID,用于唯一标识一个智能体实例。获取方式:通过创建智能体接口返回的agent_id字段获取,或通过查询智能体列表接口获取,具体参见查询智能体列表。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 默认取值: 不涉及。 |
| version | 是 | String | 参数解释: 版本号。 约束限制: 不涉及。 取值范围: 匹配小写字母开头、数字结尾的版本号格式,如v1、v2。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| agent_id | String | 参数解释: 智能体唯一标识,由系统自动生成。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 |
| name | String | 参数解释: 智能体名称。 取值范围: 长度为2-40个字符,必须以小写字母开头、以小写字母或数字结尾,只能包含小写字母、数字和中划线。 |
| description | String | 参数解释: 智能体描述信息。 取值范围: 长度为0-4096个字符。 |
| environment_id | String | 参数解释: 关联的环境ID,创建后不可修改。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 |
| agent_gateway_id | String | 参数解释: 智能体网关的唯一ID,用于智能体的入站流量路由。获取方式:通过AgentGateway的查询网关实例列表接口获取。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 |
| model | Array of ModelConfigResp objects | 参数解释: 模型配置列表,包含模型提供商和模型的详细信息,元素个数1个。 取值范围: 不涉及。 |
| system_prompt | String | 参数解释: 系统提示词。 取值范围: 长度为0-32768个字符。 |
| allowed_tools | Array of strings | 参数解释: 允许智能体使用的工具列表。*表示允许所有工具,也可指定具体工具名称(如bash、write_file、read_file、glob、edit_file、list_files、grep),元素个数0-100个,每个工具名的长度为1-128个字符。 取值范围: 不涉及。 |
| skills | Array of AgentSkill objects | 参数解释: 技能列表,来源于我的资产,上限50个。 取值范围: 不涉及。 |
| identity_configuration | IdentityConfiguration object | 参数解释: 入站身份认证配置,创建后不可修改。响应中api_key脱敏。 取值范围: 不涉及。 |
| workload_identity_urn | String | 参数解释: 工作负载身份URN,由系统自动生成,用于运行时身份认证。未配置时为null。 取值范围: 长度为0-512个字符,可包含小写字母、数字、冒号、下划线和中划线(IAMURN格式)。 |
| access_endpoint | String | 参数解释: 智能体的访问端点URL,由系统自动生成。未配置时为null。 取值范围: 长度为0-512个字符。 |
| execution_agency_name | String | 参数解释: 执行委托名称(华为云IAM委托格式),运行时以此委托身份访问云资源。未配置时为null。 取值范围: 长度为1-64个字符。 |
| lifecycle_config | lifecycle_config object | 参数解释: 运行时生命周期配置,用于配置空闲会话超时与最大存活时间。未配置时为null(使用平台默认配置)。 取值范围: 不涉及。 |
| observability | observability object | 参数解释: 可观测性配置。未配置时为null(使用平台默认配置)。 取值范围: 不涉及。 |
| latest_version | String | 参数解释: 最新版本号。创建时为v1,每次更新由平台自动递增。 取值范围: 匹配小写字母开头、数字结尾的版本号格式,如v1、v2。 |
| created_by | String | 参数解释: 创建者用户ID,由系统自动记录。 取值范围: 长度为0-128个字符。 |
| created_at | String | 参数解释: 创建时间,UTC时间格式,格式为YYYY-MM-DDTHH:mm:ssZ,由系统自动生成。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 更新时间,UTC时间格式,格式为YYYY-MM-DDTHH:mm:ssZ,由系统自动生成。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| provider_id | String | 参数解释: 模型提供商ID。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 |
| provider_name | String | 参数解释: 模型提供商名称。 取值范围: 长度为0-64个字符。 |
| model_id | String | 参数解释: 模型ID。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 |
| model_name | String | 参数解释: 模型名称。 取值范围: 长度为0-128个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| skill_id | String | 参数解释: 引用已创建的Skill资源的唯一标识ID。来源于我的资产。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),例如0451ff49-3c47-4049-851c-51c23fe7fe69。 |
| skill_name | String | 参数解释: 引用已创建的Skill资源名称。来源于我的资产。 取值范围: 长度为1-128个字符。 |
| description | String | 参数解释: 技能在当前智能体中的用途说明,便于理解该技能在此智能体场景下的作用。 取值范围: 长度为0-4096个字符。 |
| version | Integer | 参数解释: 引用的Skill资源版本号。 取值范围: 1-10000。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| authorizer_type | String | 参数解释: 智能体运行时所需的入站认证类型,智能体网关将根据该配置进行入站认证。 取值范围: 长度为1-10个字符。允许的值: |
| authorizer_configuration | authorizer_configuration object | 参数解释: 运行时入站认证配置。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| urn | String | 参数解释: 系统自动生成的资源标识符,用于唯一标识认证配置。 取值范围: 长度为0-1024个字符。 |
| custom_jwt | custom_jwt object | 参数解释: 运行时自定义JWT类型认证配置。 取值范围: 不涉及。 |
| key_auth | key_auth object | 参数解释: APIKEY入站认证配置。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| discovery_url | String | 参数解释: 此URL用于获取OpenIDConnect配置或授权服务器元数据,以验证传入的令牌。 取值范围: 长度为1-2048个字符。 |
| allowed_audience | Array of strings | 参数解释: 允许对入站JWT进行验证的受众值列表,元素个数0-10个,每个受众值元素的长度为1-512个字符。 取值范围: 不涉及。 |
| allowed_clients | Array of strings | 参数解释: 允许用于入站JWT验证的客户端标识符值列表,元素个数0-50个,每个客户端值的长度为1-256个字符。 取值范围: 不涉及。 |
| allowed_scopes | Array of strings | 参数解释: 允许对入站JWT进行验证的范围值列表,元素个数0-50个,每个范围值的长度为1-256个字符。 取值范围: 不涉及。 |
| custom_claims | Array of custom_claims objects | 参数解释: 对入站JWT应用自定义声明验证规则,最小数量1,最大数量20。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| inbound_token_claim_name | String | 参数解释: 要检查的自定义声明字段的名称。 取值范围: 长度为1-255个字符,只包含字母数字、下划线、点号、中划线和冒号。 |
| inbound_token_claim_value_type | String | 参数解释: 要检查的声明值的数据类型。 取值范围: 长度为1-12个字符。允许的值: |
| authorizing_claim_match_value | 参数解释: 自定义声明匹配配置。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| claim_match_operator | String | 参数解释: 定义声明字段值与要匹配的值之间的关系。 取值范围: 长度为1-12个字符。允许的值: |
| claim_match_value | claim_match_value object | 参数解释: 入站认证需要校验的自定义Claim字段所需要的匹配策略。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| match_value_string | String | 参数解释: 入站认证需要校验的自定义Claim字段所要匹配的字符串值。 取值范围: 长度为1-255个字符,只包含字母数字、下划线、点号和中划线。 |
| match_value_string_list | Array of strings | 参数解释: 入站认证需要校验的自定义Claim字段所要匹配的字符串值列表,最小数量1,最大数量50,每个值的长度为1-255个字符。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| api_keys | Array of api_keys objects | 参数解释: 入站认证允许的所有的APIKEY密钥列表(响应中api_key脱敏),最小数量0,最大数量10。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| api_key | String | 参数解释: API密钥值。轮换期间,可以使用其中任何一个密钥。如果密钥为空,则会生成一个随机字符串。 取值范围: 长度为1-512个字符,只包含字母数字、中划线和下划线。 |
| api_key_name | String | 参数解释: API密钥名称,该名称仅用于标识该密钥,不用于实际认证。 取值范围: 长度为0-64个字符,只包含字母数字、中划线和下划线。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| idle_session_timeout_sec | Integer | 参数解释: 空闲会话超时(秒)。 取值范围: null或[60,604800](含边界,604800秒=7天)。 |
| max_alive_time_sec | Integer | 参数解释: 最大存活时间(秒)。 取值范围: null或[60,604800](含边界,604800秒=7天)。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000400表示客户端请求参数错误。 取值范围: 固定值:AgentArts.03000400。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000401表示未授权(认证令牌缺失、无效或已过期)。 取值范围: 固定值:AgentArts.03000401。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000403表示禁止访问(认证后权限不足)。 取值范围: 固定值:AgentArts.03000403。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
| coded_authorization_message | String | 参数解释: 当API无访问权限时报错信息。 取值范围: 长度为1-1024个字符。 |
| details | Array of ManagedAgentErrorDetail objects | 参数解释: 依赖的下游服务错误信息列表。 取值范围: 最小数量0,最大数量10。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 长度为18个字符。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 长度为1-1024个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000404表示资源不存在。 取值范围: 固定值:AgentArts.03000404。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000429表示请求过于频繁(触发限流)。 取值范围: 固定值:AgentArts.03000429。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000500表示服务器内部错误。 取值范围: 固定值:AgentArts.03000500。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
请求示例
获取智能体版本详情
GET https://{Endpoint}/v1/core/agents/{agent_id}/versions/{version} 响应示例
状态码:200
{
"agent_id" : "a1b2c3d4-1234-5678-abcd-e1f2a3b4c5d6",
"name" : "agent-l1ppk",
"description" : "智能客服助手",
"environment_id" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"agent_gateway_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"model" : [ {
"provider_id" : "a1b2c3d4-1234-5678-abcd-e1f2a3b4c5d6",
"provider_name" : "huawei",
"model_id" : "b2c3d4e5-1234-5678-abcd-e1f2a3b4c5d6",
"model_name" : "claude-sonnet-4-6"
} ],
"system_prompt" : "You are a helpful assistant.",
"allowed_tools" : [ "*", "bash", "file_operations" ],
"skills" : [ {
"skill_id" : "4b66da54-5383-489b-bb7e-43c946cb9505",
"skill_name" : "code-review",
"description" : "对代码变更进行自动化审查"
} ],
"workload_identity_urn" : "urn:iam::677563056420:identity::agent-a1b2c3d4e5",
"execution_agency_name" : "default-agency",
"lifecycle_config" : {
"idle_session_timeout_sec" : 900,
"max_alive_time_sec" : 86400
},
"latest_version" : "v1",
"created_at" : "2024-05-20T14:30:00Z",
"updated_at" : "2024-05-20T14:30:00Z"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功,返回智能体指定版本的完整配置。 |
| 400 | 请求参数错误。 |
| 401 | 未授权。 |
| 403 | 禁止访问。 |
| 404 | 资源不存在。 |
| 429 | 请求过于频繁。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。