查询代码解释器列表 - ListCoreCodeInterpreters
功能介绍
该API用于查询代码解析器列表。
URI
GET /v1/core/code-interpreters
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 按代码解析器名称过滤。 约束范围: 不涉及 取值范围: 长度在1到48之间 默认取值: 空 |
| offset | 否 | Integer | 参数解释: 偏移。 约束限制: 不涉及。 取值范围: 正整数 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 限制数量。 约束限制: 不涉及。 取值范围: 正整数,最大值1000。 默认取值: 1000。 |
| sort_key | 否 | String | 参数解释: 排序字段 约束范围: 不涉及 取值范围: 必须是created_at或updated_at 默认取值: 缺省值为created_at |
| sort_dir | 否 | String | 参数解释: 排序方向 约束范围: 不涉及 取值范围: 必须是asc或desc 默认取值: 缺省值为desc |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: application/json 默认取值: application/json |
| Authorization | 是 | String | 参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Sdk-Date | 是 | String | 参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 总记录数。 取值范围: 正整数。 |
| items | Array of CoreCodeInterpreterBasic objects | 参数解释: 查询列表数组 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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,46}[a-z0-9]$,即必须以小写字母开头,小写字母或数字结尾,中间可包含数字、小写字母、中划线,字符长度必须在2-48个字符之间。 |
| description | String | 参数解释: 代码解释器的描述。 取值范围: 任意字符,长度不能超过4096个字符 |
| created_at | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 更新时间。 取值范围: 不涉及。 |
| 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 | 参数解释: 工具状态。 取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| logs | CoreToolsLogsConfig object | 参数解释: 工具的日志配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| metrics | 参数解释: 工具的自定义指标采集详细配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | |
| tracing | 参数解释: 工具的调用链采集配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启日志采集。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| group_id | String | 参数解释: 工具的日志组ID。 约束限制: 不涉及。 取值范围: 长度不能超过64个字符。 默认取值: 不涉及。 |
| stream_id | String | 参数解释: 工具的日志流ID。 约束限制: 不涉及。 取值范围: 长度不能超过64个字符。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启自定义指标采集。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| instance_id | String | 参数解释: 自定义指标实例ID。 约束限制: 不涉及。 取值范围: 长度不能超过64个字符。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释: 是否开启调用链采集。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| service_group | String | 参数解释: 调用链服务组名。 约束限制: 不涉及。 取值范围: 长度不能超过64个字符。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键。 约束限制: 不能为空,且单个资源标签键不能重复。 取值范围: 符合规则^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}.:/=+-@]*)(?<!\s)$,即可以包含任意语种的字母、数字和空格,以及.:=+-@字符,但首尾不能包含空格,且不能以_sys_开头,且长度在1到128之间。 默认取值: 不涉及。 |
| value | String | 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 符合规则^([\p{L}\p{Z}\p{N}.:/=+-@]*)$,即可以包含任意语种的字母、数字和空格,以及.:/=+-@字符,且长度不能超过255个字符。 默认取值: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息,可找IAM服务oncall提供解码方式获取详细授权失败原因。 取值范围: 不涉及。 |
| details | Array of CoreToolsCommonError objects | 参数解释: 依赖的下游服务错误信息列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则^AgentArts.0400\d{4}$,例如AgentArts.04000404。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
/v1/core/code-interpreters?name=demo
响应示例
状态码:200
OK。
{
"items" : [ {
"id" : "386ab51c-aaa0-xxxx-xxxx-60243a1e22fa",
"name" : "asfasfasf",
"description" : "zxvbzxb",
"agent_gateway_id" : "a1b2c3d4-xxxx-xxxx-abcd-ef1234567890",
"observability" : {
"logs" : {
"enabled" : false
}
},
"workload_identity" : {
"urn" : "urn_demo"
},
"tags" : [ {
"key" : "bbbbbbb",
"value" : "zzzzzzzz"
} ],
"created_at" : "2026-03-14T11:08:50.244+00:00",
"updated_at" : "2026-03-14T11:08:50.244+00:00"
} ],
"total_count" : 1
} 状态码:400
请求参数错误。
"{\n \"error_code\": \"AgentArts.04000400\",\n \"error_msg\": \"Invalid parameter.\"\n}" 状态码:401
认证失败。
"{\n \"error_code\": \"AgentArts.04000401\",\n \"error_msg\": \"Authentication failed: invalid token\"\n}" 状态码:403
权限不足。
"{\n \"error_code\": \"AgentArts.04000403\",\n \"error_msg\": \"Authentication failed: you have no permission of VCPEP.\",\n \"encoded_authorization_message\": \"eyJlcnJvciI6ICJVbmF1dGhvcml6ZWQifQ==\",\n \"details\": [\n {\n \"error_code\": \"EndPoint.0004\",\n \"error_msg\": \"Authentication information is incorrect or you have no permissions.\"\n }\n ]\n}" 状态码:404
资源不存在。
"\"{\\n \\\"error_code\\\": \\\"AgentArts.04000404\\\",\\n \\\"error_msg\\\": \\\"resource xxx not exist\\\"\\n}\"" 状态码:429
请求频率超限。
"{\n \"error_code\": \"AgentArts.04000429\",\n \"error_msg\": \"The interface has been limited.\"\n}" 状态码:500
内部系统错误。
"{\n \"error_code\": \"AgentArts.04000500\",\n \"error_msg\": \"Internal error\"\n}" 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 400 | 请求参数错误。 |
| 401 | 认证失败。 |
| 403 | 权限不足。 |
| 404 | 资源不存在。 |
| 429 | 请求频率超限。 |
| 500 | 内部系统错误。 |
错误码
请参见错误码。