批量查询runtime - ListCoreRuntimes
功能介绍
该接口用于查询Agent运行时列表。支持按多种条件筛选和分页查询。
适用场景:
根据Agent运行时名称查询运行时列表,支持精确匹配和模糊匹配。
根据Agent运行时ID进行精确查询,支持批量查询多个运行时ID。
URI
GET /v1/core/runtimes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
runtime_ids |
否 |
Array of strings |
参数解释: 运行时ID列表精确查询,可选参数,如果有多个ID,ID之间用逗号分隔。 约束限制: 支持批量查询多个运行时ID,最多支持100个ID。 取值范围: 最小数量 1,最大数量 10 默认取值: 不涉及。 |
|
name |
否 |
String |
参数解释: Agent运行时名称,必须以字母开头,只包含字母数字和连字符。 约束限制: 不涉及。 取值范围: 长度为 2 - 48 个字符。 默认取值: 不涉及。 |
|
match_type |
否 |
String |
参数解释: 名称匹配模式,仅针对name参数生效。 约束限制: 不涉及。 取值范围: 默认取值: FUZZY |
|
offset |
否 |
Integer |
参数解释: 分页起始页码,从1开始。 约束限制: 不涉及。 取值范围: 1 - 1000 默认取值: 1 |
|
limit |
否 |
Integer |
参数解释: 每页记录数,最大100条。 约束限制: 不涉及。 取值范围: 10 - 100 默认取值: 10 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释: 总记录数。 取值范围: 0 - 1000000。 |
|
items |
Array of CoreRunAgentRuntimeBasic objects |
参数解释: AgentRuntime对象列表。 取值范围: 数组类型,元素个数限制0 - 100。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: AgentRuntime唯一标识(用户操作唯一键,UUID随机生成)。 取值范围: 匹配标准的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 - 4096 个字符。 |
|
name |
String |
参数解释: Agent名称。 取值范围: 长度为 2 - 48 个字符,必须以字母开头,支持中划线。 |
|
latest_version |
String |
参数解释: 最新版本名称。 取值范围: 长度为 2 - 24 个字符,必须以字母开头和结尾,支持中划线。 |
|
created_at |
String |
参数解释: 创建时间。 取值范围: 不涉及。 |
|
agent_gateway_id |
String |
参数解释: Agent Gateway ID。 取值范围: 匹配标准的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}$。 |
|
updated_at |
String |
参数解释: 最后更新时间。 取值范围: 不涉及。 |
|
workload_identity_urn |
String |
参数解释: Identity URN。 取值范围: 长度为 1 - 1500 个字符。 |
|
tags |
Array of CoreRunTagItem objects |
参数解释: 标签配置列表,对接TMS标签服务,用于资源分类。 约束限制: 元素个数0 - 20。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释: 标签键。 约束限制: 不涉及。 取值范围: 长度为 1 - 128 个字符。 默认取值: 不涉及。 |
|
value |
String |
参数解释: 标签值。 约束限制: 不涉及。 取值范围: 长度为 0 - 255 个字符。 默认取值: 不涉及。 |
状态码: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 个字符。 |
状态码: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 个字符。 |
请求示例
无
响应示例
状态码:200
查询成功,返回符合条件的AgentRuntime列表。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功,返回符合条件的AgentRuntime列表。 |
|
400 |
请求参数错误(如runtime_ids格式错误、name长度超出限制等)。 |
|
401 |
未授权(认证令牌缺失、无效或已过期)。 |
|
403 |
禁止访问(认证后权限不足)。 |
|
429 |
请求过于频繁(触发限流)。 |
|
500 |
服务器内部错误(如数据库查询异常、关联数据获取失败等)。 |
错误码
请参见错误码。