@cloudbase/manager-node 5.5.2-beta.0 → 5.5.2

package/types/talosSandbox/type.d.ts

@@ -1,689 +0,0 @@
-/**
- * CreateSandbox 请求参数
- */
-export interface CreateSandboxOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板 ID（或池 ID） */
-    templateID: string;
-    /** 是否允许沙箱访问互联网 */
-    allow_internet_access?: boolean;
-    /** 超时后是否自动暂停 */
-    autoPause?: boolean;
-    /** 挂起时收到流量是否自动恢复 */
-    autoResume?: boolean;
-    /** 沙箱环境变量 */
-    envVars?: Record<string, string>;
-    /** 沙箱元数据 */
-    metadata?: Record<string, string>;
-    /** 是否加密系统通信 */
-    secure?: boolean;
-    /** 沙箱存活时间（秒），>= 0 */
-    timeout?: number;
-}
-/**
- * CreateSandbox 返回结果
- */
-export interface CreateSandboxResp {
-    /** 已废弃，请使用 templateID */
-    clientID?: string;
-    /** 沙箱内 envd 版本 */
-    envdVersion: string;
-    /** 沙箱唯一标识 */
-    sandboxID: string;
-    /** 沙箱所属池 ID */
-    templateID: string;
-    /** 沙箱流量访问地址，可能为 null */
-    domain?: string | null;
-    /** envd 访问令牌，可能为 null */
-    envdAccessToken?: string | null;
-}
-/**
- * ListSandboxes 请求参数
- */
-export interface ListSandboxesOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 按沙箱状态过滤，可传多个值（如 ['running', 'paused']） */
-    state?: SandboxState[];
-    /** 返回的最大数量，最小为 1 */
-    limit?: number;
-    /** 分页游标（尚未实现） */
-    nextToken?: string;
-}
-/**
- * 沙箱状态
- */
-export type SandboxState = 'running' | 'paused';
-/**
- * 沙箱运行信息
- */
-export interface ListedSandbox {
-    /** 已废弃，请使用 templateID */
-    clientID?: string;
-    /** CPU 核数 */
-    cpuCount: number;
-    /** 磁盘大小（MiB） */
-    diskSizeMB: number;
-    /** 过期时间（RFC 3339） */
-    endAt: string;
-    /** envd 版本 */
-    envdVersion: string;
-    /** 内存大小（MiB） */
-    memoryMB: number;
-    /** 沙箱唯一标识 */
-    sandboxID: string;
-    /** 启动时间（RFC 3339） */
-    startedAt: string;
-    /** 沙箱状态 */
-    state: SandboxState;
-    /** 池/模板 ID */
-    templateID: string;
-    /** 沙箱别名 */
-    alias?: string | null;
-    /** 是否允许互联网访问 */
-    allowInternetAccess?: boolean | null;
-    /** 生命周期策略（保留字段，始终为 null） */
-    lifecycle?: object | null;
-    /** 沙箱元数据 */
-    metadata?: Record<string, string>;
-    /** 网络配置（保留字段，始终为 null） */
-    network?: object | null;
-    /** 挂载卷列表 */
-    volumeMounts?: VolumeMount[];
-}
-/**
- * 挂载卷
- */
-export interface VolumeMount {
-    /** 卷名 */
-    name: string;
-    /** 挂载路径 */
-    mountPath: string;
-}
-/**
- * 日志级别
- */
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-/**
- * 日志排序方向
- */
-export type LogDirection = 'forward' | 'backward';
-/**
- * GetSandboxLogs 请求参数
- */
-export interface GetSandboxLogsOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-    /** 起始时间戳（毫秒），最小为 0 */
-    cursor?: number;
-    /** 返回的最大数量，0-1000 */
-    limit?: number;
-    /** 日志排序方向 */
-    direction?: LogDirection;
-    /** 日志级别过滤 */
-    level?: LogLevel;
-    /** 搜索关键字，大小写敏感的子串匹配，最大长度 256 */
-    search?: string;
-}
-/**
- * 日志条目字段
- */
-export interface SandboxLogFields {
-    [key: string]: string;
-}
-/**
- * 单条日志条目
- */
-export interface SandboxLogEntry {
-    /** 日志附加字段 */
-    fields?: SandboxLogFields;
-    /** 日志级别 */
-    level: LogLevel;
-    /** 日志消息 */
-    message: string;
-    /** 时间戳（RFC 3339） */
-    timestamp: string;
-}
-/**
- * GetSandboxLogs 返回结果
- */
-export interface SandboxLogsV2Response {
-    /** 日志条目列表 */
-    logs: SandboxLogEntry[];
-}
-/**
- * GetSandboxesMetrics 请求参数
- */
-export interface GetSandboxesMetricsOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID 列表，最多 100 个 */
-    sandboxIDs: string[];
-}
-/**
- * 单个沙箱的指标数据
- */
-export interface SandboxMetrics {
-    /** 指标时间戳（RFC 3339） */
-    timestamp: string;
-    /** Unix 时间戳（秒） */
-    timestampUnix: number;
-    /** CPU 核数 */
-    cpuCount: number;
-    /** CPU 使用率百分比 */
-    cpuUsedPct: number;
-    /** 已用内存（字节） */
-    memUsed: number;
-    /** 总内存（字节） */
-    memTotal: number;
-    /** 已用磁盘（字节） */
-    diskUsed: number;
-    /** 总磁盘（字节） */
-    diskTotal: number;
-}
-/**
- * GetSandboxesMetrics 返回结果
- */
-export interface SandboxesWithMetrics {
-    /** 以 sandboxID 为 key 的指标映射 */
-    sandboxes: Record<string, SandboxMetrics>;
-}
-/**
- * GetSandboxDetail 请求参数
- */
-export interface GetSandboxDetailOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-}
-/**
- * 沙箱详情（在 ListedSandbox 基础上增加了 domain 和 envdAccessToken）
- */
-export interface SandboxDetail extends ListedSandbox {
-    /** 沙箱流量访问地址 */
-    domain?: string | null;
-    /** envd 访问令牌 */
-    envdAccessToken?: string | null;
-}
-/**
- * DestroySandbox 请求参数
- */
-export interface DestroySandboxOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-}
-/**
- * ListSandboxSnapshots 请求参数
- */
-export interface ListSandboxSnapshotsOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-}
-/**
- * 快照触发来源
- */
-export type SnapshotTriggerSource = 'pause' | 'rsync' | 'clone';
-/**
- * 单个快照信息
- */
-export interface SandboxSnapshot {
-    /** 快照 ID，格式：YYYYMMDDTHHMMSSZ */
-    snapshotId: string;
-    /** 触发来源 */
-    triggerSource: SnapshotTriggerSource;
-    /** 快照大小（字节） */
-    sizeBytes: number;
-    /** SHA256 哈希值（十六进制），旧脚本生成时可能为空字符串 */
-    sha256: string;
-    /** 创建时间（RFC 3339，UTC） */
-    createdAt: string;
-}
-/**
- * ListSandboxSnapshots 返回结果
- */
-export interface SandboxSnapshotList {
-    /** 最新的快照，可能为 null */
-    latest: SandboxSnapshot | null;
-    /** 快照历史列表，最新在前，最多保留 3 条 */
-    history: SandboxSnapshot[];
-}
-/**
- * CreateSandboxSnapshot 请求参数
- */
-export interface CreateSandboxSnapshotOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-}
-/**
- * 快照被拒绝的错误（409）
- * 可能原因：池类型不支持快照、沙箱非运行状态、冷却时间未过
- */
-export interface SnapshotRejectedError {
-    /** 错误码 */
-    code: number;
-    /** 错误消息 */
-    message: string;
-    /** 冷却剩余时间（秒） */
-    retry_after_seconds?: number;
-}
-/**
- * ListAllSnapshots 请求参数
- */
-export interface ListAllSnapshotsOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 按源沙箱 ID 过滤 */
-    sandboxID?: string;
-    /** 返回的最大数量，1-100 */
-    limit?: number;
-}
-/**
- * PauseSandbox 请求参数
- */
-export interface PauseSandboxOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-}
-/**
- * CloneSandbox 请求参数
- */
-export interface CloneSandboxOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 源沙箱 ID（必须为已暂停的 s3-hybrid 沙箱） */
-    sandboxID: string;
-    /** 克隆数量，1-32 */
-    count: number;
-}
-/**
- * 克隆出的沙箱占位信息（PENDING 状态）
- */
-export interface ClonedSandbox {
-    /** envd 版本 */
-    envdVersion: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-    /** 池/模板 ID */
-    templateID: string;
-    /** 沙箱流量访问地址 */
-    domain?: string | null;
-    /** envd 访问令牌 */
-    envdAccessToken?: string | null;
-}
-/**
- * CloneSandbox 返回结果
- */
-export interface CloneSandboxResponse {
-    /** 源沙箱 ID */
-    sourceSandboxID: string;
-    /** 克隆出的沙箱列表（PENDING 状态） */
-    sandboxes: ClonedSandbox[];
-}
-/**
- * ConnectSandbox 请求参数
- */
-export interface ConnectSandboxOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-    /** 超时时间（秒），从当前时间起沙箱过期的时间，>= 0 */
-    timeout: number;
-}
-/**
- * GetSandboxMetrics 请求参数
- */
-export interface GetSandboxMetricsOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-    /** 时间区间起始（Unix 秒），当前被忽略但保留 */
-    start?: number;
-    /** 时间区间结束（Unix 秒），当前被忽略但保留 */
-    end?: number;
-}
-/**
- * UpdateSandboxTimeout 请求参数
- */
-export interface UpdateSandboxTimeoutOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-    /** 超时时间（秒），最小为 0，0 表示永不过期 */
-    timeout: number;
-}
-/**
- * RefreshSandboxTTL 请求参数
- */
-export interface RefreshSandboxTTLOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 沙箱 ID */
-    sandboxID: string;
-    /** 延长 TTL 的秒数，0-3600 */
-    duration: number;
-}
-/**
- * ListTemplates 请求参数
- */
-export interface ListTemplatesOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 按团队 ID 过滤模板（可选） */
-    teamID?: string;
-}
-/**
- * 模板信息
- */
-export interface Template {
-    /** 模板唯一标识 */
-    templateID: string;
-    /** 最近一次成功构建的 ID */
-    buildID: string;
-    /** CPU 核数 */
-    cpuCount: number;
-    /** 内存大小（MiB） */
-    memoryMB: number;
-    /** 磁盘大小（MiB） */
-    diskSizeMB: number;
-    /** 是否为公共模板 */
-    public: boolean;
-    /** 模板别名列表 */
-    aliases: string[];
-    /** 创建时间（RFC 3339） */
-    createdAt: string;
-    /** 更新时间（RFC 3339） */
-    updatedAt: string;
-    /** 最近一次启动时间（RFC 3339），可能为 null */
-    lastSpawnedAt?: string | null;
-    /** 被使用的次数 */
-    spawnCount: number;
-    /** 构建次数 */
-    buildCount: number;
-    /** envd 版本 */
-    envdVersion: string;
-}
-/**
- * CreateTemplate 请求参数
- */
-export interface CreateTemplateOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板别名 */
-    alias?: string;
-    /** 团队 ID */
-    teamID?: string;
-    /** Dockerfile 内容 */
-    dockerfile?: string;
-    /** CPU 核数（int32），需要 >= 1 */
-    cpuCount?: number;
-    /** 内存大小（MiB，int32），需要 >= 1 */
-    memoryMB?: number;
-    /** 构建后的启动命令 */
-    startCmd?: string;
-    /** 构建后的就绪检查命令 */
-    readyCmd?: string;
-}
-/**
- * GetTemplate 请求参数
- */
-export interface GetTemplateOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板 ID（path 参数，必填） */
-    templateID: string;
-}
-/**
- * DeleteTemplate 请求参数
- */
-export interface DeleteTemplateOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板 ID（path 参数，必填） */
-    templateID: string;
-}
-/**
- * UpdateTemplate 请求参数
- */
-export interface UpdateTemplateOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板 ID（path 参数，必填） */
-    templateID: string;
-    /** 是否设为公共模板 */
-    public?: boolean;
-}
-/**
- * GetTemplateByAlias 请求参数
- */
-export interface GetTemplateByAliasOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板别名（path 参数，必填） */
-    alias: string;
-}
-/**
- * 镜像滚动更新的可选参数
- * 任一字段缺省/为 0 时由服务端使用默认策略
- */
-export interface TemplateImageRolloutConfig {
-    /**
-     * 单批要 drain 的 WARM 实例百分比
-     * 范围 1-100，默认 50
-     */
-    batch_percent?: number;
-    /**
-     * 批次之间的等待时间（秒）
-     * >= 0，默认 60
-     */
-    batch_interval_s?: number;
-    /**
-     * 单批触发自动暂停的最大失败率（百分比）
-     * 范围 1-100，默认 50
-     */
-    max_failure_percent_per_batch?: number;
-    /**
-     * 失败率开始评估前需要累计的最小失败数
-     * >= 1，默认 2
-     */
-    min_failures_to_trigger?: number;
-    /**
-     * 单批长时间未推进会被判定为 stuck 的超时（秒）
-     * >= 60，默认 600
-     */
-    stuck_timeout_s?: number;
-}
-/**
- * UpdateTemplateImage 请求参数
- */
-export interface UpdateTemplateImageOptions {
-    /**
-     * Talos 鉴权 Token，不传则从环境变量读取
-     * 支持三种类型（按前缀自动识别 Header）：
-     *   - admin_talos_*  → X-Admin-Token
-     *   - talos_*        → X-API-Key
-     *   - sk_talos_*     → Authorization: Bearer
-     */
-    token?: string;
-    /** 模板 ID（path 参数，必填） */
-    templateID: string;
-    /** 新的基础镜像（必填） */
-    base_image: string;
-    /** 滚动更新策略（可选） */
-    rollout?: TemplateImageRolloutConfig;
-}
-/** 镜像滚动状态 */
-export type ImageRollingStatus = 'IDLE' | 'ROLLING' | 'PAUSED' | 'DONE' | string;
-/** 单个 Pool 镜像更新摘要 (Rollout summary for a single pool after image update is initiated) */
-export interface TemplateImageUpdateSummary {
-    /** Pool ID */
-    pool_id: string;
-    /** 当前基础镜像 */
-    base_image: string;
-    /** 上一次的基础镜像 */
-    previous_base_image: string;
-    /** 镜像版本号（int64） */
-    image_version: number;
-    /** 镜像滚动状态 */
-    image_rolling_status: ImageRollingStatus;
-    /** 镜像更新时间（RFC 3339） */
-    image_updated_at: string;
-    /** 实际生效的滚动策略（包含服务端默认值） */
-    rollout_cfg: TemplateImageRolloutConfig;
-}
-/** 单个 Pool 的镜像更新结果 */
-export interface TemplateImageUpdateResult {
-    /** Pool ID */
-    pool_id: string;
-    /** 成功时的摘要信息（失败可能为空/缺省） */
-    summary?: TemplateImageUpdateSummary;
-    /** 失败时的错误信息（成功为空字符串或缺省） */
-    error?: string;
-}
-/** UpdateTemplateImage 响应体 */
-export interface TemplateImageUpdateResponse {
-    /** 模板 ID */
-    template_id: string;
-    /** 各 Pool 的更新结果 */
-    results: TemplateImageUpdateResult[];
-}