@cloudbase/manager-node 5.5.5 → 5.5.6-beta.0

package/lib/environment.js

@@ -22,6 +22,7 @@ const cloudApp_1 = require("./cloudApp");
 const permission_1 = require("./permission");
 const sandbox_1 = require("./sandbox");
 const aiModel_1 = require("./aiModel");
+const monitor_1 = require("./monitor");
 class Environment {
     constructor(context, envId) {
         this.inited = false;
@@ -47,6 +48,7 @@ class Environment {
         this.cloudAppService = new cloudApp_1.CloudAppService(this);
         this.sandboxService = new sandbox_1.SandboxService(this);
         this.aiModelService = new aiModel_1.AiModelService(this);
+        this.monitorService = new monitor_1.MonitorService(this);
     }
     async lazyInit() {
         if (!this.inited) {
@@ -121,6 +123,9 @@ class Environment {
     getAiModelService() {
         return this.aiModelService;
     }
+    getMonitorService() {
+        return this.monitorService;
+    }
     getCommonService(serviceType = 'tcb', serviceVersion) {
         return new common_1.CommonService(this, serviceType, serviceVersion);
     }

package/lib/index.js

@@ -122,6 +122,9 @@ class CloudBase {
     get aiModel() {
         return this.currentEnvironment().getAiModelService();
     }
+    get monitor() {
+        return this.currentEnvironment().getMonitorService();
+    }
     get docs() {
         if (!this.docsService) {
             this.docsService = new docs_1.DocsService();

package/lib/monitor/index.js

@@ -0,0 +1,105 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MonitorService = void 0;
+const error_1 = require("../error");
+const utils_1 = require("../utils");
+__exportStar(require("./types"), exports);
+// Period 与时间范围的约束规则
+const ONE_DAY_MS = 24 * 60 * 60 * 1000;
+const THREE_DAYS_MS = 3 * ONE_DAY_MS;
+const PERIOD_RULES = [
+    { maxRangeMs: ONE_DAY_MS, allowed: [300, 3600] },
+    { maxRangeMs: THREE_DAYS_MS, allowed: [300, 3600, 86400] },
+    // 超过3天
+    { maxRangeMs: Infinity, allowed: [3600, 86400] }
+];
+function validatePeriod(startStr, endStr, period) {
+    if (period === undefined)
+        return;
+    const startMs = new Date(startStr).getTime();
+    const endMs = new Date(endStr).getTime();
+    if (isNaN(startMs) || isNaN(endMs))
+        return;
+    const rangeMs = endMs - startMs;
+    const rule = PERIOD_RULES.find(r => rangeMs <= r.maxRangeMs);
+    if (rule && !rule.allowed.includes(period)) {
+        throw new error_1.CloudBaseError(`Period=${period} 不适用于当前时间范围。` +
+            `时间范围 ${startStr} ~ ${endStr}（约 ${(rangeMs / ONE_DAY_MS).toFixed(1)} 天）` +
+            `仅支持 Period: [${rule.allowed.join(', ')}]`);
+    }
+}
+class MonitorService {
+    constructor(environment) {
+        this.envId = environment.getEnvId();
+        this.cloudService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
+    }
+    /**
+     * 查询环境监控数据
+     *
+     * 根据指定指标名称，查询当前环境在指定时间范围内的监控数据，
+     * 返回按统计粒度聚合后的时序数据。
+     *
+     * @param params 查询参数
+     * @returns 时序监控数据
+     *
+     * @example
+     * // 查询静态网站存储容量
+     * const res = await monitor.describeCurveData({
+     *     MetricName: 'StaticFsSizePkg',
+     *     StartTime: '2026-02-05 00:00:00',
+     *     EndTime: '2026-02-06 23:59:59',
+     *     Period: 3600
+     * })
+     *
+     * @example
+     * // 查询云托管某服务某版本的错误响应
+     * const res = await monitor.describeCurveData({
+     *     MetricName: 'TkeHttpErrorService',
+     *     StartTime: '2026-03-13 00:00:00',
+     *     EndTime: '2026-03-16 23:59:59',
+     *     ResourceID: 'my-service',
+     *     SubresourceID: 'my-service-001'
+     * })
+     */
+    async describeCurveData(params) {
+        // 校验 Period 与时间范围的约束关系
+        validatePeriod(params.StartTime, params.EndTime, params.Period);
+        const requestParams = {
+            EnvId: this.envId,
+            MetricName: params.MetricName,
+            StartTime: params.StartTime,
+            EndTime: params.EndTime
+        };
+        if (params.ResourceID !== undefined) {
+            requestParams.ResourceID = params.ResourceID;
+        }
+        if (params.WxAppId !== undefined) {
+            requestParams.WxAppId = params.WxAppId;
+        }
+        if (params.SubresourceID !== undefined) {
+            requestParams.SubresourceID = params.SubresourceID;
+        }
+        if (params.ThirdResource !== undefined) {
+            requestParams.ThirdResource = params.ThirdResource;
+        }
+        if (params.Period !== undefined) {
+            requestParams.Period = params.Period;
+        }
+        return this.cloudService.request('DescribeCurveData', requestParams);
+    }
+}
+exports.MonitorService = MonitorService;

package/lib/monitor/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/manager-node",
-    "version": "5.5.5",
+    "version": "5.5.6-beta.0",
     "description": "The node manage service api for cloudbase.",
     "main": "lib/index.js",
     "scripts": {

package/types/environment.d.ts

@@ -18,6 +18,7 @@ import { EnvInfo } from './interfaces';
 import { PermissionService } from './permission';
 import { SandboxService } from './sandbox';
 import { AiModelService } from './aiModel';
+import { MonitorService } from './monitor';
 export declare class Environment {
     inited: boolean;
     cloudBaseContext: CloudBaseContext;
@@ -41,6 +42,7 @@ export declare class Environment {
     private cloudAppService;
     private sandboxService;
     private aiModelService;
+    private monitorService;
     constructor(context: CloudBaseContext, envId: string);
     lazyInit(): Promise<any>;
     getEnvId(): string;
@@ -62,6 +64,7 @@ export declare class Environment {
     getPermissionService(): PermissionService;
     getSandboxService(): SandboxService;
     getAiModelService(): AiModelService;
+    getMonitorService(): MonitorService;
     getCommonService(serviceType: string, serviceVersion: any): CommonService;
     getServicesEnvInfo(): Promise<any>;
     getAuthConfig(): {

package/types/index.d.ts

@@ -19,6 +19,7 @@ import { PermissionService } from './permission';
 import { SandboxService } from './sandbox';
 import { CloudAppService } from './cloudApp';
 import { AiModelService } from './aiModel';
+import { MonitorService } from './monitor';
 interface CloudBaseConfig {
     secretId?: string;
     secretKey?: string;
@@ -84,6 +85,7 @@ declare class CloudBase {
     get permission(): PermissionService;
     get sandbox(): SandboxService;
     get aiModel(): AiModelService;
+    get monitor(): MonitorService;
     get docs(): DocsService;
     getEnvironmentManager(): EnvironmentManager;
     getManagerConfig(): CloudBaseConfig;

package/types/monitor/index.d.ts

@@ -0,0 +1,37 @@
+import { Environment } from '../environment';
+import { IDescribeCurveDataParams, IDescribeCurveDataResponse } from './types';
+export * from './types';
+export declare class MonitorService {
+    private envId;
+    private cloudService;
+    constructor(environment: Environment);
+    /**
+     * 查询环境监控数据
+     *
+     * 根据指定指标名称，查询当前环境在指定时间范围内的监控数据，
+     * 返回按统计粒度聚合后的时序数据。
+     *
+     * @param params 查询参数
+     * @returns 时序监控数据
+     *
+     * @example
+     * // 查询静态网站存储容量
+     * const res = await monitor.describeCurveData({
+     *     MetricName: 'StaticFsSizePkg',
+     *     StartTime: '2026-02-05 00:00:00',
+     *     EndTime: '2026-02-06 23:59:59',
+     *     Period: 3600
+     * })
+     *
+     * @example
+     * // 查询云托管某服务某版本的错误响应
+     * const res = await monitor.describeCurveData({
+     *     MetricName: 'TkeHttpErrorService',
+     *     StartTime: '2026-03-13 00:00:00',
+     *     EndTime: '2026-03-16 23:59:59',
+     *     ResourceID: 'my-service',
+     *     SubresourceID: 'my-service-001'
+     * })
+     */
+    describeCurveData(params: IDescribeCurveDataParams): Promise<IDescribeCurveDataResponse>;
+}

package/types/monitor/types.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 监控指标名称
+ *
+ * 文档型数据库 / SQL型数据库 / 云函数 / 云托管 / 静态网站 / 身份认证 / API调用 / HTTP网关 / 大模型 / 知识库 / 用户登录 / 环境QPS / 数据库连接器 / 网关
+ */
+export type MetricName = 'DbRead' | 'DbWrite' | 'DbCostTime10ms' | 'DbCostTime50ms' | 'DbCostTime100ms' | 'DbSizepkg' | 'MysqlStorageUsage' | 'MysqlCCU' | 'MysqlCpuUsageRate' | 'MysqlDbConnections' | 'MysqlMemoryUse' | 'MysqlSlowQueries' | 'MysqlTps' | 'MysqlQps' | 'FunctionCU' | 'FunctionInvocation' | 'FunctionFlux' | 'FunctionThrottle' | 'FunctionConcurrentExecutions' | 'FunctionTimeout' | 'FunctionGBs' | 'FunctionError' | 'FunctionDuration' | 'FunctionConcurrencyMemoryMB' | 'FunctionMemOverFlow' | 'FunctionIdleProvisioned' | 'FunctionProvisionedConcurrency' | 'TkeRspTimeService' | 'TkeCpuUsedService' | 'TkeMemUsedService' | 'TkeQPSService' | 'TkePodNumService' | 'TkeHttpServiceNatPkg' | 'TkeCUUsedService' | 'TkeInvokeNumService' | 'TkeHttpErrorService' | 'StaticFsFluxPkg' | 'StaticFsSizePkg' | 'AuthInvocationNumPkg' | 'GwCloudDevelopmentSecureCallsInvocation' | 'GwWXInvocation' | 'GwCloudDevelopmentStandardCallsInvocation' | 'AIPromptTokenNumPkg' | 'AICompletionTokenNumPkg' | 'AITotalTokenNumPkg' | 'KnowledgeBaseCapacity' | 'DayActiveLoginAnonymousUser' | 'DayActiveLoginAllUser' | 'DayActiveLoginExternalUser' | 'DayActiveLoginInternalUser' | 'EnvQPSAll' | 'MongoConnectorRead' | 'MongoConnectorWrite' | 'MongoConnectorCostTime10ms' | 'MongoConnectorCostTime50ms' | 'MongoConnectorCostTime100ms' | 'MongoConnectorInvokeNum' | 'GatewayTraceEnvQPS' | 'GatewayShowAPIInvokeNum' | 'GatewayShowAPICostTotal' | 'GatewayShowAPIHTTP2XX' | 'GatewayShowAPIHTTPError' | 'GatewayTraceAccessSourceQPS' | 'GatewayShowHttpInvokeNum' | 'GatewayShowHttpCostTotal' | 'GatewayShowHttpHTTP2XX' | 'GatewayShowHttpHTTPError' | 'GatewayTraceResourceQPS' | (string & {});
+/** 统计周期（秒） */
+export type MetricPeriod = 300 | 3600 | 86400;
+/** DescribeCurveData 请求参数 */
+export interface IDescribeCurveDataParams {
+    /** 指标名称 */
+    MetricName: MetricName;
+    /** 开始时间，格式 'YYYY-MM-DD HH:mm:ss'，需早于结束时间至少5分钟 */
+    StartTime: string;
+    /** 结束时间，格式 'YYYY-MM-DD HH:mm:ss'，需晚于开始时间至少5分钟 */
+    EndTime: string;
+    /**
+     * 资源ID（可选）
+     * - 文档型数据库：集合名称
+     * - 云函数：函数名称
+     * - 云托管：服务名称（必传）
+     * - 数据库连接器：实例id（必传）
+     * - 网关-调用链路维度：小程序API传'wx'，云开发API传'http_openapi'（必传）
+     * - 网关-环境/资源维度：必传
+     * - 留空则查询整个 namespace 的指标
+     */
+    ResourceID?: string;
+    /** 微信AppId，微信场景必传 */
+    WxAppId?: string;
+    /** 子资源信息，查询云托管相关指标的具体版本的监控数据，需传入 */
+    SubresourceID?: string;
+    /** 网关路由 */
+    ThirdResource?: string;
+    /**
+     * 统计周期（秒），仅支持 300 / 3600 / 86400
+     * 不传则根据时间范围自动选择：
+     * - 1天内：300
+     * - 1天~15天：3600
+     * - 15天~180天：86400
+     *
+     * 传入时需遵循以下约束：
+     * - 时间范围 ≤ 1天：可取 300 或 3600
+     * - 时间范围 > 1天且 ≤ 3天：可取 300、3600 或 86400
+     * - 时间范围 > 3天：可取 3600 或 86400
+     */
+    Period?: MetricPeriod;
+}
+/** DescribeCurveData 响应结果 */
+export interface IDescribeCurveDataResponse {
+    /** 开始时间（会根据统计周期取整） */
+    StartTime: string;
+    /** 结束时间（会根据统计周期取整） */
+    EndTime: string;
+    /** 指标名 */
+    MetricName: string;
+    /** 统计周期（秒） */
+    Period: number;
+    /** 监控数据（整数），与 Time 一一对应 */
+    Values: number[];
+    /** 时间戳数组（Unix 时间戳，秒级），与 Values 一一对应 */
+    Time: number[];
+    /** 监控数据（浮点数），与 Time 一一对应 */
+    NewValues: number[];
+    /** 聚合方式：'last' | 'max' | 'avg' | 'sum' */
+    Statistics: string;
+    /** 请求ID */
+    RequestId: string;
+}