文档首页/ 智果(AgentArts)智能体平台/ API参考/ API/ 沙箱工具/ 代码解释器管理/ 查询代码解释器列表 - ListCoreCodeInterpreters
更新时间:2026-09-24 GMT+08:00
分享

查询代码解释器列表 - ListCoreCodeInterpreters

功能介绍

该API用于查询代码解释器列表。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts:codeInterpreter:listCoreCodeInterpreters

List

-

-

-

-

URI

GET /v1/core/code-interpreters

表1 Query参数

参数

是否必选

参数类型

描述

name

否

String

参数解释:

按代码解释器名称过滤。

约束限制:

不涉及。

取值范围:

只能由小写字母、数字及中划线组成,长度在2-40个字符之间。

默认取值:

空。

offset

否

Integer

参数解释:

分页查询的偏移量,表示从第几条记录开始查询,用于分页场景。

约束限制:

不涉及。

取值范围:

非负整数,取值范围为0-100000。

默认取值:

0。

limit

否

Integer

参数解释:

分页查询时每页返回的记录数量,用于控制单次查询返回的数据量。

约束限制:

不涉及。

取值范围:

正整数,取值范围为1-1000。

默认取值:

1000。

sort_key

否

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

  • created_at:按创建时间排序。

  • updated_at:按更新时间排序。

默认取值:

created_at。

sort_dir

否

String

参数解释:

排序方向。

约束限制:

不涉及。

取值范围:

  • asc:升序排列。

  • desc:降序排列。

默认取值:

desc。

tag_key_exists

否

Array of strings

参数解释:

需要匹配的包含该标签名称的资源。

约束限制:

支持批量查询多个标签名,数组最小数量1,最大数量10。

tag_key_matches

否

Array of strings

参数解释:

需要匹配的包含该标签的资源。

约束限制:

需要和tag_value_matches条件配合使用,tag_key_matches和tag_value_matches的元素个数需要一致,且标签顺序需要完全匹配,不支持空字符串。支持批量查询多个标签,数组最小数量1,最大数量10。tag_key_matches和tag_value_matches键值对不可重复。

tag_value_matches

否

Array of strings

参数解释:

需要匹配的包含该标签的资源。

约束限制:

需要和tag_key_matches条件配合使用,tag_key_matches和tag_value_matches的元素个数需要一致,且标签顺序需要完全匹配,支持空字符串。支持批量查询多个标签,数组最小数量1,最大数量10。tag_key_matches和tag_value_matches键值对不可重复。

tag_match_policy

否

String

参数解释:

标签匹配模式,仅针对tag_key_exists,tag_key_matches,tag_value_matches参数生效。

  • ALL: 若请求中包含tag_key_exists参数,查询规则为资源标签需要包含tag_key_exists中的所有元素,若请求中tag_key_matches以及tag_value_matches参数存在,查询规则为资源标签需要包含所有tag_key_matches以及tag_value_matches参数中指定的key-value对应的标签。

  • ANY: 若请求中包含tag_key_exists参数,查询规则为资源标签需要包含tag_key_exists中的任意一个元素,若请求中tag_key_matches以及tag_value_matches参数存在,查询规则为资源标签需要包含tag_key_matches以及tag_value_matches参数中任意一个key-value对应的标签。

三个参数都存在时,取tag_key_exists和tag_key_matches,tag_value_matches的交集。

三个参数都存在时,取tag_key_exists和tag_key_matches,tag_value_matches的并集。

约束限制:

不涉及。

取值范围:

  • ALL

  • ANY

默认取值:

ALL。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

总记录数。

取值范围:

0到20。

items

Array of CoreToolBasic objects

参数解释:

查询列表数组。

取值范围:

不涉及。

表3 CoreToolBasic

参数

参数类型

描述

id

String

参数解释:

工具ID。

取值范围:

符合UUID规则^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$的36位字符串。

name

String

参数解释:

工具的名称。

取值范围:

符合正则^[a-z][a-z0-9-]{0,38}[a-z0-9]$,即必须以小写字母开头,小写字母或数字结尾,中间可包含数字、小写字母、中划线,字符长度必须在2-40个字符之间。

description

String

参数解释:

工具的描述。

取值范围:

任意字符,长度不能超过4096个字符

created_at

String

参数解释:

创建时间。使用ISO 8601格式,例如:2026-04-09T08:29:59.922+00:00。

取值范围:

不涉及。

updated_at

String

参数解释:

更新时间。使用ISO 8601格式,例如:2026-04-09T08:29:59.922+00:00。

取值范围:

不涉及。

execution_agency_name

String

参数解释:

为工具提供访问云服务的权限的IAM委托名。

取值范围:

IAM委托名长度必须在1-64个字符之间,字符规则以IAM服务校验规则为准。

agent_gateway_id

String

参数解释:

工具入口的AgentGateway的ID。

取值范围:

符合UUID规则 ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$的36位字符串。

workload_identity

CoreToolsWorkloadIdentity object

参数解释:

认证信息。

取值范围:

不涉及。

access_endpoint

String

参数解释:

访问域名。

取值范围:

不涉及。

observability

CoreToolsObservability object

参数解释:

可观测性信息。

取值范围:

不涉及。

tags

Array of CoreToolsTag objects

参数解释:

资源标签。

取值范围:

不涉及。

status

String

参数解释:

工具状态。

取值范围:

  • RUNNING:运行中。

  • DELETING:删除中。

  • DELETE_FAILED:删除失败。

表4 CoreToolsWorkloadIdentity

参数

参数类型

描述

urn

String

参数解释:

工作负载身份的URN。

取值范围:

不涉及。

表5 CoreToolsObservability

参数

参数类型

描述

logs

CoreToolsLogsConfig object

参数解释:

工具的日志配置。

取值范围:

不涉及。

metrics

CoreToolsMetricsObservabilityConfig object

参数解释:

工具的自定义指标采集详细配置。

取值范围:

不涉及。

tracing

CoreToolsTracingObservabilityConfig object

参数解释:

工具的调用链采集配置。

取值范围:

不涉及。

表6 CoreToolsLogsConfig

参数

参数类型

描述

enabled

Boolean

参数解释:

是否开启日志采集。

  • 未开启,工具运行过程产生的日志无法上报至云日志服务(LTS)。

  • 开启后,工具运行过程产生的日志会上报至云日志服务(LTS)。

取值范围:

  • true:开启日志采集;

  • false:关闭日志采集。

group_id

String

参数解释:

工具的日志组ID,当前不支持更新和指定。

取值范围:

长度不能超过64个字符。

stream_id

String

参数解释:

工具的日志流ID,当前不支持更新和指定。

取值范围:

长度不能超过64个字符。

表7 CoreToolsMetricsObservabilityConfig

参数

参数类型

描述

enabled

Boolean

参数解释:

是否开启自定义指标采集,默认为false即关闭。

取值范围:

  • true:开启自定义指标采集;

  • false:关闭自定义指标采集。

instance_id

String

参数解释:

自定义指标实例ID。

取值范围:

长度不能超过64个字符。

表8 CoreToolsTracingObservabilityConfig

参数

参数类型

描述

enabled

Boolean

参数解释:

是否开启调用链采集,默认为false即关闭。

取值范围:

  • true:开启调用链采集;

  • false:关闭调用链采集。

service_group

String

参数解释:

调用链服务组名。

取值范围:

长度不能超过64个字符。

表9 CoreToolsTag

参数

参数类型

描述

key

String

参数解释:

标签键,不能为空且同一资源下标签键不能重复。

取值范围:

符合规则^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}.:/=+-@]*)(?<!\s)$,即可以包含任意语种的字母、数字和空格,以及.:=+-@字符,但首尾不能包含空格,且不能以_sys_开头,且长度在1到128之间。

value

String

参数解释:

标签值。

取值范围:

符合规则^([\p{L}\p{Z}\p{N}.:/=+-@]*)$,即可以包含任意语种的字母、数字和空格,以及.:/=+-@字符,且长度不能超过255个字符。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:403

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

encoded_authorization_message

String

参数解释:

编码后的授权失败信息。

取值范围:

长度1到4096个字符。

details

Array of CoreToolsCommonError objects

参数解释:

依赖的下游服务错误信息列表。

取值范围:

数组长度0到10个元素。

表13 CoreToolsCommonError

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:404

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:429

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:500

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。

error_msg

String

参数解释:

错误信息。

取值范围:

符合正则:^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()'"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

请求示例

GET /v1/core/code-interpreters?name=demo

响应示例

状态码:200

OK。

{
  "items" : [ {
    "id" : "386ab51c-aaa0-4e7b-8c3f-60243a1e22fa",
    "name" : "asfasfasf",
    "description" : "zxvbzxb",
    "agent_gateway_id" : "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
    "observability" : {
      "logs" : {
        "enabled" : false
      }
    },
    "workload_identity" : {
      "urn" : "urn_demo"
    },
    "tags" : [ {
      "key" : "bbbbbbb",
      "value" : "zzzzzzzz"
    } ],
    "status" : "RUNNING",
    "created_at" : "2022-11-09 16:37:24",
    "updated_at" : "2022-11-09 16:37:24"
  } ],
  "total_count" : 1
}

状态码:400

请求参数错误。

{
  "error_code" : "AgentArts.04000400",
  "error_msg" : "Invalid parameter."
}

状态码:401

认证失败。

{
  "error_code" : "AgentArts.04000401",
  "error_msg" : "Authentication failed: invalid token."
}

状态码:403

权限不足。

{
  "error_code" : "AgentArts.04000403",
  "error_msg" : "Authentication failed: you have no permission of XXX",
  "encoded_authorization_message" : "eyJlcnJvciI6ICJVbmF1dGhvcml6ZWQifQ==",
  "details" : [ {
    "error_code" : "AgentArts.04000403",
    "error_msg" : "Authentication failed."
  } ]
}

状态码:404

资源不存在。

{
  "error_code" : "AgentArts.04000404",
  "error_msg" : "resource xxx not exist"
}

状态码:429

请求频率超限。

{
  "error_code" : "AgentArts.04000429",
  "error_msg" : "The interface has been limited."
}

状态码:500

内部系统错误。

{
  "error_code" : "AgentArts.04000500",
  "error_msg" : "Internal error"
}

状态码

状态码

描述

200

OK。

400

请求参数错误。

401

认证失败。

403

权限不足。

404

资源不存在。

429

请求频率超限。

500

内部系统错误。

错误码

请参见错误码。

相关文档