/** * PauseSandboxInstance返回参数结构体 */ export interface PauseSandboxInstanceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PauseSandboxInstance请求参数结构体 */ export interface PauseSandboxInstanceRequest { /** *
沙箱实例ID
*/ InstanceId: string; } /** * 沙箱实例对象存储挂载配置 */ export interface CosStorageSource { /** * 对象存储访问域名 */ Endpoint?: string; /** * 对象存储桶名称 */ BucketName?: string; /** * 对象存储桶路径,必须为以/起始的绝对路径 */ BucketPath?: string; } /** * StartSandboxInstance请求参数结构体 */ export interface StartSandboxInstanceRequest { /** *沙箱工具 ID,与 ToolName 至少有一个要填
*/ ToolId?: string; /** *沙箱工具名称,与 ToolId 至少有一个要填
*/ ToolName?: string; /** *超时时间,超过这个时间就自动回收实例。支持格式:5m、300s、1h 等,默认 5m。最小 30s,最大 24h
*/ Timeout?: string; /** *幂等性 Token,长度不超过 64 字符
*/ ClientToken?: string; /** *沙箱实例存储挂载配置
*/ MountOptions?: Array沙箱实例自定义配置
*/ CustomConfiguration?: CustomConfiguration; /** *沙箱访问认证模式
枚举值:
默认值:DEFAULT
*/ AuthMode?: string; /** *沙箱元数据
*/ Metadata?: Array沙箱实例唯一标识符
*/ InstanceId: string; /** *所属沙箱工具 ID
*/ ToolId: string; /** *所属沙箱工具名称
*/ ToolName: string; /** *实例状态:STARTING(启动中)、RUNNING(运行中)、STOPPING(停止中)、STOPPED(已停止)、STOP_FAILED(停止失败)、FAILED(失败状态)
*/ Status: string; /** *是否常驻实例
*/ Persistent?: boolean; /** *超时时间(秒),null 表示无超时设置
*/ TimeoutSeconds?: number; /** *过期时间(ISO 8601 格式),null 表示无过期时间
*/ ExpiresAt?: string; /** *停止原因:manual(手动)、timeout(超时)、error(错误)、system(系统),仅在状态为 STOPPED、STOP_FAILED 或 FAILED 时有值。当 provider 停止失败时,状态为 STOP_FAILED,原因为 error
*/ StopReason?: string; /** *创建时间(ISO 8601 格式)
*/ CreateTime?: string; /** *更新时间(ISO 8601 格式)
*/ UpdateTime?: string; /** *存储挂载选项
*/ MountOptions?: Array沙箱实例自定义配置
*/ CustomConfiguration?: CustomConfigurationDetail; /** *网络模式
枚举值:
可以覆盖工具级别的网络配置。但如果一个工具本身就不支持 VPC 网络,那么即便在实例设置里选了 VPC 模式,也是无效的
*/ NetworkMode?: string; /** *沙箱实例元数据
*/ Metadata?: Array沙箱工具名称,长度 1-50 字符,支持英文、数字、下划线和连接线。同一 AppId 下沙箱工具名称必须唯一
*/ ToolName: string; /** *沙箱工具类型,目前支持:browser、code-interpreter、custom
*/ ToolType: string; /** *网络配置
*/ NetworkConfiguration: NetworkConfiguration; /** *沙箱工具描述,最大长度 200 字符
*/ Description?: string; /** *默认超时时间,支持格式:5m、300s、1h 等,不指定则使用系统默认值(5 分钟)。最大 24 小时
*/ DefaultTimeout?: string; /** *标签规格,为沙箱工具绑定标签,支持多种资源类型的标签绑定
*/ Tags?: Array幂等性 Token,长度不超过 64 字符
*/ ClientToken?: string; /** *角色ARN
*/ RoleArn?: string; /** *沙箱工具存储配置
*/ StorageMounts?: Array沙箱工具自定义配置
*/ CustomConfiguration?: CustomConfiguration; /** *沙箱工具日志推送相关配置
*/ LogConfiguration?: LogConfiguration; /** *常驻沙箱标识
*/ Persistent?: boolean; } /** * HTTP GET 探测动作配置 */ export interface HttpGetAction { /** * 路径 */ Path?: string; /** * 端口 */ Port?: number; /** * 协议 */ Scheme?: string; } /** * DescribePreCacheImageTask返回参数结构体 */ export interface DescribePreCacheImageTaskResponse { /** * 镜像地址 */ Image?: string; /** * 镜像 Digest */ ImageDigest?: string; /** * 镜像仓库类型:`enterprise`、`personal`。 */ ImageRegistryType?: string; /** * 镜像预热状态 */ Status?: string; /** * 镜像预热状态描述 */ Message?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResumeSandboxInstance请求参数结构体 */ export interface ResumeSandboxInstanceRequest { /** * 沙箱实例ID */ InstanceId: string; } /** * DeleteAPIKey返回参数结构体 */ export interface DeleteAPIKeyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * API密钥简略信息 */ export interface APIKeyInfo { /** * API密钥名称 */ Name?: string; /** * API密钥ID */ KeyId?: string; /** * 密钥状态。可以为API_KEY_STATUS_ACTIVE,或API_KEY_STATUS_INACTIVE */ Status?: string; /** * 隐藏部分字符的API密钥,方便用户辨认 */ MaskedKey?: string; /** * API密钥创建时间 */ CreatedAt?: string; } /** * UpdateSandboxInstance返回参数结构体 */ export interface UpdateSandboxInstanceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePreCacheImageTask请求参数结构体 */ export interface DescribePreCacheImageTaskRequest { /** * 镜像地址 */ Image: string; /** * 镜像 Digest */ ImageDigest: string; /** * 镜像仓库类型:`enterprise`、`personal`。 */ ImageRegistryType: string; } /** * 挂载存储配置 */ export interface StorageSource { /** *对象存储桶配置
*/ Cos?: CosStorageSource; /** *镜像卷配置
*/ Image?: ImageStorageSource; /** *文件存储配置
*/ Cfs?: CfsStorageSource; } /** * 资源配置 */ export interface ResourceConfiguration { /** * cpu 资源量 */ CPU?: string; /** * 内存资源量 */ Memory?: string; } /** * CreateSandboxTool返回参数结构体 */ export interface CreateSandboxToolResponse { /** *创建的沙箱工具 ID
*/ ToolId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAPIKey请求参数结构体 */ export interface CreateAPIKeyRequest { /** * API密钥名称,方便用户记忆 */ Name?: string; } /** * 沙箱网络配置 */ export interface NetworkConfiguration { /** * 网络模式(当前支持 PUBLIC, VPC, SANDBOX) */ NetworkMode: string; /** * VPC网络相关配置 */ VpcConfig?: VPCConfig; } /** * DeleteSandboxTool返回参数结构体 */ export interface DeleteSandboxToolResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 端口配置 */ export interface PortConfiguration { /** * 端口名 */ Name?: string; /** * 端口 */ Port?: number; /** * 协议 */ Protocol?: string; } /** * 沙箱自定义 dns 配置 */ export interface DNSConfig { /** *DNS 服务器地址
参数格式:需要有效 IP 地址
默认值:10.0.0.1
*/ Servers: Array搜索域(对应 resolv.conf 的 search 指令)
*/ Searches?: Array配置项(对应 resolv.conf 选项)
*/ Options?: Array沙箱工具唯一标识符
*/ ToolId: string; /** *沙箱工具名称,长度 1-50 字符,支持中英文、数字、下划线。同一 AppId 下沙箱工具名称必须唯一
*/ ToolName?: string; /** *沙箱工具类型,取值:browser(浏览器工具)、code-interpreter(代码解释器工具)、computer(计算机控制工具)、mobile(移动设备工具)
*/ ToolType?: string; /** *沙箱工具状态,取值:CREATING(创建中)、ACTIVE(可用)、DELETING(删除中)、FAILED(失败)
*/ Status?: string; /** *沙箱工具描述信息,最大长度 200 字符
*/ Description?: string; /** *是否常驻沙箱
*/ Persistent?: boolean; /** *默认超时时间,支持格式:5m、300s、1h 等,不指定则使用系统默认值(5 分钟)。最大 24 小时
*/ DefaultTimeoutSeconds?: number; /** *网络配置
*/ NetworkConfiguration?: NetworkConfiguration; /** *标签规格,包含资源标签绑定关系。用于为沙箱工具绑定标签,支持多种资源类型的标签绑定
*/ Tags?: Array沙箱工具创建时间,格式:ISO8601
*/ CreateTime?: string; /** *沙箱工具更新时间,格式:ISO8601
*/ UpdateTime?: string; /** *沙箱工具绑定角色ARN
*/ RoleArn?: string; /** *沙箱工具中实例存储挂载配置
*/ StorageMounts?: Array沙箱工具自定义配置
*/ CustomConfiguration?: CustomConfigurationDetail; /** *沙箱工具日志推送相关配置
*/ LogConfiguration?: LogConfiguration; /** *用于说明沙箱工具处于该状态的原因
*/ StatusReason?: string; } /** * 沙箱实例存储挂载配置可选项,用于覆盖沙箱工具的存储配置的部分选项,并提供子路径挂载配置。 */ export interface MountOption { /** * 指定沙箱工具中的存储配置名称 */ Name?: string; /** * 沙箱实例本地挂载路径(可选),默认继承工具中的存储配置 */ MountPath?: string; /** * 沙箱实例存储挂载子路径(可选) */ SubPath?: string; /** * 沙箱实例存储挂载读写权限(可选),默认继承工具存储配置 */ ReadOnly?: boolean; } /** * 过滤列表规则 */ export interface Filter { /** * 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 */ Name?: string; /** * 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 */ Values?: Array创建的沙箱实例完整信息
*/ Instance?: SandboxInstance; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 沙箱自定义配置 */ export interface CustomConfiguration { /** *镜像地址
*/ Image?: string; /** *镜像仓库类型:enterprise、personal。
启动命令
*/ Command?: Array启动参数
*/ Args?: Array环境变量
*/ Env?: Array端口配置
*/ Ports?: Array资源配置
*/ Resources?: ResourceConfiguration; /** *探针配置
*/ Probe?: ProbeConfiguration; /** *沙箱 DNS 配置
*/ DNSConfig?: DNSConfig; } /** * 镜像卷挂载源配置 */ export interface ImageStorageSource { /** * 镜像地址 */ Reference?: string; /** * 镜像仓库类型:`enterprise`、`personal`。 */ ImageRegistryType?: string; /** * 镜像内部的路径 */ SubPath?: string; /** * 镜像 Digest,请求时无需传入 */ Digest?: string; } /** * AcquireSandboxInstanceToken请求参数结构体 */ export interface AcquireSandboxInstanceTokenRequest { /** * 沙箱实例ID,生成的访问Token将仅可用于访问此沙箱实例 */ InstanceId: string; } /** * 日志源配置 */ export interface LogSources { /** *需要采集的日志文件路径,必须是 /logs/ 目录下的文件,不支持子目录,最大支持 10 个文件。
注意:此字段可能返回 null,表示取不到有效值。 */ Files?: Array镜像地址
*/ Image?: string; /** *镜像仓库类型:TCR、CCR。
镜像 Digest
*/ ImageDigest?: string; /** *启动命令
*/ Command?: Array启动参数
*/ Args?: Array环境变量
*/ Env?: Array端口配置
*/ Ports?: Array资源配置
*/ Resources?: ResourceConfiguration; /** *探针配置
*/ Probe?: ProbeConfiguration; /** *沙箱 DNS 配置
*/ DNSConfig?: DNSConfig; } /** * DescribeAPIKeyList请求参数结构体 */ export type DescribeAPIKeyListRequest = null; /** * UpdateSandboxInstance请求参数结构体 */ export interface UpdateSandboxInstanceRequest { /** *沙箱实例ID
*/ InstanceId: string; /** *新的超时时间(从设置时开始重新计算超时),支持格式:5m、300s、1h等。最小30s,最大24h。如果不指定则保持原有超时设置
*/ Timeout?: string; /** *沙箱实例元数据
*/ Metadata?: Array日志推送CLS的配置。
*/ CLSConfig?: CLSConfig; /** *日志源配置
*/ LogSources?: LogSources; } /** * metadata 项 */ export interface MetadataVar { /** *沙箱元数据名
*/ Name?: string; /** *沙箱元数据值
*/ Value?: string; } /** * 标签 */ export interface Tag { /** * 标签键 */ Key?: string; /** * 标签值 */ Value?: string; } /** * UpdateSandboxTool请求参数结构体 */ export interface UpdateSandboxToolRequest { /** * 沙箱工具ID */ ToolId: string; /** * 沙箱工具描述,最大长度200字符 */ Description?: string; /** * 网络配置 */ NetworkConfiguration?: NetworkConfiguration; /** * 标签 */ Tags?: Array