创建代码解释器 - CreateCoreCodeInterpreter
功能介绍
该API用于创建一个代码解释器。
URI
POST /v1/core/code-interpreters
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 代码解释器的名称。 约束限制: 该名称在您的帐户中必须是唯一的。 取值范围: 符合正则条件^[a-z][a-z0-9-]{0,46}[a-z0-9]$,即必须以小写字母开头,小写字母或数字结尾,中间可包含数字、小写字母、中划线,字符长度必须在2-48个字符之间。 默认取值: 不涉及。 |
|
description |
否 |
String |
参数解释: 代码解释器的描述。 约束限制: 不涉及。 取值范围: 任意字符,长度不能超过4096个字符。 默认取值: 不涉及。 |
|
auth_type |
否 |
String |
参数解释: 工具认证方式。 约束限制: 不涉及。 取值范围: API_KEY: 使用 API 密钥认证。 默认取值: API_KEY。 |
|
api_key_name |
否 |
String |
参数解释: API Key名称。 约束限制: 不涉及。 取值范围: 满足正则^[a-zA-Z0-9_-]{1,64}$,即只能包含数字、字母、下划线、中划线,且长度必须在1-64个字符之间。 默认取值: 不涉及。 |
|
execution_agency_name |
否 |
String |
参数解释: 为代码解释器提供访问云服务的权限的IAM委托名。 约束限制: 必须是IAM已创建委托。 取值范围: IAM委托名长度必须在1-64个字符之间,字符规则以IAM服务校验规则为准。 默认取值: 不涉及。 |
|
observability |
否 |
CoreToolsObservability object |
参数解释: 可观测性配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
network_config |
否 |
CoreToolsOutboundNetwork object |
参数解释: 出方向网络配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
agent_gateway_id |
否 |
String |
参数解释: 代码解析器入口的AgentGateway的ID。 约束限制: 必须为已存在AgentGateway的ID,或者缺省为空,使用租户默认AgentGateway接入。 取值范围: 从AgentGateway实例获取,或默认不填。 默认取值: 不涉及。 |
|
tags |
否 |
Array of CoreToolsTag objects |
参数解释: 资源标签。 约束限制: 同一个资源的标签key不能重复、标签列表最多支持20个。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
network_mode |
是 |
String |
参数解释: 工具可以访问的网络类型。 约束限制: 2选1。 取值范围: 默认取值: 不涉及。 |
|
vpc_config |
否 |
CoreToolsVpcConfig object |
参数解释: 工具使用的VPC子网配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
vpc_id |
是 |
String |
参数解释: 工具使用的VPC的ID,获取方式请参见创建VPC。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
|
subnet_id |
是 |
String |
参数解释: 工具使用的VPC子网的ID,获取方式请参见创建VPC子网。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
|
security_group_ids |
否 |
Array of strings |
参数解释: 工具使用的安全组id列表,获取方式请参见创建安全组。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
参数解释: 标签键。 约束限制: 不能为空,且单个资源标签键不能重复。 取值范围: 符合规则^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}.:/=+-@]*)(?<!\s)$,即可以包含任意语种的字母、数字和空格,以及.:=+-@字符,但首尾不能包含空格,且不能以_sys_开头,且长度在1到128之间。 默认取值: 不涉及。 |
|
value |
是 |
String |
参数解释: 标签值。 约束限制: 不涉及。 取值范围: 符合规则^([\p{L}\p{Z}\p{N}.:/=+-@]*)$,即可以包含任意语种的字母、数字和空格,以及.:/=+-@字符,且长度不能超过255个字符。 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释: 工具状态。 取值范围: |
|
network_config |
CoreToolsOutboundNetwork object |
参数解释: 出方向网络配置。 取值范围: 不涉及。 |
|
auth_type |
String |
参数解释: 工具认证方式。 取值范围: API_KEY: 使用 API 密钥认证。 |
|
api_key_name |
String |
参数解释: API Key名称。 取值范围: 只能包含数字、字母、下划线、中划线,且长度必须在1-64个字符之间。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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个字符。 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
network_mode |
String |
参数解释: 工具可以访问的网络类型。 约束限制: 2选1。 取值范围: 默认取值: 不涉及。 |
|
vpc_config |
CoreToolsVpcConfig object |
参数解释: 工具使用的VPC子网配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vpc_id |
String |
参数解释: 工具使用的VPC的ID,获取方式请参见创建VPC。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
|
subnet_id |
String |
参数解释: 工具使用的VPC子网的ID,获取方式请参见创建VPC子网。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
|
security_group_ids |
Array of strings |
参数解释: 工具使用的安全组id列表,获取方式请参见创建安全组。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
状态码: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 |
参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:409
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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" : "codeinterpreter-demo",
"description" : "des",
"execution_agency_name" : "test-lw-2",
"auth_type" : "API_KEY",
"api_key_name" : "demo-key",
"observability" : {
"logs" : {
"enabled" : true
}
},
"network_config" : {
"network_mode" : "PUBLIC"
}
}
响应示例
状态码:200
创建成功。
{
"id" : "306b7c12-a069-xxxx-xxxx-692f010cc37b",
"name" : "codeinterpreter-demo",
"description" : "des",
"auth_type" : "API_KEY",
"api_key_name" : "demo-key",
"execution_agency_name" : "test-lw-2",
"agent_gateway_id" : "6f763601-xxxx-xxxx-8924-d2c3042db5a9",
"observability" : {
"logs" : {
"enabled" : true
},
"metrics" : {
"enabled" : false
},
"tracing" : {
"enabled" : false
}
},
"network_config" : {
"network_mode" : "PUBLIC"
},
"workload_identity" : {
"urn" : "agentIdentity:cn-southwest-301:6c23f0482xxxxx42dab176dc:workloadIdentity:workloadIdentityDirectory/default/codeinterpreter-codeinterpreter-demo"
},
"access_endpoint" : "agentarts-test1-gztdonrtgy.agentgateway1.cn-southwest-301.huaweicloud-agentnetwork.com",
"created_at" : "2026-04-09T08:29:59.922+00:00",
"updated_at" : "2026-04-09T08:29:59.922+00:00"
}
状态码: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}"
状态码:409
操作冲突。
"{\n \"error_code\": \"AgentArts.04000409\",\n \"error_msg\": \"operation conflict\"\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 |
创建成功。 |
|
400 |
请求参数错误。 |
|
401 |
认证失败。 |
|
403 |
权限不足。 |
|
404 |
资源不存在。 |
|
409 |
操作冲突。 |
|
429 |
请求频率超限。 |
|
500 |
内部系统错误。 |
错误码
请参见错误码。