@cloudbase/manager-node 5.8.7 → 5.8.8

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## @cloudbase/manager-node v5.8.7 版本发布 🚀(2026-09-14)
+
+- 新增 HTTP 服务缓存刷新相关 API
+- 重构 移除 ENABLE_TCBF 开关，统一走 TCB 函数接口
+
+---
+
 ## @cloudbase/manager-node v5.8.6 版本发布 🚀(2026-09-09)
 
 - 新增 hosting 本地构建拆分 npm install 并导出构建能力供 CLI 复用

package/lib/env/index.js

@@ -17,6 +17,7 @@ const signature_nodejs_1 = require("@cloudbase/signature-nodejs");
 const error_1 = require("../error");
 const utils_1 = require("../utils");
 const constant_1 = require("../constant");
+const storage_config_1 = require("../utils/storage-config");
 const billing_1 = require("../billing");
 const uuid_1 = require("uuid");
 class EnvService {
@@ -919,7 +920,16 @@ class EnvService {
         return res.CORSRules;
     }
     // 添加 COS CORS 域名，和 Web 端行为保持一致
+    // 共享桶（ExternalStorage）环境直接跳过：桶的 CORS 规则作用于桶内所有环境，不能随单个环境的安全域名覆盖；
+    // 调用方未 await 此方法，这里不抛错，避免产生未处理的 Promise rejection
     async modifyCosCorsDomain(domain, deleted = false) {
+        var _a, _b, _c;
+        const storage = (_b = (_a = this.environment.lazyEnvironmentConfig) === null || _a === void 0 ? void 0 : _a.Storages) === null || _b === void 0 ? void 0 : _b[0];
+        // 环境未开通云存储（Storages 为空）时同样跳过：此时 getStorageConfig() 会抛错，
+        // 而调用方未 await 本方法，抛出即为未处理的 Promise rejection
+        if (!storage || (!storage.Bucket && ((_c = storage.ExternalStorage) === null || _c === void 0 ? void 0 : _c.Enabled) === true)) {
+            return;
+        }
         const cos = this.getCos();
         const putBucketCors = util_1.default.promisify(cos.putBucketCors).bind(cos);
         const { bucket, region } = this.getStorageConfig();
@@ -966,15 +976,7 @@ class EnvService {
         return new cos_nodejs_sdk_v5_1.default(cosConfig);
     }
     getStorageConfig() {
-        var _a;
-        const envConfig = this.environment.lazyEnvironmentConfig;
-        const storageConfig = (_a = envConfig === null || envConfig === void 0 ? void 0 : envConfig.Storages) === null || _a === void 0 ? void 0 : _a[0];
-        const { Region, Bucket } = storageConfig;
-        return {
-            env: envConfig.EnvId,
-            region: Region,
-            bucket: Bucket
-        };
+        return (0, storage_config_1.resolveStorageConfig)(this.environment.lazyEnvironmentConfig);
     }
     parseBillTags(billTags) {
         if (typeof billTags !== 'string') {

package/lib/environment.js

@@ -25,6 +25,7 @@ const sandbox_1 = require("./sandbox");
 const aiModel_1 = require("./aiModel");
 const monitor_1 = require("./monitor");
 const integration_1 = require("./integration");
+const platform_1 = require("./platform");
 class Environment {
     constructor(context, envId) {
         this.inited = false;
@@ -52,6 +53,7 @@ class Environment {
         this.aiModelService = new aiModel_1.AiModelService(this);
         this.monitorService = new monitor_1.MonitorService(this);
         this.integrationService = new integration_1.IntegrationService(this);
+        this.platformService = new platform_1.PlatformService(this);
     }
     async lazyInit() {
         if (!this.inited) {
@@ -142,6 +144,12 @@ class Environment {
     getIntegrationService() {
         return this.integrationService;
     }
+    /**
+     * 获取平台版套餐服务
+     */
+    getPlatformService() {
+        return this.platformService;
+    }
     getCommonService(serviceType = 'tcb', serviceVersion) {
         return new common_1.CommonService(this, serviceType, serviceVersion);
     }

package/lib/error.js

@@ -5,12 +5,13 @@ class CloudBaseError extends Error {
     constructor(message, options = {}) {
         super();
         this.name = 'CloudBaseError';
-        const { code = '', action = '', original = null, requestId = '' } = options;
+        const { code = '', action = '', original = null, requestId = '', meta } = options;
         this.message = action ? `[${action}] ${message}` : message;
         this.original = original;
         this.code = code;
         this.requestId = requestId;
         this.action = action;
+        this.meta = meta;
     }
 }
 exports.CloudBaseError = CloudBaseError;

package/lib/hosting/index.js

@@ -16,6 +16,7 @@ const make_dir_1 = __importDefault(require("make-dir"));
 const error_1 = require("../error");
 const utils_1 = require("../utils");
 const parallel_1 = require("../utils/parallel");
+const storage_config_1 = require("../utils/storage-config");
 const envDomainCache = new Map();
 const HostingStatusMap = {
     init: '初始化中',
@@ -66,13 +67,13 @@ class HostingService {
         };
     }
     async findFiles(options) {
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region, basePath } = await this.getHostingBucket();
         const { maxKeys, marker, prefix } = options;
         const storageService = await this.environment.getStorageService();
         const res = await storageService.getBucket({
-            bucket: Bucket,
-            region: Regoin,
+            bucket,
+            region,
+            basePath,
             maxKeys,
             marker,
             prefix
@@ -83,13 +84,13 @@ class HostingService {
      * 展示文件列表
      */
     async listFiles() {
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region, basePath } = await this.getHostingBucket();
         const storageService = await this.environment.getStorageService();
         const list = await storageService.walkCloudDirCustom({
             prefix: '',
-            bucket: Bucket,
-            region: Regoin
+            bucket,
+            region,
+            basePath
         });
         return list;
     }
@@ -132,8 +133,7 @@ class HostingService {
      */
     async uploadFiles(options) {
         const { localPath, cloudPath, entryFiles, files = [], onProgress, onFileFinish, parallel = 20, ignore = ['.DS_Store'], retryCount, retryInterval, verify = false, safe = false, prune = false } = options;
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region, basePath } = await this.getHostingBucket();
         const storageService = await this.environment.getStorageService();
         let uploadFiles = Array.isArray(files) ? files : [];
         // localPath 存在，上传文件夹/文件
@@ -147,8 +147,9 @@ class HostingService {
                         localPath: resolvePath,
                         cloudPath,
                         entries: entryFiles,
-                        bucket: Bucket,
-                        region: Regoin,
+                        bucket,
+                        region,
+                        basePath,
                         onProgress,
                         onFileFinish,
                         fileId: false,
@@ -165,12 +166,14 @@ class HostingService {
                     localPath: resolvePath,
                     cloudPath,
                     entryFiles,
-                    bucket: Bucket,
-                    region: Regoin,
+                    bucket,
+                    region,
+                    basePath,
                     onProgress,
                     onFileFinish,
                     fileId: false,
                     ignore,
+                    parallel,
                     retryCount,
                     retryInterval,
                 });
@@ -190,8 +193,9 @@ class HostingService {
             parallel,
             onProgress,
             onFileFinish,
-            bucket: Bucket,
-            region: Regoin,
+            bucket,
+            region,
+            basePath,
             files: uploadFiles,
             fileId: false,
             retryCount,
@@ -204,19 +208,20 @@ class HostingService {
      */
     async deleteFiles(options) {
         const { cloudPath, isDir } = options;
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region, basePath } = await this.getHostingBucket();
         const storageService = await this.environment.getStorageService();
         if (isDir) {
             return storageService.deleteDirectoryCustom({
                 cloudPath,
-                bucket: Bucket,
-                region: Regoin
+                bucket,
+                region,
+                basePath
             });
         }
         else {
             try {
-                await storageService.deleteFileCustom([cloudPath], Bucket, Regoin);
+                // deleteFileCustom 按 COS 原始 Key 删除，共享桶下需先换算为物理 Key
+                await storageService.deleteFileCustom([(0, storage_config_1.toPhysicalKey)(basePath, cloudPath)], bucket, region);
                 return {
                     Deleted: [{ Key: cloudPath }],
                     Error: []
@@ -281,14 +286,15 @@ class HostingService {
     async downloadDirectory(options) {
         const { cloudPath, localPath } = options;
         const resolveLocalPath = path_1.default.resolve(localPath);
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region, basePath } = await this.getHostingBucket();
         const cloudDirectoryKey = this.getCloudKey(cloudPath);
         const storageService = await this.environment.getStorageService();
+        // 返回逻辑路径，downloadFile 通过托管域名访问，网关会自动拼接 BasePath
         const files = await storageService.walkCloudDirCustom({
             prefix: cloudDirectoryKey,
-            bucket: Bucket,
-            region: Regoin
+            bucket,
+            region,
+            basePath
         });
         const tasks = files.map(file => async () => {
             const fileRelativePath = file.Key.replace(cloudDirectoryKey, '');
@@ -389,10 +395,9 @@ class HostingService {
      * @memberof HostingService
      */
     async getWebsiteConfig() {
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region } = await this.getHostingBucket();
         const storageService = await this.environment.getStorageService();
-        const res = await storageService.getWebsiteConfig({ bucket: Bucket, region: Regoin });
+        const res = await storageService.getWebsiteConfig({ bucket, region });
         return res;
     }
     /**
@@ -401,12 +406,15 @@ class HostingService {
      */
     async setWebsiteDocument(options) {
         const { indexDocument, errorDocument, originalHttpStatus, charity404, autoAddressing, routingRules } = options;
-        const hosting = await this.checkStatus();
-        const { Bucket, Regoin } = hosting;
+        const { bucket, region, basePath } = await this.getHostingBucket();
+        // 共享桶的静态网站配置作用于桶内所有环境，按兼容边界（桶级操作不可作用于共享桶本身）明确拒绝
+        if (basePath) {
+            throw new error_1.CloudBaseError('当前环境的静态托管使用共享桶（ExternalStorage），静态网站配置作用于整个共享桶，由平台统一管理，不支持修改', { code: 'INVALID_OPERATION' });
+        }
         const storageService = await this.environment.getStorageService();
         const res = await storageService.putBucketWebsite({
-            bucket: Bucket,
-            region: Regoin,
+            bucket,
+            region,
             indexDocument,
             errorDocument,
             originalHttpStatus,
@@ -434,13 +442,27 @@ class HostingService {
         }
         return website;
     }
+    /**
+     * 检查 hosting 服务状态并解析有效桶，兼容共享桶（ExternalStorage）环境
+     * 静态托管的共享桶与 BasePath 独立于云存储，不能复用 StorageService.getStorageConfig
+     */
+    async getHostingBucket() {
+        const website = await this.checkStatus();
+        return (0, storage_config_1.resolveBucketConfig)({
+            envId: this.environment.getEnvId(),
+            bucket: website.Bucket,
+            region: website.Regoin,
+            externalStorage: website.ExternalStorage
+        });
+    }
     /**
      * 获取配置
      */
     getHostingConfig() {
-        var _a;
+        var _a, _b;
         const envConfig = this.environment.lazyEnvironmentConfig;
-        const appId = (_a = envConfig.Storages[0]) === null || _a === void 0 ? void 0 : _a.AppId;
+        // 环境未开通云存储时 Storages 为空，取 appId 不应崩溃（托管信息不依赖 appId）
+        const appId = (_b = (_a = envConfig.Storages) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.AppId;
         const { proxy } = this.environment.cloudBaseContext;
         return {
             appId,

package/lib/index.js

@@ -151,6 +151,13 @@ class CloudBase {
     get monitor() {
         return this.currentEnvironment().getMonitorService();
     }
+    /**
+     * 平台版套餐服务
+     * 提供平台版套餐查询、环境管理、资源用量及 HTTP 访问服务路由等能力
+     */
+    get platform() {
+        return this.currentEnvironment().getPlatformService();
+    }
     get docs() {
         if (!this.docsService) {
             this.docsService = new docs_1.DocsService();

package/lib/platform/index.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformService = void 0;
+const error_1 = require("../error");
+const utils_1 = require("../utils");
+/**
+ * 平台版服务
+ * 提供平台版套餐查询、资源用量统计、环境生命周期管理及 HTTP 访问服务路由管理能力
+ */
+class PlatformService {
+    constructor(environment) {
+        this.environment = environment;
+        this.envId = environment.getEnvId();
+        this.cloudService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
+    }
+    /**
+     * 查询在售的平台版套餐列表
+     * 返回当前可购买的平台版套餐，包括计费下单配置（BillTags）、套餐规格（Spec）等商品信息，
+     * 用于购买前的套餐查询，不涉及用户已购资源。
+     * @param {DescribePlatformPackageListParams} params 查询参数，可通过 PackageId 查询指定套餐
+     * @returns {Promise<DescribePlatformPackageListRes>} 在售套餐列表
+     */
+    async describePlatformPackageList(params = {}) {
+        return this.cloudService.request('DescribePlatformPackageList', Object.assign({}, params));
+    }
+    /**
+     * 查询当前账号下的平台版资源实例列表
+     * 返回已购平台版资源的计费信息（购买与过期时间、计费状态、自动续费），
+     * 以及存储、日志、静态托管等底层资源明细。
+     * @param {DescribePlatformsParams} params 查询参数，PlatformIds 指定实例（缺省分页返回全部），Limit 取值 [10, 100]
+     * @returns {Promise<DescribePlatformsRes>} 平台版资源列表及总数
+     * @throws {CloudBaseError} Limit 非法时抛出，须为 10 至 100 的整数
+     */
+    async describePlatforms(params = {}) {
+        const { Limit } = params;
+        if (Limit !== undefined && (!Number.isInteger(Limit) || Limit < 10 || Limit > 100)) {
+            throw new error_1.CloudBaseError('Limit 必须是 10 至 100 的整数');
+        }
+        return this.cloudService.request('DescribePlatforms', Object.assign({}, params));
+    }
+    /**
+     * 查询平台版资源当前所处的计费周期
+     * 平台版资源点按月结算，计费周期自购买日起算，每个周期各享有一笔抵扣额度。
+     * 例如 2026-01-05 购买 3 个月（2026-04-05 到期），则三个周期分别为
+     * 01-05 ~ 02-05、02-06 ~ 03-05、03-06 ~ 04-05。
+     * @param {DescribePlatformAccountCircleParams} params 查询参数，WithHistoryCircle 为 true 时附带返回最近两个历史周期
+     * @returns {Promise<DescribePlatformAccountCircleRes>} 当前周期起止时间及是否过期
+     */
+    async describePlatformAccountCircle(params) {
+        return this.cloudService.request('DescribePlatformAccountCircle', Object.assign({}, params));
+    }
+    /**
+     * 查询平台版资源的资源点用量汇总
+     * 返回指定时间范围内的资源点用量统计，包括套餐内抵扣、资源包抵扣、
+     * 按量上报、原价消耗四类总量的每日明细。
+     * @param {DescribePlatformCreditsUsageParams} params 查询参数，StartDate/EndDate 格式为 'YYYY-MM-DD'
+     * @returns {Promise<DescribePlatformCreditsUsageRes>} 四类用量总量及每日明细
+     */
+    async describePlatformCreditsUsage(params) {
+        return this.cloudService.request('DescribePlatformCreditsUsage', Object.assign({}, params));
+    }
+    /**
+     * 查询平台版资源的资源点用量明细
+     * 按模块（Usages）→ 指标（MetricUsageDetail）→ 每日明细（ValueDetailList）三个层级，
+     * 返回各模块的资源点用量及原始用量明细。
+     * @param {DescribePlatformCreditsUsageDetailParams} params 查询参数，Modules 指定查询的模块（如 FLEXDB、SCF、AI、COS 等）
+     * @returns {Promise<DescribePlatformCreditsUsageDetailRes>} 各模块的用量明细数据
+     */
+    async describePlatformCreditsUsageDetail(params) {
+        return this.cloudService.request('DescribePlatformCreditsUsageDetail', Object.assign({}, params));
+    }
+    /**
+     * 查询平台版下各环境的资源点用量排行
+     * 按 TimeRange 指定的时间范围返回各环境的资源点用量排序，
+     * 排行数据由后台定时计算，可能存在小时级延迟。
+     * @param {DescribePlatformEnvCreditsRankingParams} params 查询参数，TimeRange 缺省为 Today（近 1 天）
+     * @returns {Promise<DescribePlatformEnvCreditsRankingRes>} 环境用量排行列表及分页信息
+     */
+    async describePlatformEnvCreditsRanking(params = {}) {
+        return this.cloudService.request('DescribePlatformEnvCreditsRanking', Object.assign({}, params));
+    }
+    /**
+     * 查询平台版环境内各资源类型的用量
+     * 按资源类型（存储、函数、数据库等）返回各指标的用量及按日明细，
+     * 包括资源点用量与原始用量值及对应单位。
+     * @param {DescribePlatformEnvUsageParams} params 查询参数，EnvId 缺省时使用当前环境，ResourceTypes 指定资源类型
+     * @returns {Promise<DescribePlatformEnvUsageRes>} 资源用量明细及资源点总量
+     */
+    async describePlatformEnvUsage(params) {
+        return this.cloudService.request('DescribePlatformEnvUsage', Object.assign(Object.assign({}, params), { EnvId: params.EnvId || this.envId }));
+    }
+    /**
+     * 创建平台版环境
+     * 在已购平台版资源下开通新环境。
+     * @param {CreatePlatformEnvParams} params 创建参数，ReqKey 为幂等键，可用于防止重复创建
+     * @returns {Promise<CreatePlatformEnvRes>} 新创建环境的 EnvId
+     */
+    async createPlatformEnv(params) {
+        return this.cloudService.request('CreatePlatformEnv', Object.assign({}, params));
+    }
+    /**
+     * 修改平台版环境状态
+     * 支持启用/禁用环境，以及云存储（Storage）、FlexDB 资源的状态变更，未传入的资源不做更新。
+     * @param {ModifyPlatformEnvParams} params 修改参数，EnvId 缺省时使用当前环境
+     * @returns {Promise<ModifyPlatformEnvRes>} 环境的最终状态
+     * @throws {CloudBaseError} Status 非法时抛出，仅支持 ENABLE / DISABLE
+     */
+    async modifyPlatformEnv(params) {
+        const { Status } = params;
+        const validStatus = ['ENABLE', 'DISABLE'];
+        if (Status !== undefined && !validStatus.includes(Status)) {
+            throw new error_1.CloudBaseError(`Invalid Status value: ${Status}. Only support 'ENABLE', 'DISABLE'`);
+        }
+        return this.cloudService.request('ModifyPlatformEnv', Object.assign(Object.assign({}, params), { EnvId: params.EnvId || this.envId }));
+    }
+    /**
+     * 删除平台版环境
+     * 删除操作不可逆，须显式指定目标环境 ID。
+     * @param {DestroyPlatformEnvParams} params 删除参数，EnvId 为必填
+     * @returns {Promise<DestroyPlatformEnvRes>} 请求执行结果
+     */
+    async destroyPlatformEnv(params) {
+        return this.cloudService.request('DestroyPlatformEnv', Object.assign({}, params));
+    }
+    /**
+     * 校验 HTTP 访问服务路由配置（预检）
+     * 创建路由前的只读预检，覆盖域名归属权、证书、配额、路由冲突、域名占用等检查项，
+     * 不创建任何资源。Passed 为 true 时可调用 createPlatformHttpServiceRoute 正式创建；
+     * 为 false 时根据各检查项的 Code 定位并修正问题。
+     * 预检通过不代表创建必然成功，但预检不通过则创建必然失败。
+     * @param {VerifyPlatformHTTPServiceRouteParams} params 校验参数，包含待校验的域名路由信息
+     * @returns {Promise<VerifyPlatformHTTPServiceRouteRes>} 整体校验结果及各检查项明细
+     */
+    async verifyPlatformHttpServiceRoute(params) {
+        return this.cloudService.request('VerifyPlatformHTTPServiceRoute', Object.assign({}, params));
+    }
+    /**
+     * 创建 HTTP 访问服务路由
+     * 不传 Domain.Routes 时仅创建域名信息。域名与路由均为异步下发，创建后需调用
+     * describePlatformHttpServiceRoute 轮询域名状态，直到 SUCCESS 或 FAIL（FAIL 可删除后重新创建）；
+     * 下发完成前访问域名可能返回 404 或 HTTPS 握手失败。
+     * @param {CreatePlatformHTTPServiceRouteParams} params 创建参数
+     * @returns {Promise<CreatePlatformHTTPServiceRouteRes>} 域名归属权验证指引（归属校验未通过时返回）
+     */
+    async createPlatformHttpServiceRoute(params) {
+        return this.cloudService.request('CreatePlatformHTTPServiceRoute', Object.assign({}, params));
+    }
+    /**
+     * 修改 HTTP 访问服务路由
+     * 增量更新，对应字段未传入则不修改。
+     * @param {ModifyPlatformHTTPServiceRouteParams} params 修改参数，包含目标域名及待更新的路由信息
+     * @returns {Promise<ModifyPlatformHTTPServiceRouteRes>} 请求执行结果
+     */
+    async modifyPlatformHttpServiceRoute(params) {
+        return this.cloudService.request('ModifyPlatformHTTPServiceRoute', Object.assign({}, params));
+    }
+    /**
+     * 删除 HTTP 访问服务路由
+     * Paths 为空时删除域名及其下全部路由，非空时仅删除指定路径的路由。
+     * @param {DeletePlatformHTTPServiceRouteParams} params 删除参数，Paths 缺省时删除整个域名
+     * @returns {Promise<DeletePlatformHTTPServiceRouteRes>} 请求执行结果
+     */
+    async deletePlatformHttpServiceRoute(params) {
+        return this.cloudService.request('DeletePlatformHTTPServiceRoute', Object.assign({}, params));
+    }
+    /**
+     * 查询 HTTP 访问服务路由
+     * 返回各域名及其路由信息列表、自定义接入的源站域名及域名总数，
+     * 支持按 Domain、Path、DomainType、UpstreamResourceType 过滤及分页。
+     * @param {DescribePlatformHTTPServiceRouteParams} params 查询参数，Limit 默认 20、最大 1000
+     * @returns {Promise<DescribePlatformHTTPServiceRouteRes>} 域名路由列表及域名总数
+     */
+    async describePlatformHttpServiceRoute(params) {
+        return this.cloudService.request('DescribePlatformHTTPServiceRoute', Object.assign({}, params));
+    }
+}
+exports.PlatformService = PlatformService;

package/lib/platform/type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });