更新runtime - UpdateCoreRuntime
功能介绍
该接口用于根据Agent运行时ID修改对应的Agent运行时的配置信息,支持修改Agent镜像,网络配置,运行时委托,环境变量,可观测配置。该接口每次调用会生成一个新的运行时版本(更新tags除外)。version字段默认为V1、V2自增长,用户也可自定义。
适用场景:
修改某一个具体的Agent运行时的镜像版本。
修改某一个具体的Agent运行时的环境变量。
修改某一个具体的Agent运行时的网络配置。
URI
PUT /v1/core/runtimes/{runtime_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| runtime_id | 是 | String | 参数解释: 运行时ID,用于唯一标识一个Agent运行时实例。可以通过AgentArts智能体运行时控制台或者运行时查询接口获取。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| version | 否 | String | 参数解释: 版本名称,默认为v1、V2自增长,用户也可自定义。 约束限制: 不涉及。 取值范围: 以小写字母或数字开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-24个字符。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 版本描述信息。 约束限制: 不涉及。 取值范围: 长度为0-255个字符,不能包含小于号或大于号 默认取值: 不涉及。 |
| artifact_source | 否 | CoreRunArtifactSource object | 参数解释: Agent来源数据结构。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| environment_variables | 否 | Array of CoreRunEnvironmentVariable objects | 参数解释: 环境变量配置列表,用于配置运行时环境变量。 约束限制: 总大小约束2MB。 取值范围: 支持0 - 1024个元素。 默认取值: 不涉及。 |
| network_config | 否 | CoreRunNetworkConfig object | 参数解释: 出站网络配置,不配置默认是PUBLIC。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| invoke_config | 否 | CoreRunInvokeConfig object | 参数解释: 智能体调用相关配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| observability | 否 | CoreRunObservability object | 参数解释: 可观测性配置(日志+指标)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tags | 否 | Array of CoreRunTagItem objects | 参数解释: 标签配置列表,对接TMS标签服务,用于资源分类。 约束限制: 元素个数0 - 20。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| url | 是 | String | 参数解释: Agent镜像地址,用于运行时拉取镜像启动Agent服务,可以通过SWR控制台以及SWR的镜像查询接口获取对应的镜像地址。 约束限制: 必须是一个有效的SWR镜像地址。 取值范围: 长度为 1 - 2048 个字符。 默认取值: 不涉及。 |
| commands | 否 | Array of strings | 参数解释: 启动镜像的命令,示例:python main.py --port=8080。 约束限制: 不涉及。 取值范围: 最多 10 个元素,每个元素长度为 1 - 256 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 环境变量键。 约束限制: 不涉及。 取值范围: 必须以字母开头,由英文字母、数字、下划线和点号组成。 默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 环境变量值。 约束限制: 不涉及。 取值范围: 长度为 1 - 1048576 个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| network_mode | 是 | String | 参数解释: 出站网络类型,当前支持如下2种: 约束限制: 不涉及。 取值范围: 默认取值: PUBLIC。 |
| vpc_config | 否 | CoreRunVpcConfig object | 参数解释: vpc网络配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| vpc_id | 是 | String | 参数解释: VPC ID,可以通过VPC的控制台页面或者VPC查询接口获取。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| subnet_id | 是 | String | 参数解释: 子网ID,可以通过VPC的控制台页面或者VPC查询接口获取。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| security_group_ids | 否 | Array of strings | 参数解释: VPC关联的安全组ID列表。 约束限制: 不涉及。 取值范围: 元素个数0-10个。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| port | 否 | Integer | 参数解释: 智能体运行时监听的端口号,用于接收外部请求。 约束限制: 不涉及。 取值范围: 1 - 65535 默认值: 8080 |
| protocol | 否 | String | 参数解释: 智能体运行时支持的协议类型 约束限制: 不涉及。 取值范围: 默认值: HTTP |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| logs | 否 | CoreRunLogsConfig object | 参数解释: 日志采集配置。 约束限制: 日志组ID与日志流ID必须配套使用,要么同时缺省,要么同时填写。 取值范围: 不涉及。 默认取值: 不涉及。 |
| metrics | 否 | 参数解释: 自定义指标采集详细配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | |
| tracing | 否 | 参数解释: 调用链采集配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 参数解释: 是否开启日志采集。 约束限制: 不涉及。 取值范围: 默认值: false |
| group_id | 否 | String | 参数解释: 日志组ID。 约束限制: 与日志流ID配套使用,需同时填写或同时缺省。 取值范围: 长度为 1 - 64 个字符。 默认值: 无。 |
| stream_id | 否 | String | 参数解释: 日志流ID。 约束限制: 与日志组ID配套使用,需同时填写或同时缺省。 取值范围: 长度为 1 - 64 个字符。 默认值: 无。 |
| project_id | 否 | String | 参数解释: 日志流所在项目ID。 约束限制: 与日志组ID配套使用,需同时填写或同时缺省。 取值范围: 长度为 1 - 64 个字符。 默认值: 无。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 否 | Boolean | 参数解释: 是否开启自定义指标采集。 约束限制: 不涉及。 取值范围: 默认值: false |
| instance_id | 否 | String | 参数解释: 自定义指标实例ID。 约束限制: 不涉及。 取值范围: 长度为 1 - 64 个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
更新成功,返回更新后的AgentRun完整信息(含最新版本详情)。
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000400表示客户端请求参数错误。 取值范围: 固定值:AgentArts.03000400。 |
| error_msg | String | 错误详细信息。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000401表示未授权(认证令牌缺失、无效或已过期)。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000403表示禁止访问(认证后权限不足)。 取值范围: 固定值:AgentArts.03000403。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
| coded_authorization_message | String | 参数解释: IAM5 当OpenAPI无权限时报错信息。 取值范围: 长度为 1 - 1024 个字符。 |
| details | Array of CoreRunErrorDetail 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 个字符。 |
状态码:409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000409表示资源冲突。 取值范围: 固定值:AgentArts.03000409。 |
| 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 个字符。 |
请求示例
-
PUT https://{Endpoint}/v1/core/internal/runtimes/{runtime_id} { "tags" : [ { "key" : "env", "value" : "staging" }, { "key" : "version", "value" : "2.0" } ] } -
PUT https://{Endpoint}/v1/core/internal/runtimes/{runtime_id} { "version" : "V2", "description" : "新增对话历史功能,优化响应速度", "artifact_source" : { "url" : "swr.cn-north-7.myhuaweicloud.com/agentrun/ai-assistant:v2.0.0", "commands" : [ "python", "main.py", "--enable-history" ] }, "environment_variables" : [ { "key" : "MAX_HISTORY_TURNS", "value" : "10" }, { "key" : "RESPONSE_TIMEOUT", "value" : "30" } ], "invoke_config" : { "port" : 8080, "protocol" : "HTTP" }, "observability" : { "logs" : { "enabled" : true, "stream_id" : "v2-lts-stream" }, "metrics" : { "enabled" : true }, "tracing" : { "enabled" : true } } }
响应示例
状态码:200
更新成功,返回更新后的AgentRun完整信息(含最新版本详情)。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新成功,返回更新后的AgentRun完整信息(含最新版本详情)。 |
| 400 | 参数错误(如必填字段格式不正确、版本配置冲突等)。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 403 | 禁止访问(认证后权限不足)。 |
| 404 | 资源不存在(指定的runtimeId未找到)。 |
| 409 | 资源冲突(如同时更新导致版本号冲突)。 |
| 429 | 请求过于频繁(触发限流)。 |
| 500 | 服务器错误(如数据库更新失败、版本号生成异常等)。 |
错误码
请参见错误码。