数据结构

最近更新时间:2025-12-22 01:08:13

我的收藏

APIKeyInfo

API密钥简略信息

被如下接口引用:DescribeAPIKeyList。

名称 类型 必选 描述
Name String API密钥名称
示例值:LocalDev
KeyId String API密钥ID
示例值:ark-3edcft6y
Status String 密钥状态。可以为API_KEY_STATUS_ACTIVE,或API_KEY_STATUS_INACTIVE
示例值:API_KEY_STATUS_ACTIVE
MaskedKey String 隐藏部分字符的API密钥,方便用户辨认
示例值:ark_g9****ztdA
CreatedAt String API密钥创建时间
示例值:2025-09-12T09:00:03.094Z

CosStorageSource

沙箱实例对象存储挂载配置

被如下接口引用:CreateSandboxTool, DescribeSandboxToolList。

名称 类型 必选 描述
Endpoint String 对象存储访问域名
示例值:test-123456789.cos.ap-guangzhou.myqcloud.com
BucketName String 对象存储桶名称
示例值:test-123456789
BucketPath String 对象存储桶路径,必须为以/起始的绝对路径
示例值:/

Filter

过滤列表规则

被如下接口引用:DescribeSandboxInstanceList, DescribeSandboxToolList。

名称 类型 必选 描述
Name String 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
示例值:FILTER_KEY_NAME
Values Array of String 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。
示例值:["LocalDev"]

MountOption

沙箱实例存储挂载配置可选项,用于覆盖沙箱工具的存储配置的部分选项,并提供子路径挂载配置。

被如下接口引用:DescribeSandboxInstanceList, StartSandboxInstance。

名称 类型 必选 描述
Name String 指定沙箱工具中的存储配置名称
示例值:Storage1
MountPath String 沙箱实例本地挂载路径(可选),默认继承工具中的存储配置
示例值:/home/user
SubPath String 沙箱实例存储挂载子路径(可选)
示例值:workspace1
ReadOnly Boolean 沙箱实例存储挂载读写权限(可选),默认继承工具存储配置
示例值:false

NetworkConfiguration

沙箱网络配置

被如下接口引用:CreateSandboxTool, DescribeSandboxToolList, UpdateSandboxTool。

名称 类型 必选 描述
NetworkMode String 网络模式(当前支持 PUBLIC, VPC, SANDBOX)
示例值:PUBLIC
VpcConfig VPCConfig VPC网络相关配置

SandboxInstance

沙箱实例结构体

被如下接口引用:DescribeSandboxInstanceList, StartSandboxInstance。

名称 类型 必选 描述
InstanceId String 沙箱实例唯一标识符
示例值:sdi-xyz789abc123
ToolId String 所属沙箱工具 ID
示例值:sdt-def456ghi789
ToolName String 所属沙箱工具名称
示例值:code-interpreter-v1
Status String 实例状态:STARTING(启动中)、RUNNING(运行中)、STOPPING(停止中)、STOPPED(已停止)、STOP_FAILED(停止失败)、FAILED(失败状态)
示例值:RUNNING
TimeoutSeconds Integer 超时时间(秒),null 表示无超时设置
示例值:600
ExpiresAt String 过期时间(ISO 8601 格式),null 表示无过期时间
示例值:2024-01-01T10:30:00Z
StopReason String 停止原因:manual(手动)、timeout(超时)、error(错误)、system(系统),仅在状态为 STOPPED、STOP_FAILED 或 FAILED 时有值。当 provider 停止失败时,状态为 STOP_FAILED,原因为 error
示例值:timeout
CreateTime String 创建时间(ISO 8601 格式)
示例值:2024-01-01T10:00:00Z
UpdateTime String 更新时间(ISO 8601 格式)
示例值:2024-01-01T10:10:00Z
MountOptions Array of MountOption 存储挂载选项

SandboxTool

沙箱工具结构体

被如下接口引用:DescribeSandboxToolList。

名称 类型 必选 描述
ToolId String 沙箱工具唯一标识符
示例值:sdt-ee4ywozw
ToolName String 沙箱工具名称,长度 1-50 字符,支持中英文、数字、下划线。同一 AppId 下沙箱工具名称必须唯一
示例值:browser-sandbox
ToolType String 沙箱工具类型,取值:browser(浏览器工具)、code-interpreter(代码解释器工具)、computer(计算机控制工具)、mobile(移动设备工具)
示例值:browser
Status String 沙箱工具状态,取值:CREATING(创建中)、ACTIVE(可用)、DELETING(删除中)、FAILED(失败)
示例值:ACTIVE
Description String 沙箱工具描述信息,最大长度 200 字符
示例值:浏览器沙箱环境
DefaultTimeoutSeconds Integer 默认超时时间,支持格式:5m、300s、1h 等,不指定则使用系统默认值(5 分钟)。最大 24 小时
示例值:600
NetworkConfiguration NetworkConfiguration 网络配置
Tags Array of Tag 标签规格,包含资源标签绑定关系。用于为沙箱工具绑定标签,支持多种资源类型的标签绑定
CreateTime String 沙箱工具创建时间,格式:ISO8601
示例值:2024-01-15T10:30:00Z
UpdateTime String 沙箱工具更新时间,格式:ISO8601
示例值:2024-01-15T10:30:00Z
RoleArn String 沙箱工具绑定角色ARN
示例值:qcs::cam::uin/100000001:roleName/test_role
StorageMounts Array of StorageMount 沙箱工具中实例存储挂载配置

StorageMount

沙箱工具中实例存储挂载配置

被如下接口引用:CreateSandboxTool, DescribeSandboxToolList。

名称 类型 必选 描述
Name String 存储挂载配置名称
示例值:Storage1
StorageSource StorageSource 存储配置
MountPath String 沙箱实例本地挂载路径
示例值:/home/user
ReadOnly Boolean 存储挂载读写权限配置,默认为false
示例值:false

StorageSource

挂载存储配置

被如下接口引用:CreateSandboxTool, DescribeSandboxToolList。

名称 类型 必选 描述
Cos CosStorageSource 对象存储桶配置

Tag

标签

被如下接口引用:CreateSandboxTool, DescribeSandboxToolList, UpdateSandboxTool。

名称 类型 必选 描述
Key String 标签键
示例值:business
Value String 标签值
示例值:biz1

VPCConfig

沙箱工具VPC相关配置

被如下接口引用:CreateSandboxTool, DescribeSandboxToolList, UpdateSandboxTool。

名称 类型 必选 描述
SubnetIds Array of String VPC子网ID列表
示例值:["subnet-012abcde", "subnet-012edcba"]
SecurityGroupIds Array of String 安全组ID列表
示例值:["sg-abcde012", "sg-210edcba"]