更新runtime访问方式 - UpdateCoreRuntimeEndpoint
功能介绍
该接口用于根据Agent运行时ID和访问方式ID修改对应的Agent运行时访问方式的配置信息,支持修改访问方式对应的版本信息以及多版本之间的权重分配信息。
适用场景:
修改某一个具体的Agent运行时访问方式的绑定版本。
修改某一个具体的Agent运行时访问方式的多版本权重配置。
URI
PUT /v1/core/runtimes/{runtime_id}/endpoints/{endpoint_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}$。 默认取值: 不涉及。 |
| endpoint_id | 是 | String | 参数解释: 访问方式ID,用于唯一标识一个Agent运行时访问方式实例。 约束限制: 不涉及。 取值范围: 匹配标准的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}$。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| description | 否 | String | 参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 长度为0-255个字符,不能包含小于号或大于号。 默认取值: 不涉及。 |
| target_version_name | 否 | String | 参数解释: 目标版本名称。 约束限制: 不涉及。 取值范围: 以小写字母或数字开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-24个字符。 默认取值: 不涉及。 |
| routing_config | 否 | CoreRunRoutingConfiguration object | 参数解释: 智能体运行时访问方式的路由配置,支持多版本权重分配。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tags | 否 | Array of CoreRunTagItem objects | 参数解释: 标签配置列表,对接TMS标签服务,用于资源分类。 约束限制: 元素个数0 - 20。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| version_weights | 否 | Array of CoreRunVersionWeight objects | 参数解释: 运行时访问方式多版本权重配置。 约束限制: 不涉及。 取值范围: 元素个数0 - 3。 默认取值: 不涉及。 |
响应参数
状态码:200
更新成功,返回更新后的访问方式信息。
状态码: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 个字符。 |
状态码: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/runtimes/{runtime_id}/endpoints/{endpoint_id} { "description" : "切换到 v2.0.0 版本", "target_version_name" : "v2.0.0" } -
PUT https://{Endpoint}/v1/core/runtimes/{runtime_id}/endpoints/{endpoint_id} { "description" : "调整金丝雀发布权重", "routing_config" : { "version_weights" : [ { "version_name" : "v1.0.0", "weight" : 0.7 }, { "version_name" : "v2.0.0", "weight" : 0.3 } ] } } -
PUT https://{Endpoint}/v1/core/runtimes/{runtime_id}/endpoints/{endpoint_id} { "description" : "完全切换到 v2.0.0", "target_version_name" : "v2.0.0", "routing_config" : { "version_weights" : [ { "version_name" : "v2.0.0", "weight" : 1.0 } ] } }
响应示例
状态码:200
更新成功,返回更新后的访问方式信息。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新成功,返回更新后的访问方式信息。 |
| 400 | 请求参数错误。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 403 | 禁止访问(认证后权限不足)。 |
| 404 | 资源不存在(指定的endpoint_id未找到)。 |
| 429 | 请求过于频繁(触发限流)。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。