/** * DeleteSessionSpace返回参数结构体 */ export interface DeleteSessionSpaceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Deployment 对 Sandbox Instance 的亲和配置。 */ export interface AffinityConfiguration { /** *

Affinity 模式。

枚举值:

缺失或空字符串表示关闭 Affinity。

*/ Mode?: string; /** *

请求和响应使用的 Affinity Header 名称。必须符合 HTTP field-name token 语法,长度为 1..128 个 ASCII 字节,且不能使用平台保留 Header。

*/ HeaderName?: string; } /** * ApproveRegistryRecord请求参数结构体 */ export type ApproveRegistryRecordRequest = null; /** * AppendEvent返回参数结构体 */ export interface AppendEventResponse { /** *

事件信息。

*/ Event?: EventInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistryRecord返回参数结构体 */ export interface DescribeRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSandboxToolList请求参数结构体 */ export interface DescribeSandboxToolListRequest { /** * 沙箱工具ID列表,指定要查询的工具。如果为空则查询所有工具。最大支持100个ID */ ToolIds?: Array; /** * 偏移量,默认为0 */ Offset?: number; /** * 返回数量,默认为20,最大值为100 */ Limit?: number; /** * 过滤条件 */ Filters?: Array; } /** * CreatePreCacheImageTask返回参数结构体 */ export interface CreatePreCacheImageTaskResponse { /** *

镜像地址

*/ Image?: string; /** *

镜像 Digest

*/ ImageDigest?: string; /** *

镜像仓库类型:enterprise、personal。

*/ ImageRegistryType?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 主账号资源信息 */ export interface QuotaResourceInfo { /** *

沙箱工具配额或当前用量

单位:个

*/ SandboxTools?: number; /** *

沙箱实例配额或当前用量

单位:个

*/ SandboxInstances?: number; /** *

暂停实例配额或当前用量

单位:个

*/ PausedInstances?: number; /** *

暂停实例配额或当前用量。目前只在主账号中返回

单位:核

*/ CPUCores?: number; /** *

内存配额或当前用量

单位:GiB

*/ MemoryGiB?: number; } /** * ResumeSandboxInstance请求参数结构体 */ export interface ResumeSandboxInstanceRequest { /** *

沙箱实例ID

*/ InstanceId: string; /** *

超时时间,超过这个时间就自动回收实例。支持格式:5m、300s、1h 等,默认 5m。最小 30s,最大 24h

*/ Timeout?: string; } /** * ModifySessionSpace返回参数结构体 */ export interface ModifySessionSpaceResponse { /** *

修改后的会话空间信息。

*/ SessionSpace?: SessionSpaceInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePreCacheImageTask请求参数结构体 */ export interface DescribePreCacheImageTaskRequest { /** *

镜像地址

*/ Image: string; /** *

镜像 Digest

*/ ImageDigest: string; /** *

镜像仓库类型:enterprise、personal、custom 。

枚举值:

*/ ImageRegistryType: string; } /** * DescribeDeployment返回参数结构体 */ export interface DescribeDeploymentResponse { /** *

完整 Deployment。

*/ Deployment?: Deployment; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RejectRegistryRecord返回参数结构体 */ export interface RejectRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 沙箱自定义 dns 配置 */ export interface DNSConfig { /** *

DNS 服务器地址

参数格式:需要有效 IP 地址

默认值:10.0.0.1

*/ Servers: Array; /** *

搜索域(对应 resolv.conf 的 search 指令)

*/ Searches?: Array; /** *

配置项(对应 resolv.conf 选项)

*/ Options?: Array; } /** * DescribeRegistryRecordList请求参数结构体 */ export type DescribeRegistryRecordListRequest = null; /** * UpdateRegistry返回参数结构体 */ export interface UpdateRegistryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ApproveRegistryRecord返回参数结构体 */ export interface ApproveRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSession请求参数结构体 */ export interface DeleteSessionRequest { /** *

会话所属空间 ID。

*/ SpaceId: string; /** *

用户 ID。可通过调用方业务系统接口获取。

*/ UserId: string; /** *

会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。

*/ SessionId: string; /** *

Agent ID。可选。

* @deprecated */ AgentId?: string; } /** * ResumeSandboxInstance返回参数结构体 */ export interface ResumeSandboxInstanceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AcquireSandboxInstanceToken请求参数结构体 */ export interface AcquireSandboxInstanceTokenRequest { /** *

沙箱实例ID,生成的访问Token将仅可用于访问此沙箱实例

*/ InstanceId: string; } /** * DescribeAPIKeyList返回参数结构体 */ export interface DescribeAPIKeyListResponse { /** * API密钥简略信息列表。 */ APIKeySet?: Array; /** * 列表中API密钥数量 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PreviewRegistryRecord返回参数结构体 */ export interface PreviewRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSession请求参数结构体 */ export interface CreateSessionRequest { /** *

会话所属空间 ID。

*/ SpaceId: string; /** *

用户 ID。可通过调用方业务系统接口获取。

*/ UserId: string; /** *

Agent ID。可选。

* @deprecated */ AgentId?: string; /** *

会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。

*/ SessionId?: string; /** *

会话标题,最大长度 256 字符。

*/ Title?: string; /** *

初始会话状态。

*/ State?: SessionState; /** *

创建会话时设置的初始元数据,以键值对数组形式表示。每个元素包含 Metadata 名称和对应值。

入参限制:本参数可选,最多支持 64 项。Name 不能为空或重复,最大长度为 253 字节;Value 最大长度为 1024 字节,允许为空字符串。Metadata 序列化后的总大小不能超过 64 KiB。

*/ Metadata?: Array; } /** * DescribeDeployment请求参数结构体 */ export interface DescribeDeploymentRequest { /** *

待查询的 Deployment ID。

*/ DeploymentId: string; } /** * 资源配置 */ export interface ResourceConfiguration { /** *

cpu 资源量

*/ CPU?: string; /** *

内存资源量

*/ Memory?: string; /** *

自定义磁盘大小

枚举值:

  • 1Gi: 1Gi
  • 5Gi: 5Gi
  • 10Gi: 10Gi
  • 20Gi: 20Gi
注意:此字段可能返回 null,表示取不到有效值。 */ Storage?: string; } /** * DescribeSessionSpace返回参数结构体 */ export interface DescribeSessionSpaceResponse { /** *

查询到的会话空间信息。

*/ SessionSpace?: SessionSpaceInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSandboxTool请求参数结构体 */ export interface DeleteSandboxToolRequest { /** * 沙箱工具ID */ ToolId: string; } /** * 沙箱工具VPC相关配置 */ export interface VPCConfig { /** *

VPC子网ID列表

*/ SubnetIds?: Array; /** *

安全组ID列表

*/ SecurityGroupIds?: Array; } /** * CreateRegistry返回参数结构体 */ export interface CreateRegistryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAPIKey请求参数结构体 */ export interface DeleteAPIKeyRequest { /** * 需要删除的API密钥ID */ KeyId: string; } /** * 健康检查探针配置 */ export interface ProbeConfiguration { /** * HTTP GET 探测配置 */ HttpGet?: HttpGetAction; /** * 健康检查就绪超时 */ ReadyTimeoutMs?: number; /** * 健康检查单次探测超时 */ ProbeTimeoutMs?: number; /** * 健康检查间隔 */ ProbePeriodMs?: number; /** * 健康检查成功阈值 */ SuccessThreshold?: number; /** * 健康检查失败阈值 */ FailureThreshold?: number; } /** * DeleteDeployment请求参数结构体 */ export interface DeleteDeploymentRequest { /** *

待删除的 Deployment ID。

*/ DeploymentId: string; } /** * GetSkillPackageUploadURL请求参数结构体 */ export type GetSkillPackageUploadURLRequest = null; /** * UpdateSandboxTool请求参数结构体 */ export interface UpdateSandboxToolRequest { /** *

沙箱工具ID

*/ ToolId: string; /** *

沙箱工具描述,最大长度200字符

*/ Description?: string; /** *

网络配置

*/ NetworkConfiguration?: NetworkConfiguration; /** *

标签

*/ Tags?: Array; /** *

沙箱工具自定义配置

*/ CustomConfiguration?: CustomConfiguration; /** *

桌面电脑环境类沙箱配置

*/ ComputerConfiguration?: ComputerConfiguration; } /** * DescribeSessionSpaces返回参数结构体 */ export interface DescribeSessionSpacesResponse { /** *

会话空间列表。

*/ SessionSpaces?: Array; /** *

满足查询条件的会话空间总数。

*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSandboxInstanceList返回参数结构体 */ export interface DescribeSandboxInstanceListResponse { /** *

沙箱实例列表

*/ InstanceSet?: Array; /** *

符合条件的实例总数

*/ TotalCount?: number; /** *

如果NextToken返回非空字符串 ,表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。

*/ NextToken?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopSandboxInstance返回参数结构体 */ export interface StopSandboxInstanceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistryRecordVersionList返回参数结构体 */ export interface DescribeRegistryRecordVersionListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistryRecordVersionList请求参数结构体 */ export type DescribeRegistryRecordVersionListRequest = null; /** * RejectRegistryRecord请求参数结构体 */ export type RejectRegistryRecordRequest = null; /** * CreateDeployment请求参数结构体 */ export interface CreateDeploymentRequest { /** *

唯一的 Deployment 名称,必须符合 DNS-1123 命名规范,创建后不可修改。

*/ DeploymentName: string; /** *

用于关联 Sandbox Tool 的标识,格式为 sdt- 加 8 位小写 base36 字符。

*/ ToolId?: string; /** *

伸缩配置;省略的成员由服务端补全默认值。

*/ ScalingConfiguration?: ScalingConfiguration; /** *

空闲生命周期配置;省略的成员由服务端补全默认值。

*/ LifecycleConfiguration?: LifecycleConfiguration; /** *

Affinity 配置;省略或空 Mode 表示不启用。

*/ AffinityConfiguration?: AffinityConfiguration; /** *

标签

*/ Tags?: Array; } /** * 文件存储配置 */ export interface CfsStorageSource { /** * CFS资源ID */ FileSystemId?: string; /** * CFS挂载路径 */ Path?: string; } /** * StopSandboxInstance请求参数结构体 */ export interface StopSandboxInstanceRequest { /** * 沙箱实例ID */ InstanceId: string; } /** * GetSkillPackageDownloadURL请求参数结构体 */ export type GetSkillPackageDownloadURLRequest = null; /** * DeleteSandboxTool返回参数结构体 */ export interface DeleteSandboxToolResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 会话信息 */ export interface SessionInfo { /** *

会话 ID。

*/ SessionId?: string; /** *

会话所属空间 ID。

*/ SpaceId?: string; /** *

Session 快照状态

*/ State?: SessionState; /** *

会话元数据,以键值对数组形式表示。每个元素包含 Metadata 名称和对应值,最多支持 64 项。

*/ Metadata?: Array; /** *

Agent ID。

* @deprecated */ AgentId?: string; /** *

用户 ID。

*/ UserId?: string; /** *

会话标题。

*/ Title?: string; /** *

事件数量。

*/ EventCount?: number; /** *

创建时间。

*/ CreateTime?: string; /** *

更新时间。

*/ UpdateTime?: string; } /** * DescribeQuotaOverview返回参数结构体 */ export interface DescribeQuotaOverviewResponse { /** *

主账号配额上限及全账号当前用量

*/ AccountQuotaOverview?: AccountQuotaOverview; /** *

当前分页下的配额组配额与用量列表。没有数据时返回空数组。

*/ QuotaGroupSet?: Array; /** *

满足过滤条件的配额组总数,不受当前分页大小影响。

单位:个

*/ TotalCount?: number; /** *

本次查询完成时间,格式为 RFC3339

*/ DataTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateSandboxTool返回参数结构体 */ export interface UpdateSandboxToolResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 文件内容数据信息 */ export interface InlineDataInfo { /** * 媒体类型,最大长度 128 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ MimeType?: string; /** * Base64 编码数据,最大长度 8192 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: string; } /** * DescribeRegistryRecord请求参数结构体 */ export type DescribeRegistryRecordRequest = null; /** * CancelRegistryRecord请求参数结构体 */ export type CancelRegistryRecordRequest = null; /** * 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; } /** * 挂载存储配置 */ export interface StorageSource { /** *

对象存储桶配置

*/ Cos?: CosStorageSource; /** *

镜像卷配置

*/ Image?: ImageStorageSource; /** *

文件存储配置

*/ Cfs?: CfsStorageSource; /** *

AgentBucket 存储配置

*/ AgentBucket?: AgentBucketStorageSource; } /** * CreateSandboxTool返回参数结构体 */ export interface CreateSandboxToolResponse { /** *

创建的沙箱工具 ID

*/ ToolId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAPIKey请求参数结构体 */ export interface CreateAPIKeyRequest { /** * API密钥名称,方便用户记忆 */ Name?: string; } /** * DescribeSandboxToolList返回参数结构体 */ export interface DescribeSandboxToolListResponse { /** * 沙箱工具列表 */ SandboxToolSet?: Array; /** * 符合条件的沙箱工具总数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 沙箱工具结构体 */ export interface SandboxTool { /** *

沙箱工具唯一标识符

*/ 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; /** *

桌面电脑环境类沙箱配置

*/ ComputerConfiguration?: ComputerConfiguration; /** *

用于说明沙箱工具处于该状态的原因

*/ StatusReason?: string; } /** * CreateRegistryRecord返回参数结构体 */ export interface CreateRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述会话空间的完整信息。会话空间是用户状态、会话和事件的上级资源及隔离边界,同一个会话只能属于一个会话空间。 */ export interface SessionSpaceInfo { /** *

会话空间唯一标识,由服务端生成,最大长度为 128 个字符。调用方不应自行构造或解析。

*/ SpaceId?: string; /** *

会话空间名称,用于标识会话空间的业务用途,最大长度为 128 个字符。

*/ Name?: string; /** *

会话空间描述,用于说明业务用途和使用范围,最大长度为 512 个字符。为空时该字段可能不返回

*/ Description?: string; /** *

会话空间当前状态。

枚举值:

  • Active: 正常可用
  • Deleting: 正在删除
*/ Status?: string; /** *

是否为系统默认会话空间。true 表示默认会话空间,false 表示普通会话空间。默认会话空间不允许删除。

*/ Default?: boolean; /** *

会话空间创建时间,采用 ISO 8601/RFC 3339 格式。

*/ CreateTime?: string; /** *

会话空间最后更新时间,采用 ISO 8601/RFC 3339 格式。

*/ UpdateTime?: string; } /** * UpdateSandboxInstance请求参数结构体 */ export interface UpdateSandboxInstanceRequest { /** *

沙箱实例ID

*/ InstanceId: string; /** *

新的超时时间(从设置时开始重新计算超时),支持格式:5m、300s、1h等。最小30s,最大24h。如果不指定则保持原有超时设置

*/ Timeout?: string; /** *

沙箱实例元数据

*/ Metadata?: Array; } /** * ModifySession请求参数结构体 */ export interface ModifySessionRequest { /** *

会话所属的 SessionSpace ID。

*/ SpaceId: string; /** *

会话所属的用户 ID。

*/ UserId: string; /** *

待修改的会话 ID。

*/ SessionId: string; /** *

修改后的会话标题。

入参限制:本参数可选,最大长度为 255 个字符。

不传表示保持原会话标题不变,传空字符串表示清空会话标题。Title 与 Metadata 至少传入一项。

*/ Title?: string; /** *

修改后的完整会话元数据,以键值对数组形式表示。

入参限制:本参数可选,最多支持 64 项。Name 不能为空或重复,最大长度为 253 字节;Value 最大长度为 1024 字节,允许为空字符串。Metadata 序列化后的总大小不能超过 64 KiB。

不传表示保持原 Metadata 不变;传空数组表示清空全部 Metadata;传非空数组表示使用传入内容全量覆盖原 Metadata。Metadata 与 Title 至少传入一项。

*/ Metadata?: Array; } /** * 沙箱自定义配置 */ export interface CustomConfiguration { /** *

镜像地址

*/ Image?: string; /** *

镜像仓库类型:enterprise、personal、custom

枚举值:

  • enterprise: tcr 企业容器镜像服务
  • personal: ccr 个人容器镜像服务
*/ ImageRegistryType?: string; /** *

启动命令

*/ Command?: Array; /** *

启动参数

*/ Args?: Array; /** *

环境变量

*/ Env?: Array; /** *

端口配置

*/ Ports?: Array; /** *

资源配置

*/ Resources?: ResourceConfiguration; /** *

探针配置

*/ Probe?: ProbeConfiguration; /** *

沙箱 DNS 配置

*/ DNSConfig?: DNSConfig; } /** * SyncRegistryRecord请求参数结构体 */ export type SyncRegistryRecordRequest = null; /** * 日志源配置 */ export interface LogSources { /** *

需要采集的日志文件路径,必须是 /logs/ 目录下的文件,不支持子目录,最大支持 10 个文件。

注意:此字段可能返回 null,表示取不到有效值。 */ Files?: Array; } /** * DescribeSession请求参数结构体 */ export interface DescribeSessionRequest { /** *

会话所属空间 ID。

*/ SpaceId: string; /** *

用户 ID。可通过调用方业务系统接口获取。

*/ UserId: string; /** *

会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。

*/ SessionId: string; /** *

Agent ID。可选。

* @deprecated */ AgentId?: string; /** *

返回最近事件数量,默认为 0,最大值为 200。

*/ NumRecentEvents?: number; /** *

事件起始时间,RFC3339 格式,最大长度 64 字符。

*/ AfterTimestamp?: string; } /** * DeleteRegistry返回参数结构体 */ export interface DeleteRegistryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAPIKeyList请求参数结构体 */ export type DescribeAPIKeyListRequest = null; /** * DescribeSessionSpace请求参数结构体 */ export interface DescribeSessionSpaceRequest { /** *

需要查询的会话空间唯一标识。

入参限制:必填,不能为空。

可通过 CreateSessionSpace 或 DescribeSessionSpaces 获取,不应自行构造。

*/ SpaceId: string; } /** * 事件信息 */ export interface EventInfo { /** *

事件 ID。为空时由服务生成。

注意:此字段可能返回 null,表示取不到有效值。 */ EventId?: string; /** *

调用 ID,最大长度 128 字符。

注意:此字段可能返回 null,表示取不到有效值。 */ InvocationId?: string; /** *

事件作者,最大长度 128 字符。

注意:此字段可能返回 null,表示取不到有效值。 */ Author?: string; /** *

事件内容。

注意:此字段可能返回 null,表示取不到有效值。 */ Content?: EventContentInfo; /** *

事件动作信息。StateDelta 为 JSON 对象字符串

注意:此字段可能返回 null,表示取不到有效值。 */ Actions?: EventActionsInfo; /** *

事件元数据。

注意:此字段可能返回 null,表示取不到有效值。 */ Metadata?: string; /** *

事件扩展信息 JSON 对象字符串,最大长度 8192 字符。

注意:此字段可能返回 null,表示取不到有效值。 */ Extensions?: string; /** *

错误码,最大长度 128 字符。

注意:此字段可能返回 null,表示取不到有效值。 */ ErrorCode?: string; /** *

错误信息,最大长度 2048 字符。

注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** *

事件时间。

*/ Timestamp?: string; } /** * GetSkillPackageUploadURL返回参数结构体 */ export interface GetSkillPackageUploadURLResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateSessionSpace返回参数结构体 */ export interface CreateSessionSpaceResponse { /** *

创建成功后的会话空间完整信息。

接口成功时一定返回;接口失败时返回 Error,不会返回该字段。

*/ SessionSpace?: SessionSpaceInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistryList返回参数结构体 */ export interface DescribeRegistryListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateRegistry请求参数结构体 */ export type UpdateRegistryRequest = null; /** * DescribeSessions返回参数结构体 */ export interface DescribeSessionsResponse { /** *

符合条件的会话总数。

*/ TotalCount?: number; /** *

会话列表。

*/ Sessions?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeploymentList请求参数结构体 */ export interface DescribeDeploymentListRequest { /** *

分页偏移量,默认 0,必须大于等于 0。

*/ Offset?: number; /** *

分页返回数量,默认 20,范围 1..200。

*/ Limit?: number; /** *

查询过滤条件。

Filter.Name 枚举值:

  • deployment-id:按 DeploymentId 精确匹配
  • deployment-name:按 DeploymentName 精确匹配
  • deployment-name-like:按 DeploymentName 进行普通文本包含匹配,%、_ 等字符没有通配语义
  • tool-id:按 ToolId 精确匹配
  • status:按 Deployment 状态精确匹配,支持 ACTIVE、DELETING、DELETE_FAILED

所有匹配均区分大小写。不同 Filter 之间为 AND,同一 Filter 的 Values 之间为 OR。

*/ Filters?: Array; } /** * DescribeRegistryAuditLogList请求参数结构体 */ export type DescribeRegistryAuditLogListRequest = null; /** * PauseSandboxInstance请求参数结构体 */ export interface PauseSandboxInstanceRequest { /** *

沙箱实例ID

*/ InstanceId: string; /** *

可选。带内存暂停,恢复后保留进程和内存状态。true=带内存;false=仅磁盘;不传=系统默认(当前默认 true,带内存)。

*/ Memory?: boolean; } /** * DescribeRegistryRecordList返回参数结构体 */ export interface DescribeRegistryRecordListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateRegistryRecord请求参数结构体 */ export type UpdateRegistryRecordRequest = null; /** * CreateAPIKey返回参数结构体 */ export interface CreateAPIKeyResponse { /** * 用户传入的API密钥名称,方便用户记忆 */ Name?: string; /** * 生成的API密钥,仅返回此一次,后续无法获取 */ APIKey?: string; /** * API密钥ID */ KeyId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistry请求参数结构体 */ export type DescribeRegistryRequest = null; /** * AcquireDeploymentToken请求参数结构体 */ export interface AcquireDeploymentTokenRequest { /** *

目标 ACTIVE Deployment 的稳定 ID。

*/ DeploymentId: string; } /** * DescribeEvents返回参数结构体 */ export interface DescribeEventsResponse { /** *

事件列表。

*/ Events?: Array; /** *

符合条件的事件总数。

*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeploymentList返回参数结构体 */ export interface DescribeDeploymentListResponse { /** *

当前页完整 Deployment;无匹配时为空数组。

*/ DeploymentSet?: Array; /** *

应用 Filters 后、分页前的结果总数。

*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistry返回参数结构体 */ export interface DescribeRegistryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySessionSpace请求参数结构体 */ export interface ModifySessionSpaceRequest { /** *

需要修改的会话空间唯一标识。

*/ SpaceId: string; /** *

修改后的会话空间名称。

*/ Name: string; /** *

修改后的会话空间描述。

*/ Description?: string; } /** * CreateSessionSpace请求参数结构体 */ export interface CreateSessionSpaceRequest { /** *

会话空间名称,用于标识会话空间的业务用途。

入参限制:必填;去除首尾空白后不能为空;最大长度为 128 个字符。

建议名称包含业务和环境信息,便于识别和管理。

*/ Name: string; /** *

会话空间描述,用于补充说明会话空间的业务用途。

入参限制:选填;最大长度为 512 个字符。

未传入时创建为空描述。

*/ Description?: string; /** *

创建 SessionSpace 时为资源绑定标签。

*/ Tags?: Array; } /** * DeleteAPIKey返回参数结构体 */ export interface DeleteAPIKeyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRegistryList请求参数结构体 */ export type DescribeRegistryListRequest = null; /** * 沙箱自定义配置详细信息 */ export interface CustomConfigurationDetail { /** *

镜像地址

*/ Image?: string; /** *

镜像仓库类型:enterprise、personal、custom。

枚举值:

  • enterprise: TCR 企业容器镜像服务
  • personal: CCR 个人容器镜像服务
*/ ImageRegistryType?: string; /** *

镜像 Digest

*/ ImageDigest?: string; /** *

启动命令

*/ Command?: Array; /** *

启动参数

*/ Args?: Array; /** *

环境变量

*/ Env?: Array; /** *

端口配置

*/ Ports?: Array; /** *

资源配置

*/ Resources?: ResourceConfiguration; /** *

探针配置

*/ Probe?: ProbeConfiguration; /** *

沙箱 DNS 配置

*/ DNSConfig?: DNSConfig; } /** * CreateDeployment返回参数结构体 */ export interface CreateDeploymentResponse { /** *

已创建并完成默认值物化的 Deployment。

*/ Deployment?: Deployment; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRegistry请求参数结构体 */ export type DeleteRegistryRequest = null; /** * GetSkillPackageDownloadURL返回参数结构体 */ export interface GetSkillPackageDownloadURLResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Session 快照状态 */ export interface SessionState { /** *

自定义状态 JSON 对象字符串

*/ CustomState?: string; } /** * 沙箱实例存储挂载配置可选项,用于覆盖沙箱工具的存储配置的部分选项,并提供子路径挂载配置。 */ export interface MountOption { /** * 指定沙箱工具中的存储配置名称 */ Name?: string; /** * 沙箱实例本地挂载路径(可选),默认继承工具中的存储配置 */ MountPath?: string; /** * 沙箱实例存储挂载子路径(可选) */ SubPath?: string; /** * 沙箱实例存储挂载读写权限(可选),默认继承工具存储配置 */ ReadOnly?: boolean; } /** * CreateSession返回参数结构体 */ export interface CreateSessionResponse { /** *

会话信息。

*/ Session?: SessionInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartSandboxInstance返回参数结构体 */ export interface StartSandboxInstanceResponse { /** *

创建的沙箱实例完整信息

*/ Instance?: SandboxInstance; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSandboxInstanceList请求参数结构体 */ export interface DescribeSandboxInstanceListRequest { /** *

沙箱实例ID列表,指定要查询的实例。如果为空则查询所有实例。最大支持100个ID

*/ InstanceIds?: Array; /** *

沙箱工具ID,指定时查询该沙箱模板下的实例,为空则查询所有沙箱模板的实例

*/ ToolId?: string; /** *

偏移量,默认为0

*/ Offset?: number; /** *

返回数量,默认为20,最大值为100

*/ Limit?: number; /** *

过滤条件

*/ Filters?: Array; /** *

每次调用返回的最大结果数。如果查询返回的时候有NextToken返回,您可以使用NextToken值获取更多页结果, 当NextToke返回空或者返回的结果数量小于MaxResults时,表示没有更多数据了。允许的最大页面大小为 100。

*/ MaxResults?: number; /** *

如果NextToken返回非空字符串 ,表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。

*/ NextToken?: string; /** *

是否返回符合当前查询条件的沙箱实例总数,仅在使用 MaxResults/NextToken 分页时生效。设置为 true 时,首次请求(NextToken 为空)计算并返回精确的 TotalCount;后续使用 NextToken 翻页时返回首次请求计算的 TotalCount,分页期间该值保持不变。重新发起不带 NextToken 的请求时将重新计算。使用 NextToken 翻页时,本参数及其他查询参数必须与首次请求保持一致。默认值为 false,此时 TotalCount 返回 0。

*/ NeedTotalCount?: boolean; } /** * 沙箱网络配置 */ export interface NetworkConfiguration { /** * 网络模式(当前支持 PUBLIC, VPC, SANDBOX) */ NetworkMode: string; /** * VPC网络相关配置 */ VpcConfig?: VPCConfig; } /** * ModifyDeployment请求参数结构体 */ export interface ModifyDeploymentRequest { /** *

待修改的 Deployment ID。

*/ DeploymentId: string; /** *

完整替换伸缩配置;提供时必须包含全部三个成员。

*/ ScalingConfiguration?: ScalingConfiguration; /** *

完整替换生命周期配置;提供时必须包含全部两个成员。

*/ LifecycleConfiguration?: LifecycleConfiguration; /** *

标签

*/ Tags?: Array; } /** * 镜像卷挂载源配置 */ export interface ImageStorageSource { /** *

镜像地址

*/ Reference?: string; /** *

镜像仓库类型:enterprise、personal。

*/ ImageRegistryType?: string; /** *

镜像内部的路径

*/ SubPath?: string; /** *

镜像 Digest,请求时无需传入

*/ Digest?: string; } /** * DescribeRegistryAuditLogList返回参数结构体 */ export interface DescribeRegistryAuditLogListResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AcquireSandboxInstanceToken返回参数结构体 */ export interface AcquireSandboxInstanceTokenResponse { /** *

访问Token

*/ Token?: string; /** *

过期时间

*/ ExpiresAt?: string; /** *

除管控面envd端口(49983)以外端口的访问Token

*/ TrafficToken?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 主账号配额总览 */ export interface AccountQuotaOverview { /** *

主账号各资源维度的配额上限

*/ Quota?: QuotaResourceInfo; /** *

主账号各资源维度的当前用量

*/ Usage?: QuotaResourceInfo; } /** * 用于记录 Agent Bucket 的 Storage Source */ export interface AgentBucketStorageSource { /** *

用于传入 AgentBucket 的 LibraryID

*/ LibraryId?: string; /** *

用于传入 AgentBucket 的 spaceId

*/ SpaceId?: string; /** *

用于传入 AgentBucket 的 AccessDomain

*/ AccessDomain?: string; } /** * PauseSandboxInstance返回参数结构体 */ export interface PauseSandboxInstanceResponse { /** *

目标沙箱实例当前的状态

枚举值:

  • PAUSING: 正在暂停中
  • PAUSED: 已暂停
  • PAUSE_FAILED: 暂停失败
*/ InstanceStatus?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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: 默认,即TOKEN认证
  • TOKEN: Token认证,即所有端口访问都需携带Token
  • NONE: 免认证,即所有端口访问无需携带Token
  • PUBLIC: 公开模式,即ENVD管理端口(49983)访问需携带Token,其他端口无需携带Token

默认值:DEFAULT

*/ AuthMode?: string; /** *

沙箱元数据

*/ Metadata?: Array; } /** * CancelRegistryRecord返回参数结构体 */ export interface CancelRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSessionSpaces请求参数结构体 */ export interface DescribeSessionSpacesRequest { /** *

分页查询的起始偏移量。

*/ Offset?: number; /** *

单次分页查询返回的会话空间数量。

*/ Limit?: number; /** *

会话空间筛选条件列表,支持按空间 ID 精确匹配、名称精确或模糊匹配、描述模糊匹配。同一 Filter 内多个 Values 之间为 OR,不同 Filter 之间为 AND。不传或传空数组时不增加筛选限制。

入参限制:Filter.Name 支持 space-id、name、name-like、description-like,不可重复。name 与 name-like 不可同时提供。Values 不可为空数组,筛选值不可为空或纯空白。匹配区分大小写,包含匹配中的 %、_ 按普通字符处理,不具有通配含义。

例如 Name 为 name-like,Values 为 ["客服","测试"],表示查询名称包含“客服”或“测试”的会话空间。

*/ Filters?: Array; } /** * 沙箱实例结构体 */ export interface SandboxInstance { /** *

沙箱实例唯一标识符

*/ 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; /** *

桌面电脑环境类沙箱配置

*/ ComputerConfiguration?: ComputerConfiguration; /** *

网络模式

枚举值:

  • PUBLIC: 公网访问
  • SANDBOX: 无网络
  • INTERNAL_SERVICE: 腾讯云内部公共服务

可以覆盖工具级别的网络配置。但如果一个工具本身就不支持 VPC 网络,那么即便在实例设置里选了 VPC 模式,也是无效的

*/ NetworkMode?: string; /** *

沙箱实例元数据

*/ Metadata?: Array; /** *

沙箱访问认证模式

枚举值:

  • DEFAULT: 默认,即 TOKEN 认证
  • TOKEN: Token认证,即所有端口访问都需携带TOKEN
  • NONE: 免认证,即所有端口访问无需携带TOKEN
  • PUBLIC: 公开模式,即ENVD管理端口(49983)访问需携带TOKEN,其他端口无需携带TOKEN

默认值:DEFAULT

*/ AuthMode?: string; } /** * waa自定义配置项 */ export interface WAAConfiguration { /** *

自定义waa镜像ID

*/ ImageId?: string; } /** * 沙箱工具中实例存储挂载配置 */ export interface StorageMount { /** *

存储挂载配置名称

*/ Name?: string; /** *

存储配置

注意:此字段可能返回 null,表示取不到有效值。 */ StorageSource?: StorageSource; /** *

沙箱实例本地挂载路径

*/ MountPath?: string; /** *

存储挂载读写权限配置,默认为false

*/ ReadOnly?: boolean; } /** * 桌面电脑环境类沙箱配置 */ export interface ComputerConfiguration { /** *

waa沙箱工具配置

*/ WAAConfiguration?: WAAConfiguration; /** *

配置内置 OSWorld

*/ OSWorldConfiguration?: OSWorldConfiguration; } /** * 沙箱工具日志推送CLS相关配置 */ export interface CLSConfig { /** * 沙箱工具日志推送所使用的CLS日志主题ID */ TopicId?: string; } /** * UpdateRegistryRecord返回参数结构体 */ export interface UpdateRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSessionSpace请求参数结构体 */ export interface DeleteSessionSpaceRequest { /** *

需要删除的会话空间唯一标识。

*/ SpaceId: string; } /** * OSWorld 内置版本配置 */ export interface OSWorldConfiguration { /** *

指定内置 OSWorld 版本

枚举值:

  • osworld1: osworld v1
  • osworld2: osworld v2

默认值:osworld1

*/ Version?: string; } /** * AcquireDeploymentToken返回参数结构体 */ export interface AcquireDeploymentTokenResponse { /** *

只用于目标 Deployment 数据面入口的短期 bearer Token,格式为 dpt_ 加非空、无 padding 的 Base64URL opaque 后缀。

*/ Token?: string; /** *

Token 的绝对过期时间,UTC、秒精度 RFC3339 格式。

*/ ExpiresAt?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSessions请求参数结构体 */ export interface DescribeSessionsRequest { /** *

查询的会话空间 ID。

*/ SpaceId: string; /** *

Agent ID 列表,最多支持 100 个。

* @deprecated */ AgentIds?: Array; /** *

用户 ID 列表,最多支持 100 个。

*/ UserIds?: Array; /** *

分页偏移量,默认为 0。

*/ Offset?: number; /** *

返回数量,默认为 20,最大值为 100。

*/ Limit?: number; /** *

会话 ID 列表,最多支持 100 个。

*/ SessionIds?: Array; /** *

会话筛选条件列表,支持 Metadata 精确匹配、标题精确匹配和标题模糊匹配。同一 Filter 内多个 Values 之间为 OR,不同 Filter 之间为 AND。不传或传空数组时不增加筛选限制。

入参限制:最多传入 10 个 Filter,每个 Filter 最多支持 100 个 Values。Filter.Name 不可重复,支持 metadata:MetadataKey、title、title-like;title 与 title-like 不可同时提供。标题筛选值不可为空或纯空白。匹配区分大小写,标题包含匹配中的 %、_ 按普通字符处理,不具有通配含义。

例如 Name 为 title-like,Values 为 ["客服","测试"],表示查询标题包含“客服”或“测试”的会话。Name 为 metadata:env,Values 为 ["dev","test"],表示按 Metadata env 的值精确筛选。标题条件与 Metadata、SessionIds、UserIds 筛选条件可组合使用,条件之间为 AND。筛选在分页前执行,TotalCount 为符合条件的会话总数。

*/ Filters?: Array; } /** * CreateSandboxTool请求参数结构体 */ export interface CreateSandboxToolRequest { /** *

沙箱工具名称,长度 1-50 字符,支持英文、数字、下划线和连接线。同一 AppId 下沙箱工具名称必须唯一

*/ ToolName: string; /** *

沙箱工具类型,目前支持:browser、code-interpreter、custom等

枚举值:

  • browser: browser
  • code-interpreter: code-interpreter
  • mobile: mobile
  • osworld: osworld
  • custom: custom
  • swebench: swebench
  • aio: aio
  • android-world: android-world
  • waa: waa
*/ 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; /** *

桌面电脑环境类沙箱配置

*/ ComputerConfiguration?: ComputerConfiguration; /** *

沙箱工具日志推送相关配置

*/ 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; } /** * DeleteRegistryRecord返回参数结构体 */ export interface DeleteRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRegistryRecord请求参数结构体 */ export type CreateRegistryRecordRequest = null; /** * ModifySession返回参数结构体 */ export interface ModifySessionResponse { /** *

修改后的完整会话信息。

*/ Session?: SessionInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateSandboxInstance返回参数结构体 */ export interface UpdateSandboxInstanceResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Deployment 稳定访问入口定义 */ export interface Deployment { /** *

Deployment 稳定 ID,格式为 dpl- 加 8 位小写 base36 字符。

*/ DeploymentId?: string; /** *

唯一且创建后不可修改的名称,必须符合 DNS-1123 命名规范。

*/ DeploymentName?: string; /** *

用于关联 Sandbox Tool 的标识,格式为 sdt- 加 8 位小写 base36 字符。

*/ ToolId?: string; /** *

完整的活跃容量配置。

*/ ScalingConfiguration?: ScalingConfiguration; /** *

完整的空闲生命周期配置。

*/ LifecycleConfiguration?: LifecycleConfiguration; /** *

可选 Affinity 配置;未启用时省略。

*/ AffinityConfiguration?: AffinityConfiguration; /** *

Deployment 控制面状态。

枚举值:

  • ACTIVE:入口可用。
  • DELETING:入口已关闭并正在异步删除。
  • DELETE_FAILED:最近一次异步删除失败,可再次调用 DeleteDeployment。
*/ Status?: string; /** *

DELETE_FAILED 状态下 1..1024 个 UTF-8 字节的安全失败摘要,格式为 {Code}[.{SubCode}]: {Message};其他状态省略。

*/ StatusReason?: string; /** *

创建时间,UTC、秒精度 RFC3339 格式。

*/ CreatedTime?: string; /** *

最近一次成功公共配置写入或 Deployment 状态迁移时间,UTC、秒精度 RFC3339 格式。

*/ UpdatedTime?: string; /** *

标签

*/ Tags?: Array; } /** * DeleteDeployment返回参数结构体 */ export interface DeleteDeploymentResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SyncRegistryRecord返回参数结构体 */ export interface SyncRegistryRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSession返回参数结构体 */ export interface DescribeSessionResponse { /** *

会话信息。

*/ Session?: SessionInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRegistryRecord请求参数结构体 */ export type DeleteRegistryRecordRequest = null; /** * 多模态内容片段信息 */ export interface EventPartInfo { /** * 文本内容,最大长度 8192 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ Text?: string; /** * 是否为思考内容。 注意:此字段可能返回 null,表示取不到有效值。 */ Thought?: boolean; /** * 工具调用信息,JSON 字符串,最大长度 8192 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ FunctionCall?: string; /** * 工具返回信息,JSON 字符串,最大长度 8192 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ FunctionResponse?: string; /** * 内联数据。 注意:此字段可能返回 null,表示取不到有效值。 */ InlineData?: InlineDataInfo; } /** * 标签 */ export interface Tag { /** * 标签键 */ Key?: string; /** * 标签值 */ Value?: string; } /** * Deployment 活跃容量配置 */ export interface ScalingConfiguration { /** *

活跃 Sandbox Instance 下限,必须大于等于 0。

*/ MinInstanceCount?: number; /** *

活跃 Sandbox Instance 上限,必须大于等于 1,并且不小于 MinInstanceCount。

*/ MaxInstanceCount?: number; /** *

每个活跃 Sandbox Instance 同时持有的 Deployment 请求或连接 Lease 上限,必须大于等于 1。

*/ MaxInstanceRequestConcurrency?: number; } /** * AppendEvent请求参数结构体 */ export interface AppendEventRequest { /** *

会话所属空间 ID。

*/ SpaceId: string; /** *

用户 ID。可通过调用方业务系统接口获取。

*/ UserId: string; /** *

会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。

*/ SessionId: string; /** *

事件内容。

*/ Event: EventInfo; /** *

Agent ID。可选。

* @deprecated */ AgentId?: string; } /** * 配额组资源信息 */ export interface QuotaGroupOverview { /** *

配额组关联的标签键值

*/ Tag?: Tag; /** *

配额组名称

*/ Name?: string; /** *

配额组各资源维度的配额上限

*/ Quota?: QuotaResourceInfo; /** *

配额组各资源维度的当前用量

*/ Usage?: QuotaResourceInfo; /** *

创建时间

参数格式:RFC3339 格式

*/ CreateTime?: string; /** *

最后更新时间

参数格式:RFC3339 格式

*/ UpdateTime?: string; } /** * DeleteSession返回参数结构体 */ export interface DeleteSessionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Deployment 管理的 Sandbox Instance 的空闲生命周期配置 */ export interface LifecycleConfiguration { /** *

Sandbox Instance 没有活跃 Deployment 请求或连接后进入 IdleAction 的秒数,必须大于等于 30。

*/ IdleTimeoutSeconds?: number; /** *

空闲处理动作。

枚举值:

  • STOP:停止并释放 Sandbox Instance。
  • PAUSE:暂停并保留 Sandbox Instance 状态。
*/ IdleAction?: string; } /** * DescribeEvents请求参数结构体 */ export interface DescribeEventsRequest { /** *

会话所属空间 ID。

*/ SpaceId: string; /** *

用户 ID。可通过调用方业务系统接口获取。

*/ UserId: string; /** *

会话 ID。可通过 CreateSession 或 DescribeSessions 接口获取。

*/ SessionId: string; /** *

Agent ID。可选。

* @deprecated */ AgentId?: string; /** *

事件作者。取值示例:user、assistant、tool。

*/ Author?: string; /** *

起始时间,仅返回该时间之后的事件,使用 RFC3339 格式,最大长度 64 字符。

*/ AfterTimestamp?: string; /** *

分页偏移量,默认为 0。

*/ Offset?: number; /** *

返回数量,默认为 50,最大值为 200。

*/ Limit?: number; } /** * 事件内容信息 */ export interface EventContentInfo { /** * 角色,最大长度 64 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ Role?: string; /** * 内容片段列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Parts?: Array; } /** * 端口配置 */ export interface PortConfiguration { /** * 端口名 */ Name?: string; /** * 端口 */ Port?: number; /** * 协议 */ Protocol?: string; } /** * 过滤列表规则 */ export interface Filter { /** * 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 */ Name?: string; /** * 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 */ Values?: Array; } /** * CreateRegistry请求参数结构体 */ export type CreateRegistryRequest = null; /** * DescribeQuotaOverview请求参数结构体 */ export interface DescribeQuotaOverviewRequest { /** *

分页偏移量,从 0 开始,默认值为 0,必须大于等于 0。

单位:偏移量

*/ Offset?: number; /** *

每页返回的配额组数量

单位:个

*/ Limit?: number; /** *

配额组过滤条件

*/ Filters?: Array; } /** * ModifyDeployment返回参数结构体 */ export interface ModifyDeploymentResponse { /** *

修改后的完整 Deployment。

*/ Deployment?: Deployment; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreatePreCacheImageTask请求参数结构体 */ export interface CreatePreCacheImageTaskRequest { /** *

镜像地址

*/ Image: string; /** *

镜像仓库类型:enterprise、personal、custom

枚举值:

  • enterprise: tcr 企业容器镜像服务
  • personal: ccr 个人容器镜像服务
*/ ImageRegistryType: string; } /** * 沙箱工具日志采集相关配置 */ export interface LogConfiguration { /** *

日志推送CLS的配置。

*/ CLSConfig?: CLSConfig; /** *

日志源配置

*/ LogSources?: LogSources; } /** * metadata 项 */ export interface MetadataVar { /** *

元数据名

*/ Name?: string; /** *

元数据值

*/ Value?: string; } /** * PreviewRegistryRecord请求参数结构体 */ export type PreviewRegistryRecordRequest = null; /** * 环境变量 */ export interface EnvVar { /** * 环境变量名 */ Name?: string; /** * 环境变量值 */ Value?: string; } /** * Agent 状态切换事件信息 */ export interface EventActionsInfo { /** * 状态增量,JSON 字符串,最大长度 8192 字符。 注意:此字段可能返回 null,表示取不到有效值。 */ StateDelta?: string; }