tenyun/types/ags.d.ts

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

/** API密钥简略信息 */
declare 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;
}

/** 沙箱实例对象存储挂载配置 */
declare interface CosStorageSource {
  /** 对象存储访问域名 */
  Endpoint?: string;
  /** 对象存储桶名称 */
  BucketName?: string;
  /** 对象存储桶路径，必须为以/起始的绝对路径 */
  BucketPath?: string;
}

/** 沙箱自定义配置 */
declare interface CustomConfiguration {
  /** 镜像地址 */
  Image?: string;
  /** 镜像仓库类型：`enterprise`、`personal`。 */
  ImageRegistryType?: string;
  /** 启动命令 */
  Command?: string[];
  /** 启动参数 */
  Args?: string[];
  /** 环境变量 */
  Env?: EnvVar[];
  /** 端口配置 */
  Ports?: PortConfiguration[];
  /** 资源配置 */
  Resources?: ResourceConfiguration;
  /** 探针配置 */
  Probe?: ProbeConfiguration;
}

/** 沙箱自定义配置详细信息 */
declare interface CustomConfigurationDetail {
  /** 镜像地址 */
  Image?: string;
  /** 镜像仓库类型：`TCR`、`CCR`。 */
  ImageRegistryType?: string;
  /** 镜像 Digest */
  ImageDigest?: string;
  /** 启动命令 */
  Command?: string[];
  /** 启动参数 */
  Args?: string[];
  /** 环境变量 */
  Env?: EnvVar[];
  /** 端口配置 */
  Ports?: PortConfiguration[];
  /** 资源配置 */
  Resources?: ResourceConfiguration;
  /** 探针配置 */
  Probe?: ProbeConfiguration;
}

/** 环境变量 */
declare interface EnvVar {
  /** 环境变量名 */
  Name?: string;
  /** 环境变量值 */
  Value?: string;
}

/** 过滤列表规则 */
declare interface Filter {
  /** 属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 */
  Name?: string;
  /** 属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 */
  Values?: string[];
}

/** HTTP GET 探测动作配置 */
declare interface HttpGetAction {
  /** 路径 */
  Path?: string;
  /** 端口 */
  Port?: number;
  /** 协议 */
  Scheme?: string;
}

/** 镜像卷挂载源配置 */
declare interface ImageStorageSource {
  /** 镜像地址 */
  Reference?: string;
  /** 镜像仓库类型：`enterprise`、`personal`。 */
  ImageRegistryType?: string;
  /** 镜像内部的路径 */
  SubPath?: string;
  /** 镜像 Digest，请求时无需传入 */
  Digest?: string;
}

/** 沙箱实例存储挂载配置可选项，用于覆盖沙箱工具的存储配置的部分选项，并提供子路径挂载配置。 */
declare interface MountOption {
  /** 指定沙箱工具中的存储配置名称 */
  Name?: string;
  /** 沙箱实例本地挂载路径（可选），默认继承工具中的存储配置 */
  MountPath?: string;
  /** 沙箱实例存储挂载子路径（可选） */
  SubPath?: string;
  /** 沙箱实例存储挂载读写权限（可选），默认继承工具存储配置 */
  ReadOnly?: boolean;
}

/** 沙箱网络配置 */
declare interface NetworkConfiguration {
  /** 网络模式（当前支持 PUBLIC, VPC, SANDBOX） */
  NetworkMode: string;
  /** VPC网络相关配置 */
  VpcConfig?: VPCConfig;
}

/** 端口配置 */
declare interface PortConfiguration {
  /** 端口名 */
  Name?: string;
  /** 端口 */
  Port?: number;
  /** 协议 */
  Protocol?: string;
}

/** 健康检查探针配置 */
declare interface ProbeConfiguration {
  /** HTTP GET 探测配置 */
  HttpGet?: HttpGetAction;
  /** 健康检查就绪超时 */
  ReadyTimeoutMs?: number;
  /** 健康检查单次探测超时 */
  ProbeTimeoutMs?: number;
  /** 健康检查间隔 */
  ProbePeriodMs?: number;
  /** 健康检查成功阈值 */
  SuccessThreshold?: number;
  /** 健康检查失败阈值 */
  FailureThreshold?: number;
}

/** 资源配置 */
declare interface ResourceConfiguration {
  /** cpu 资源量 */
  CPU?: string;
  /** 内存资源量 */
  Memory?: string;
}

/** 沙箱实例结构体 */
declare interface SandboxInstance {
  /** 沙箱实例唯一标识符 */
  InstanceId: string;
  /** 所属沙箱工具 ID */
  ToolId: string;
  /** 所属沙箱工具名称 */
  ToolName: string;
  /** 实例状态：STARTING（启动中）、RUNNING（运行中）、STOPPING（停止中）、STOPPED（已停止）、STOP_FAILED（停止失败）、FAILED（失败状态） */
  Status: string;
  /** 超时时间（秒），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?: MountOption[];
  /** 沙箱实例自定义配置 */
  CustomConfiguration?: CustomConfigurationDetail;
}

/** 沙箱工具结构体 */
declare 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;
  /** 默认超时时间，支持格式：5m、300s、1h 等，不指定则使用系统默认值（5 分钟）。最大 24 小时 */
  DefaultTimeoutSeconds?: number;
  /** 网络配置 */
  NetworkConfiguration?: NetworkConfiguration;
  /** 标签规格，包含资源标签绑定关系。用于为沙箱工具绑定标签，支持多种资源类型的标签绑定 */
  Tags?: Tag[];
  /** 沙箱工具创建时间，格式：ISO8601 */
  CreateTime?: string;
  /** 沙箱工具更新时间，格式：ISO8601 */
  UpdateTime?: string;
  /** 沙箱工具绑定角色ARN */
  RoleArn?: string;
  /** 沙箱工具中实例存储挂载配置 */
  StorageMounts?: StorageMount[];
  /** 沙箱工具自定义配置 */
  CustomConfiguration?: CustomConfigurationDetail;
}

/** 沙箱工具中实例存储挂载配置 */
declare interface StorageMount {
  /** 存储挂载配置名称 */
  Name?: string;
  /** 存储配置 */
  StorageSource?: StorageSource;
  /** 沙箱实例本地挂载路径 */
  MountPath?: string;
  /** 存储挂载读写权限配置，默认为false */
  ReadOnly?: boolean;
}

/** 挂载存储配置 */
declare interface StorageSource {
  /** 对象存储桶配置 */
  Cos?: CosStorageSource;
  /** 镜像卷配置 */
  Image?: ImageStorageSource;
}

/** 标签 */
declare interface Tag {
  /** 标签键 */
  Key?: string;
  /** 标签值 */
  Value?: string;
}

/** 沙箱工具VPC相关配置 */
declare interface VPCConfig {
  /** VPC子网ID列表 */
  SubnetIds?: string[];
  /** 安全组ID列表 */
  SecurityGroupIds?: string[];
}

declare interface AcquireSandboxInstanceTokenRequest {
  /** 沙箱实例ID，生成的访问Token将仅可用于访问此沙箱实例 */
  InstanceId: string;
}

declare interface AcquireSandboxInstanceTokenResponse {
  /** 访问Token */
  Token?: string;
  /** 过期时间 */
  ExpiresAt?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateAPIKeyRequest {
  /** API密钥名称，方便用户记忆 */
  Name?: string;
}

declare interface CreateAPIKeyResponse {
  /** 用户传入的API密钥名称，方便用户记忆 */
  Name?: string;
  /** 生成的API密钥，仅返回此一次，后续无法获取 */
  APIKey?: string;
  /** API密钥ID */
  KeyId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateSandboxToolRequest {
  /** 沙箱工具名称，长度 1-50 字符，支持英文、数字、下划线和连接线。同一 AppId 下沙箱工具名称必须唯一 */
  ToolName: string;
  /** 沙箱工具类型，目前支持：browser、code-interpreter、custom */
  ToolType: string;
  /** 网络配置 */
  NetworkConfiguration: NetworkConfiguration;
  /** 沙箱工具描述，最大长度 200 字符 */
  Description?: string;
  /** 默认超时时间，支持格式：5m、300s、1h 等，不指定则使用系统默认值（5 分钟）。最大 24 小时 */
  DefaultTimeout?: string;
  /** 标签规格，为沙箱工具绑定标签，支持多种资源类型的标签绑定 */
  Tags?: Tag[];
  /** 幂等性 Token，长度不超过 64 字符 */
  ClientToken?: string;
  /** 角色ARN */
  RoleArn?: string;
  /** 沙箱工具存储配置 */
  StorageMounts?: StorageMount[];
  /** 沙箱工具自定义配置 */
  CustomConfiguration?: CustomConfiguration;
}

declare interface CreateSandboxToolResponse {
  /** 创建的沙箱工具 ID */
  ToolId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteAPIKeyRequest {
  /** 需要删除的API密钥ID */
  KeyId: string;
}

declare interface DeleteAPIKeyResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteSandboxToolRequest {
  /** 沙箱工具ID */
  ToolId: string;
}

declare interface DeleteSandboxToolResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeAPIKeyListRequest {
}

declare interface DescribeAPIKeyListResponse {
  /** API密钥简略信息列表。 */
  APIKeySet?: APIKeyInfo[];
  /** 列表中API密钥数量 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeSandboxInstanceListRequest {
  /** 沙箱实例ID列表，指定要查询的实例。如果为空则查询所有实例。最大支持100个ID */
  InstanceIds?: string[];
  /** 沙箱工具ID，指定时查询该沙箱模板下的实例，为空则查询所有沙箱模板的实例 */
  ToolId?: string;
  /** 偏移量，默认为0 */
  Offset?: number;
  /** 返回数量，默认为20，最大值为100 */
  Limit?: number;
  /** 过滤条件 */
  Filters?: Filter[];
}

declare interface DescribeSandboxInstanceListResponse {
  /** 沙箱实例列表 */
  InstanceSet?: SandboxInstance[];
  /** 符合条件的实例总数 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeSandboxToolListRequest {
  /** 沙箱工具ID列表，指定要查询的工具。如果为空则查询所有工具。最大支持100个ID */
  ToolIds?: string[];
  /** 偏移量，默认为0 */
  Offset?: number;
  /** 返回数量，默认为20，最大值为100 */
  Limit?: number;
  /** 过滤条件 */
  Filters?: Filter[];
}

declare interface DescribeSandboxToolListResponse {
  /** 沙箱工具列表 */
  SandboxToolSet?: SandboxTool[];
  /** 符合条件的沙箱工具总数 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface StartSandboxInstanceRequest {
  /** 沙箱工具 ID，与 ToolName 至少有一个要填 */
  ToolId?: string;
  /** 沙箱工具名称，与 ToolId 至少有一个要填 */
  ToolName?: string;
  /** 超时时间，超过这个时间就自动回收实例。支持格式：5m、300s、1h 等，默认 5m。最小 30s，最大 24h */
  Timeout?: string;
  /** 幂等性 Token，长度不超过 64 字符 */
  ClientToken?: string;
  /** 沙箱实例存储挂载配置 */
  MountOptions?: MountOption[];
  /** 沙箱实例自定义配置 */
  CustomConfiguration?: CustomConfiguration;
}

declare interface StartSandboxInstanceResponse {
  /** 创建的沙箱实例完整信息 */
  Instance?: SandboxInstance;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface StopSandboxInstanceRequest {
  /** 沙箱实例ID */
  InstanceId: string;
}

declare interface StopSandboxInstanceResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateSandboxInstanceRequest {
  /** 沙箱实例ID */
  InstanceId: string;
  /** 新的超时时间（从设置时开始重新计算超时），支持格式：5m、300s、1h等。最小30s，最大24h。如果不指定则保持原有超时设置 */
  Timeout?: string;
}

declare interface UpdateSandboxInstanceResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateSandboxToolRequest {
  /** 沙箱工具ID */
  ToolId: string;
  /** 沙箱工具描述，最大长度200字符 */
  Description?: string;
  /** 网络配置 */
  NetworkConfiguration?: NetworkConfiguration;
  /** 标签 */
  Tags?: Tag[];
  /** 沙箱工具自定义配置 */
  CustomConfiguration?: CustomConfiguration;
}

declare interface UpdateSandboxToolResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

/** {@link Ags Agent 沙箱服务} */
declare interface Ags {
  (): Versions;
  /** 获取沙箱实例的访问Token {@link AcquireSandboxInstanceTokenRequest} {@link AcquireSandboxInstanceTokenResponse} */
  AcquireSandboxInstanceToken(data: AcquireSandboxInstanceTokenRequest, config?: AxiosRequestConfig): AxiosPromise<AcquireSandboxInstanceTokenResponse>;
  /** 创建新的API密钥 {@link CreateAPIKeyRequest} {@link CreateAPIKeyResponse} */
  CreateAPIKey(data?: CreateAPIKeyRequest, config?: AxiosRequestConfig): AxiosPromise<CreateAPIKeyResponse>;
  /** 创建沙箱工具 {@link CreateSandboxToolRequest} {@link CreateSandboxToolResponse} */
  CreateSandboxTool(data: CreateSandboxToolRequest, config?: AxiosRequestConfig): AxiosPromise<CreateSandboxToolResponse>;
  /** 删除API密钥 {@link DeleteAPIKeyRequest} {@link DeleteAPIKeyResponse} */
  DeleteAPIKey(data: DeleteAPIKeyRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteAPIKeyResponse>;
  /** 删除沙箱工具 {@link DeleteSandboxToolRequest} {@link DeleteSandboxToolResponse} */
  DeleteSandboxTool(data: DeleteSandboxToolRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteSandboxToolResponse>;
  /** 获取API密钥列表 {@link DescribeAPIKeyListRequest} {@link DescribeAPIKeyListResponse} */
  DescribeAPIKeyList(data?: DescribeAPIKeyListRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeAPIKeyListResponse>;
  /** 查询沙箱实例列表 {@link DescribeSandboxInstanceListRequest} {@link DescribeSandboxInstanceListResponse} */
  DescribeSandboxInstanceList(data?: DescribeSandboxInstanceListRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeSandboxInstanceListResponse>;
  /** 查询沙箱工具列表 {@link DescribeSandboxToolListRequest} {@link DescribeSandboxToolListResponse} */
  DescribeSandboxToolList(data?: DescribeSandboxToolListRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeSandboxToolListResponse>;
  /** 启动沙箱实例 {@link StartSandboxInstanceRequest} {@link StartSandboxInstanceResponse} */
  StartSandboxInstance(data?: StartSandboxInstanceRequest, config?: AxiosRequestConfig): AxiosPromise<StartSandboxInstanceResponse>;
  /** 停止沙箱实例 {@link StopSandboxInstanceRequest} {@link StopSandboxInstanceResponse} */
  StopSandboxInstance(data: StopSandboxInstanceRequest, config?: AxiosRequestConfig): AxiosPromise<StopSandboxInstanceResponse>;
  /** 更新沙箱实例 {@link UpdateSandboxInstanceRequest} {@link UpdateSandboxInstanceResponse} */
  UpdateSandboxInstance(data: UpdateSandboxInstanceRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateSandboxInstanceResponse>;
  /** 更新沙箱工具 {@link UpdateSandboxToolRequest} {@link UpdateSandboxToolResponse} */
  UpdateSandboxTool(data: UpdateSandboxToolRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateSandboxToolResponse>;
}

export declare type Versions = ["2025-09-20"];

export default Ags;