@cloudbase/manager-node 4.11.0-alpha.1 → 4.11.0-alpha.11

package/types/env/type.d.ts

@@ -14,3 +14,190 @@ export interface CalculatePackageModifyPriceParams {
     envId: string;
     currency?: 'CNY' | 'USD';
 }
+/**
+ * 客户端限频配置
+ */
+export interface HTTPServiceQPSPerClient {
+    LimitBy?: 'UserID' | 'ClientIP';
+    LimitValue?: number;
+}
+/**
+ * QPS限频策略
+ */
+export interface HTTPServiceRouteQPSPolicy {
+    QPSTotal?: number;
+    QPSPerClient?: HTTPServiceQPSPerClient;
+}
+/**
+ * 路径重写
+ */
+export interface HTTPServicePathRewrite {
+    StaticStorePrefix?: string;
+    Prefix?: string;
+}
+/**
+ * HTTP访问服务路由信息
+ */
+export interface HTTPServiceRoute {
+    Path: string;
+    PathRewrite?: HTTPServicePathRewrite;
+    UpstreamResourceType: 'SCF' | 'CBR' | 'STATIC_STORE' | 'WEB_SCF' | 'LH';
+    UpstreamResourceName: string;
+    EnableSafeDomain: boolean;
+    EnableAuth: boolean;
+    EnablePathTransmission: boolean;
+    QPSPolicy?: HTTPServiceRouteQPSPolicy;
+    Enable: boolean;
+    CreateTime: string;
+    UpdateTime: string;
+}
+/**
+ * 域名路由信息
+ */
+export interface HTTPServiceDomain {
+    Domain: string;
+    DomainType: 'HTTPSERVICE' | 'CBR' | 'ANYSERVICE' | 'AI_AGENT' | 'VM' | 'INTEGRATION_CALLBACK';
+    AccessType: 'DIRECT' | 'CDN' | 'CUSTOM';
+    CertId: string;
+    Protocol: 'HTTP_AND_HTTPS' | 'HTTP_TO_HTTPS' | 'HTTPS_TO_HTTP';
+    Cname: string;
+    IsDefault: boolean;
+    Enable: boolean;
+    Status: 'PROCESSING' | 'FAIL' | 'SUCCESS';
+    DNSStatus: 'OK' | 'INVALID';
+    Routes?: HTTPServiceRoute[];
+    CreateTime: string;
+    UpdateTime: string;
+}
+/**
+ * 过滤条件
+ */
+export interface HTTPServiceRouteFilter {
+    Name?: 'Domain' | 'Path' | 'DomainType' | 'UpstreamResourceType';
+    Values?: string[];
+}
+/**
+ * DescribeHTTPServiceRoute 请求参数
+ */
+export interface DescribeHttpServiceRouteParams {
+    EnvId: string;
+    Filters?: HTTPServiceRouteFilter[];
+    Offset?: number;
+    Limit?: number;
+}
+/**
+ * DescribeHTTPServiceRoute 返回结果
+ */
+export interface DescribeHttpServiceRouteRes {
+    Domains?: HTTPServiceDomain[];
+    OriginDomain: string;
+    TotalCount: number;
+    RequestId: string;
+}
+/**
+ * HTTP访问服务路由参数（创建/修改）
+ */
+export interface HTTPServiceRouteParam {
+    Path: string;
+    UpstreamResourceType?: 'SCF' | 'CBR' | 'STATIC_STORE' | 'WEB_SCF' | 'LH';
+    UpstreamResourceName?: string;
+    PathRewrite?: HTTPServicePathRewrite;
+    EnableSafeDomain?: boolean;
+    EnableAuth?: boolean;
+    EnablePathTransmission?: boolean;
+    QPSPolicy?: HTTPServiceRouteQPSPolicy;
+    Enable?: boolean;
+}
+/**
+ * HTTP访问服务域名参数（创建/修改）
+ */
+export interface HTTPServiceDomainParam {
+    Domain: string;
+    AccessType?: 'DIRECT' | 'CDN' | 'CUSTOM';
+    CertId?: string;
+    Protocol?: 'HTTP_AND_HTTPS' | 'HTTP_TO_HTTPS' | 'HTTPS_TO_HTTP';
+    CustomCname?: string;
+    Enable?: boolean;
+    Routes?: HTTPServiceRouteParam[];
+}
+/**
+ * CreateHTTPServiceRoute 请求参数
+ */
+export interface CreateHttpServiceRouteParams {
+    EnvId: string;
+    Domain: HTTPServiceDomainParam;
+}
+/**
+ * CreateHTTPServiceRoute 返回结果
+ */
+export interface CreateHttpServiceRouteRes {
+    RequestId: string;
+}
+/**
+ * ModifyHTTPServiceRoute 请求参数
+ */
+export interface ModifyHttpServiceRouteParams {
+    EnvId: string;
+    Domain: HTTPServiceDomainParam;
+}
+/**
+ * ModifyHTTPServiceRoute 返回结果
+ */
+export interface ModifyHttpServiceRouteRes {
+    RequestId: string;
+}
+/**
+ * DeleteHTTPServiceRoute 请求参数
+ */
+export interface DeleteHttpServiceRouteParams {
+    EnvId: string;
+    Domain: string;
+    Paths?: string[];
+}
+/**
+ * DeleteHTTPServiceRoute 返回结果
+ */
+export interface DeleteHttpServiceRouteRes {
+    RequestId: string;
+}
+/**
+ * 绑定自定义域名的域名参数
+ * 与 HTTPServiceDomainParam 类似，但不包含 Routes（绑定域名场景）
+ */
+export interface BindCustomDomainDomainParam {
+    Domain: string;
+    CertId: string;
+    AccessType?: 'DIRECT' | 'CDN' | 'CUSTOM';
+    Protocol?: 'HTTP_AND_HTTPS' | 'HTTP_TO_HTTPS' | 'HTTPS_TO_HTTP';
+    Enable?: boolean;
+    CustomCname?: string;
+}
+/**
+ * BindCustomDomain 请求参数
+ * 用于绑定自定义域名到 HTTP 访问服务
+ * 底层调用 CreateHTTPServiceRoute API，但参数配置不同
+ */
+export interface BindCustomDomainParams {
+    EnvId: string;
+    Domain: BindCustomDomainDomainParam;
+}
+/**
+ * BindCustomDomain 返回结果
+ */
+export interface BindCustomDomainRes {
+    RequestId: string;
+}
+/**
+ * DeleteCustomDomain 请求参数
+ * 用于删除自定义域名（仅当域名下无路由绑定时可删除）
+ */
+export interface DeleteCustomDomainParams {
+    EnvId: string;
+    Domain: string;
+}
+/**
+ * DeleteCustomDomain 返回结果
+ */
+export interface DeleteCustomDomainRes {
+    RequestId: string;
+}

package/types/environment.d.ts

@@ -5,13 +5,17 @@ import { AgentService } from './agent';
 import { StorageService } from './storage';
 import { EnvService } from './env';
 import { CommonService } from './common';
+import { LogService } from './log';
 import { CloudBaseContext } from './context';
 import { HostingService } from './hosting';
 import { ThirdService } from './third';
 import { AccessService } from './access';
 import { UserService } from './user';
 import { CloudBaseRunService } from './cloudBaseRun';
+import { MysqlService } from './mysql';
+import { CloudAppService } from './cloudApp';
 import { EnvInfo } from './interfaces';
+import { PermissionService } from './permission';
 export declare class Environment {
     inited: boolean;
     cloudBaseContext: CloudBaseContext;
@@ -24,11 +28,15 @@ export declare class Environment {
     private databaseService;
     private storageService;
     private envService;
+    private logService;
     private hostingService;
     private thirdService;
     private accessService;
     private userService;
     private cloudBaseRunService;
+    private mysqlService;
+    private permissionService;
+    private cloudAppService;
     constructor(context: CloudBaseContext, envId: string);
     lazyInit(): Promise<any>;
     getEnvId(): string;
@@ -39,11 +47,15 @@ export declare class Environment {
     getCloudRunService(): CloudRunService;
     getAgentService(): AgentService;
     getEnvService(): EnvService;
+    getLogService(): LogService;
     getHostingService(): HostingService;
     getThirdService(): ThirdService;
     getAccessService(): AccessService;
     getUserService(): UserService;
     getCloudBaseRunService(): CloudBaseRunService;
+    getMysqlService(): MysqlService;
+    getCloudAppService(): CloudAppService;
+    getPermissionService(): PermissionService;
     getCommonService(serviceType: string, serviceVersion: any): CommonService;
     getServicesEnvInfo(): Promise<any>;
     getAuthConfig(): {

package/types/function/index.d.ts

@@ -277,9 +277,9 @@ export declare class FunctionService {
      * @param {string} qualifier 需要删除的版本号，不填默认删除函数下全部版本。
      * @returns {Promise<IResponseInfo>}
      */
-    deleteFunction({ name }: {
-        name: any;
-    }): Promise<void>;
+    deleteFunction(name: string | {
+        name: string;
+    }): Promise<IResponseInfo>;
     /**
      * 批量删除云函数
      * @param {Object} options
@@ -368,6 +368,27 @@ export declare class FunctionService {
      * @memberof FunctionService
      */
     updateFunctionCode(funcParam: IUpdateFunctionCodeParam): Promise<IResponseInfo>;
+    /**
+     * 更新函数代码和配置（带进度信息）
+     * 支持同时更新代码和配置，按顺序执行：等待就绪 → 更新代码 → 等待就绪 → 更新配置 → 等待就绪
+     * @param options 更新选项
+     * @returns 更新结果，包含耗时信息
+     */
+    updateFunctionWithProgress(options: {
+        /** 函数名称 */
+        name: string;
+        /** 代码相关参数（可选），复用 IUpdateFunctionCodeParam（排除 func，由 name 替代） */
+        code?: Omit<IUpdateFunctionCodeParam, 'func'>;
+        /** 配置相关参数（可选），复用 ICloudFunction（排除 name，由外层 name 替代） */
+        config?: Omit<ICloudFunction, 'name'>;
+    }): Promise<{
+        /** 总耗时（毫秒） */
+        elapsedTime: number;
+        /** 结果消息 */
+        message: string;
+        /** 详细步骤信息 */
+        details: string[];
+    }>;
     /**
      * 调用云函数
      * @param {string} name 云函数名称
@@ -404,7 +425,7 @@ export declare class FunctionService {
      * @param {string} triggerName 云函数触发器名称
      * @returns {Promise<IResponseInfo>}
      */
-    deleteFunctionTrigger(name: string, triggerName: string): Promise<void>;
+    deleteFunctionTrigger(name: string, triggerName: string): Promise<IResponseInfo>;
     batchDeleteTriggers(options: IFunctionBatchOptions): Promise<void>;
     /**
      * 下载云函数代码
@@ -496,8 +517,16 @@ export declare class FunctionService {
     uploadFunctionZipToCos(options: IFunctionCode, installDependency: 'TRUE' | 'FALSE'): Promise<{
         UnixTimestamp: string;
     }>;
+    getCodeParams(options: IFunctionCode, installDependency: 'TRUE' | 'FALSE'): Promise<{
+        ZipFile: string;
+        CosBucketRegion?: undefined;
+        TempCosObjectName?: undefined;
+    } | {
+        CosBucketRegion: string;
+        TempCosObjectName: string;
+        ZipFile?: undefined;
+    }>;
     private createAccessPath;
-    private getCodeParams;
     private getTempCosInfo;
     private retryCreateTrigger;
     /**

package/types/index.d.ts

@@ -4,6 +4,7 @@ import { CloudRunService } from './cloudrun';
 import { AgentService } from './agent';
 import { StorageService } from './storage';
 import { DatabaseService } from './database';
+import { LogService } from './log';
 import { CommonService } from './common';
 import { HostingService } from './hosting';
 import { Environment } from './environment';
@@ -12,7 +13,10 @@ import { ThirdService } from './third';
 import { AccessService } from './access';
 import { UserService } from './user';
 import { CloudBaseRunService } from './cloudBaseRun';
+import { MysqlService } from './mysql';
 import { DocsService } from './docs';
+import { PermissionService } from './permission';
+import { CloudAppService } from './cloudApp';
 interface CloudBaseConfig {
     secretId?: string;
     secretKey?: string;
@@ -49,11 +53,33 @@ declare class CloudBase {
     get database(): DatabaseService;
     get hosting(): HostingService;
     get access(): AccessService;
+    get mysql(): MysqlService;
+    /**
+     * 云托管服务（CloudBaseRun）
+     * 提供云托管版本流量配置等能力
+     * @deprecated 请使用 cloudBaseRun 代替，避免与 cloudAppService 混淆
+     */
     get cloudApp(): CloudBaseRunService;
+    /**
+     * 云托管服务（CloudBaseRun）
+     * 提供云托管版本流量配置等能力
+     */
+    get cloudBaseRun(): CloudBaseRunService;
+    /**
+     * 云应用服务（CloudApp 统一部署）
+     * 提供 Web 应用的创建、部署、版本管理等能力
+     */
+    get cloudAppService(): CloudAppService;
+    /**
+     * 获取云应用服务
+     */
+    getCloudAppService(): CloudAppService;
     commonService(service?: string, version?: string): CommonService;
     get env(): EnvService;
+    get log(): LogService;
     get third(): ThirdService;
     get user(): UserService;
+    get permission(): PermissionService;
     get docs(): DocsService;
     getEnvironmentManager(): EnvironmentManager;
     getManagerConfig(): CloudBaseConfig;

package/types/interfaces/cloudApp.interface.d.ts

@@ -0,0 +1,4 @@
+/**
+ * CloudApp 统一部署服务接口导出
+ */
+export * from '../cloudApp/types';

package/types/interfaces/index.d.ts

@@ -5,3 +5,4 @@ export * from './base.interface';
 export * from './storage.interface';
 export * from './cam.interface';
 export * from './billing.interface';
+export * from './cloudApp.interface';

package/types/log/index.d.ts

@@ -0,0 +1,53 @@
+import { Environment } from '../environment';
+import { ISearchClsLogParams, ISearchClsLogResponse } from './types';
+export * from './types';
+export interface ICreateEnvResourceResponse {
+    RequestId: string;
+}
+export interface ILogServiceEntry {
+    LogsetId?: string;
+    TopicId?: string;
+    TopicName?: string;
+    Region?: string;
+}
+/**
+ * 纯函数：根据 DescribeEnvs 返回的 LogServices 列表判断日志服务是否已开通。
+ * 已开通条件：至少一个条目有有效的 TopicId。
+ */
+export declare function isLogServiceEnabled(logServices?: ILogServiceEntry[]): boolean;
+export declare class LogService {
+    private envId;
+    private cloudService;
+    private tcbrService;
+    constructor(environment: Environment);
+    /**
+     * 检查当前环境的日志服务是否已开通
+     *
+     * 通过 DescribeEnvs 接口获取环境信息，判断 LogServices 字段中是否包含有效的
+     * 日志主题（TopicId 不为空）。
+     *
+     * @returns true 表示已开通，false 表示未开通或开通中
+     */
+    checkLogServiceEnabled(): Promise<boolean>;
+    /**
+     * 开通环境日志服务（异步操作）
+     *
+     * 调用 CreateEnvResource 接口开通日志资源。
+     * 注意：接口调用成功不代表日志资源立即可用，需通过 checkLogServiceEnabled() 轮询确认。
+     *
+     * @returns 请求 ID
+     */
+    createLogService(): Promise<ICreateEnvResourceResponse>;
+    /**
+     * 搜索 CLS 日志
+     *
+     * @param params 查询参数，通过 queryString 使用 CLS 原生检索分析语法
+     * @returns 日志搜索结果
+     *
+     * @remarks
+     * - 纯检索结果在 `LogResults.Results` 中
+     * - SQL 分析结果（queryString 含 `| select ...`）在 `LogResults.AnalysisRecords` 中
+     * - 详细的 QueryString 语法参考见 README.md
+     */
+    searchClsLog(params: ISearchClsLogParams): Promise<ISearchClsLogResponse>;
+}

package/types/log/types.d.ts

@@ -0,0 +1,177 @@
+/**
+ * 单个 module 的查询 schema 描述
+ */
+export interface ClsModuleQuerySchema {
+    /** module 中文名 */
+    label: string;
+    /** 可用的 eventType（没有则为 never） */
+    eventType: string;
+    /** 可用的 logType（没有则为 never） */
+    logType: string;
+}
+/**
+ * 各 module 的完整查询 schema 映射
+ *
+ * 用法示例：
+ * ```ts
+ * // 获取某个 module 下可用的 eventType
+ * type DbEvents = ClsModuleSchema['database']['eventType']   // 'MongoSlowQuery'
+ * type RdbEvents = ClsModuleSchema['rdb']['eventType']        // 'MysqlFreeze' | 'MysqlRecover' | 'MysqlSlowQuery'
+ * type AppEvents = ClsModuleSchema['app']['eventType']        // 'AppProdPub' | 'AppProdDel'
+ * type LlmLogType = ClsModuleSchema['llm']['logType']         // 'llm-tracelog'
+ *
+ * // 获取所有 module 名
+ * type Modules = ClsLogModule                                  // 'database' | 'rdb' | 'model' | ...
+ * ```
+ *
+ * 查询语句示例（CLS 语法）：
+ * - 查询云数据库[文档型]：`module:database`
+ * - 查询文档型慢查询：`module:database AND eventType:MongoSlowQuery`
+ * - 查询云数据库[SQL型]：`module:rdb`
+ * - 查询SQL型事件：`module:rdb AND eventType:(MysqlFreeze OR MysqlRecover OR MysqlSlowQuery)`
+ * - 查询审批流：`module:workflow`
+ * - 查询数据模型：`module:model`
+ * - 查询用户权限：`module:auth`
+ * - 查询大模型：`module:llm AND logType:llm-tracelog`
+ * - 查询网关服务调用：`logType:accesslog`
+ * - 查询应用发布/删除：`module:app AND eventType:(AppProdPub OR AppProdDel)`
+ */
+export interface ClsModuleSchema {
+    /** 云数据库（文档型/MongoDB） */
+    database: {
+        label: '云数据库(文档型)';
+        /** MongoSlowQuery: 文档型数据库慢查询 */
+        eventType: 'MongoSlowQuery';
+        logType: never;
+    };
+    /** 云数据库（SQL型/MySQL） */
+    rdb: {
+        label: '云数据库(SQL型)';
+        /** MysqlFreeze: 数据库冻结 | MysqlRecover: 数据库恢复 | MysqlSlowQuery: 数据库慢查询 */
+        eventType: 'MysqlFreeze' | 'MysqlRecover' | 'MysqlSlowQuery';
+        logType: never;
+    };
+    /** 数据模型 */
+    model: {
+        label: '数据模型';
+        eventType: never;
+        logType: never;
+    };
+    /** 审批流 */
+    workflow: {
+        label: '审批流';
+        eventType: never;
+        logType: never;
+    };
+    /** 用户权限 */
+    auth: {
+        label: '用户权限';
+        eventType: never;
+        logType: never;
+    };
+    /** 大模型 */
+    llm: {
+        label: '大模型';
+        eventType: never;
+        /** llm-tracelog: 大模型追踪日志 */
+        logType: 'llm-tracelog';
+    };
+    /** 应用 */
+    app: {
+        label: '应用';
+        /** AppProdPub: 应用发布 | AppProdDel: 应用删除 */
+        eventType: 'AppProdPub' | 'AppProdDel';
+        logType: never;
+    };
+}
+/** CLS 日志模块 */
+export type ClsLogModule = keyof ClsModuleSchema;
+/** CLS 日志事件类型（所有 module 的 eventType 联合） */
+export type ClsEventType = ClsModuleSchema[ClsLogModule]['eventType'];
+/** CLS 日志类型 */
+export type ClsLogType = ClsModuleSchema[ClsLogModule]['logType'] | 'accesslog';
+/** 获取指定 module 的 eventType */
+export type EventTypeOf<M extends ClsLogModule> = ClsModuleSchema[M]['eventType'];
+/** 获取指定 module 的 logType */
+export type LogTypeOf<M extends ClsLogModule> = ClsModuleSchema[M]['logType'];
+/**
+ * CLS 日志搜索基础参数
+ */
+export interface ISearchClsLogBaseParams {
+    /** 查询起始时间，格式 'YYYY-MM-DD HH:mm:ss' */
+    StartTime: string;
+    /** 查询结束时间，格式 'YYYY-MM-DD HH:mm:ss' */
+    EndTime: string;
+    /** 单次返回条数，最大 100 */
+    Limit: number;
+    /** 分页游标，首次为空，后续透传上次返回的 Context */
+    Context?: string;
+    /** 排序方式：'asc' 升序 / 'desc' 降序（默认 desc） */
+    Sort?: 'asc' | 'desc';
+    /** 是否使用 Lucene 语法（默认 false） */
+    UseLucene?: boolean;
+    /**
+     * 指定调用的后端服务（默认 'tcb'）
+     * - 'tcb': 云函数、数据库等日志（默认）
+     * - 'tcbr': 云托管日志
+     */
+    service?: 'tcb' | 'tcbr';
+}
+/**
+ * CLS 日志搜索参数
+ */
+export interface ISearchClsLogParams extends ISearchClsLogBaseParams {
+    /** CLS 检索分析语句（支持 `| select ...` SQL 分析） */
+    queryString: string;
+}
+/**
+ * CLS 日志对象
+ */
+export interface IClsLogObject {
+    /** 日志所属的 Topic ID */
+    TopicId: string;
+    /** Topic 名称 */
+    TopicName: string;
+    /** 日志时间 */
+    Timestamp: string;
+    /** 日志内容（JSON 字符串，需 JSON.parse） */
+    Content: string;
+    /** 采集路径 */
+    FileName: string;
+    /** 日志来源设备 */
+    Source: string;
+}
+/**
+ * CLS 日志搜索响应
+ */
+export interface ISearchClsLogResponse {
+    /** 日志结果 */
+    LogResults: {
+        /** 分页游标，用于获取下一页 */
+        Context: string;
+        /** 是否已返回全部结果 */
+        ListOver: boolean;
+        /** 日志列表（纯检索模式的结果） */
+        Results: IClsLogObject[];
+        /**
+         * SQL 分析结果（当 QueryString 包含 `| select ...` 管道时返回）
+         *
+         * 每个元素是一个 JSON 字符串，需 JSON.parse 解析
+         * 纯检索模式（无 `|` 管道）时为空数组
+         */
+        AnalysisRecords?: string[];
+    };
+    /** 请求 ID */
+    RequestId: string;
+}
+/**
+ * ClsModuleSchema 的运行时版本，用于动态生成查询条件 / MCP tool description
+ *
+ * - key 与 ClsLogModule 类型保持同步
+ * - eventTypes / logTypes 为字符串数组，空数组表示该维度不可过滤
+ */
+export declare const CLS_MODULE_SCHEMA: Record<ClsLogModule, {
+    label: string;
+    eventTypes: string[];
+    logTypes: string[];
+}>;