@cloudbase/manager-node 4.3.4 → 4.4.0

package/lib/function/index.js

@@ -83,6 +83,7 @@ class FunctionService {
         this.environment = environment;
         this.scfService = new utils_1.CloudService(environment.cloudBaseContext, 'scf', '2018-04-16');
         this.vpcService = new utils_1.CloudService(environment.cloudBaseContext, 'vpc', '2017-03-12');
+        this.tcbService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
     }
     /**
      * 增量更新函数代码
@@ -314,18 +315,19 @@ class FunctionService {
     }
     /**
      * 获取函数日志
+     * @deprecated 请使用 getFunctionLogsV2 代替
      * @param {{
-     *         name: string
-     *         offset: number
-     *         limit: number
-     *         order: string
-     *         orderBy: string
-     *         startTime: string
-     *         endTime: string
-     *         requestId: string
-     *     }} options
-     * @returns {Promise<IFunctionLogRes>}
-     */
+    *         name: string
+    *         offset: number
+    *         limit: number
+    *         order: string
+    *         orderBy: string
+    *         startTime: string
+    *         endTime: string
+    *         requestId: string
+    *     }} options
+    * @returns {Promise<IFunctionLogRes>}
+    */
     async getFunctionLogs(options) {
         let { name, offset = 0, limit = 10, order, orderBy, startTime, endTime, requestId } = options;
         const { namespace } = this.getFunctionConfig();
@@ -352,6 +354,63 @@ class FunctionService {
         return res;
     }
     /**
+ * 获取函数日志 ID 列表
+ * @param {{
+    *         name: string
+    *         offset: number
+    *         limit: number
+    *         startTime: string
+    *         endTime: string
+    *         requestId: string
+    *         qualifier: string
+    *     }} options
+    * @returns {Promise<IFunctionLogResV2>}
+    */
+    async getFunctionLogsV2(options) {
+        let { name, offset = 0, limit = 10, startTime, endTime, requestId, qualifier } = options;
+        const { env } = this.getFunctionConfig();
+        ({ startTime, endTime } = (0, utils_1.getCompleteTimeRange)({
+            startTime,
+            endTime
+        }));
+        const params = {
+            EnvId: env,
+            FunctionName: name,
+            Offset: offset,
+            Limit: limit,
+            StartTime: startTime,
+            EndTime: endTime,
+            LogRequestId: requestId,
+            Qualifier: qualifier || "$LATEST" // 云函数版本，不传则用 $LATEST
+        };
+        const res = await this.tcbService.request('GetFunctionLogs', params);
+        return res;
+    }
+    /**
+ * 根据函数日志 ID 查询日志详情
+ * @param {{
+    *         startTime: string
+    *         endTime: string
+    *         logRequestId: string
+    *     }} options
+    * @returns {Promise<IFunctionLogRes>}
+    */
+    async getFunctionLogDetail(options) {
+        let { logRequestId, startTime, endTime } = options;
+        ({ startTime, endTime } = (0, utils_1.getCompleteTimeRange)({
+            startTime,
+            endTime
+        }));
+        const params = {
+            StartTime: startTime,
+            LogRequestId: logRequestId,
+            EndTime: endTime
+        };
+        console.log("params", params);
+        const res = await this.tcbService.request('GetFunctionLogDetail', params);
+        return res;
+    }
+    /**
      * 更新云函数配置
      * @param {ICloudFunction} func 云函数配置
      * @returns {Promise<IResponseInfo>}
@@ -965,6 +1024,12 @@ __decorate([
 __decorate([
     (0, utils_1.preLazy)()
 ], FunctionService.prototype, "getFunctionLogs", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], FunctionService.prototype, "getFunctionLogsV2", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], FunctionService.prototype, "getFunctionLogDetail", null);
 __decorate([
     (0, utils_1.preLazy)()
 ], FunctionService.prototype, "updateFunctionConfig", null);

package/lib/utils/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatTimeByMs = exports.formatTimeValue = exports.guid6 = void 0;
+exports.getCompleteTimeRange = exports.formatTimeByMs = exports.formatTimeValue = exports.guid6 = void 0;
 exports.compressToZip = compressToZip;
 exports.downloadAndExtractRemoteZip = downloadAndExtractRemoteZip;
 exports.upload = upload;
@@ -238,3 +238,25 @@ const formatTimeByMs = (ms) => {
     return `${year}-${(0, exports.formatTimeValue)(month)}-${(0, exports.formatTimeValue)(date)} ${(0, exports.formatTimeValue)(hour)}:${(0, exports.formatTimeValue)(minute)}:${(0, exports.formatTimeValue)(second)}`;
 };
 exports.formatTimeByMs = formatTimeByMs;
+const getCompleteTimeRange = (timeRange) => {
+    let { startTime, endTime } = timeRange;
+    if (!startTime && !endTime) {
+        // 都不传则 startTime 为当前时间，endTime 为 startTime + 1d
+        const curTime = new Date().getTime();
+        startTime = (0, exports.formatTimeByMs)(curTime);
+        endTime = (0, exports.formatTimeByMs)(curTime + 24 * 3600 * 1000);
+    }
+    if (startTime && !endTime) {
+        // 自动补 endTime 为 startTime + 1d
+        endTime = (0, exports.formatTimeByMs)(new Date(startTime).getTime() + 24 * 3600 * 1000);
+    }
+    if (endTime && !startTime) {
+        // 自动补 startTime 为 endTime - 1d
+        startTime = (0, exports.formatTimeByMs)(new Date(endTime).getTime() - 24 * 3600 * 1000);
+    }
+    return {
+        startTime,
+        endTime
+    };
+};
+exports.getCompleteTimeRange = getCompleteTimeRange;

package/package.json

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

package/types/function/index.d.ts

@@ -1,5 +1,5 @@
 import { Environment } from '../environment';
-import { IResponseInfo, ICloudFunction, IFunctionLogOptions, ICloudFunctionTrigger, IFunctionInvokeRes, IFunctionLogRes, IFunctionDownloadUrlRes } from '../interfaces';
+import { IResponseInfo, ICloudFunction, IFunctionLogOptions, ICloudFunctionTrigger, IFunctionInvokeRes, IFunctionLogRes, IFunctionDownloadUrlRes, IFunctionLogDetailOptions, IFunctionLogDetailRes, IFunctionLogOptionsV2, IFunctionLogResV2 } from '../interfaces';
 import { IFunctionInfo } from './types';
 export interface IFunctionCode {
     func: ICloudFunction;
@@ -177,6 +177,7 @@ export declare class FunctionService {
     private environment;
     private vpcService;
     private scfService;
+    private tcbService;
     constructor(environment: Environment);
     /**
      * 增量更新函数代码
@@ -228,20 +229,45 @@ export declare class FunctionService {
     getFunctionDetail(name: string, codeSecret?: string): Promise<IFunctionInfo>;
     /**
      * 获取函数日志
+     * @deprecated 请使用 getFunctionLogsV2 代替
      * @param {{
-     *         name: string
-     *         offset: number
-     *         limit: number
-     *         order: string
-     *         orderBy: string
-     *         startTime: string
-     *         endTime: string
-     *         requestId: string
-     *     }} options
-     * @returns {Promise<IFunctionLogRes>}
-     */
+    *         name: string
+    *         offset: number
+    *         limit: number
+    *         order: string
+    *         orderBy: string
+    *         startTime: string
+    *         endTime: string
+    *         requestId: string
+    *     }} options
+    * @returns {Promise<IFunctionLogRes>}
+    */
     getFunctionLogs(options: IFunctionLogOptions): Promise<IFunctionLogRes>;
     /**
+ * 获取函数日志 ID 列表
+ * @param {{
+    *         name: string
+    *         offset: number
+    *         limit: number
+    *         startTime: string
+    *         endTime: string
+    *         requestId: string
+    *         qualifier: string
+    *     }} options
+    * @returns {Promise<IFunctionLogResV2>}
+    */
+    getFunctionLogsV2(options: IFunctionLogOptionsV2): Promise<IFunctionLogResV2>;
+    /**
+ * 根据函数日志 ID 查询日志详情
+ * @param {{
+    *         startTime: string
+    *         endTime: string
+    *         logRequestId: string
+    *     }} options
+    * @returns {Promise<IFunctionLogRes>}
+    */
+    getFunctionLogDetail(options: IFunctionLogDetailOptions): Promise<IFunctionLogDetailRes>;
+    /**
      * 更新云函数配置
      * @param {ICloudFunction} func 云函数配置
      * @returns {Promise<IResponseInfo>}

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

@@ -43,6 +43,20 @@ export interface IFunctionLogOptions {
     endTime?: string;
     requestId?: string;
 }
+export interface IFunctionLogOptionsV2 {
+    name: string;
+    offset?: number;
+    limit?: number;
+    startTime?: string;
+    endTime?: string;
+    requestId?: string;
+    qualifier?: string;
+}
+export interface IFunctionLogDetailOptions {
+    endTime?: string;
+    logRequestId: string;
+    startTime?: string;
+}
 export interface IFunctionInvokeRes {
     RequestId: string;
     Log: string;
@@ -58,6 +72,25 @@ export interface IFunctionLogRes {
     Data: [];
     TotalCount: number;
 }
+export interface IFunctionLogResV2 {
+    RequestId: string;
+    LogList: {
+        RequestId: string;
+        RetCode: number;
+        RetryNum: number;
+        StartTime: string;
+    }[];
+}
+export interface IFunctionLogDetailRes {
+    Context: string;
+    Duration: number;
+    ListOver: boolean;
+    LogJson: string;
+    MemUsage: number;
+    RequestId: string;
+    RetMsg: string;
+    StartTime: string;
+}
 export interface IFunctionDownloadUrlRes {
     Url: string;
     RequestId: string;

package/types/utils/index.d.ts

@@ -57,3 +57,10 @@ export declare function upperCaseObjKey(object: any): any;
 export declare function fetchTemplates(types: ('scfFunc' | 'tcbrFunc' | 'tcbrContainer')[]): Promise<ITemplate[]>;
 export declare const formatTimeValue: (num: any) => string;
 export declare const formatTimeByMs: (ms: number) => string;
+export declare const getCompleteTimeRange: (timeRange: {
+    startTime?: string;
+    endTime?: string;
+}) => {
+    startTime: string;
+    endTime: string;
+};