[feature][scf新增api] (#264)

toolkit组件新增GetRequestStatus API

Author: ciryu

__tests__/scf/base.test.ts

@@ -519,6 +519,27 @@ describe('Scf', () => {
     expect(outputs.Triggers).toEqual([]);
   });
 
+  test('get request status', async () => {
+    const invokeRes = await scf.invoke({
+      namespace: inputs.namespace,
+      functionName: inputs.name,
+    });
+
+    console.log(invokeRes);
+
+    const inputParams = {
+      functionName: inputs.name,
+      functionRequestId: invokeRes.Result.FunctionRequestId,
+      namespace: inputs.namespace,
+      // startTime: "2022-01-06 20:00:00",
+      // endTime: "2022-12-16 20:00:00"
+    };
+
+    const res = await scf.scf.getRequestStatus(inputParams);
+    console.log(res);
+    expect(res.TotalCount).toEqual(1);
+  });
+
   test('remove', async () => {
     const res = await scf.remove({
       functionName: inputs.name,

src/modules/scf/apis.ts

@@ -26,6 +26,7 @@ const ACTIONS = [
   'DeleteProvisionedConcurrencyConfig',
   'GetReservedConcurrencyConfig',
   'GetProvisionedConcurrencyConfig',
+  'GetRequestStatus'
 ] as const;
 
 export type ActionType = typeof ACTIONS[number];

src/modules/scf/entities/scf.ts

@@ -1,19 +1,20 @@
-import { Capi } from '@tencent-sdk/capi';
-import { sleep, waitResponse } from '@ygkit/request';
+import {Capi} from '@tencent-sdk/capi';
+import {sleep, waitResponse} from '@ygkit/request';
 import dayjs from 'dayjs';
-import { ApiTypeError, ApiError } from '../../../utils/error';
-import { formatDate } from '../../../utils/dayjs';
+import {ApiError, ApiTypeError} from '../../../utils/error';
+import {formatDate} from '../../../utils/dayjs';
 import CONFIGS from '../config';
 import Cls from '../../cls';
-import { formatInputs } from '../utils';
+import {formatInputs} from '../utils';
 
 import BaseEntity from './base';
 
 import {
-  ScfCreateFunctionInputs,
-  FunctionInfo,
   FaasBaseConfig,
+  FunctionInfo,
   GetLogOptions,
+  GetRequestStatusOptions,
+  ScfCreateFunctionInputs,
   UpdateFunctionCodeOptions,
 } from '../interface';
 
@@ -442,4 +443,35 @@ export default class ScfEntity extends BaseEntity {
       return undefined;
     }
   }
+
+  // 获取函数单个请求运行状态
+  async getRequestStatus(inputs: GetRequestStatusOptions) {
+    const reqParams: {
+      Namespace?: string;
+      FunctionName?: string;
+      FunctionRequestId?: string;
+      StartTime?: string;
+      EndTime?: string;
+    } = {
+      Namespace: inputs.namespace || 'default',
+      FunctionName: inputs.functionName,
+      FunctionRequestId: inputs.functionRequestId,
+    };
+
+    if (inputs.startTime) {
+      reqParams.StartTime = inputs.startTime
+    }
+
+    if (inputs.endTime) {
+      reqParams.EndTime = inputs.endTime
+    }
+
+    const reqInputs: Partial<typeof reqParams> = reqParams;
+
+    try {
+      return await this.request({Action: 'GetRequestStatus', ...reqInputs});
+    } catch (e) {
+      console.log(e);
+    }
+  }
 }

src/modules/scf/interface.ts

@@ -367,3 +367,43 @@ export interface UpdateFunctionCodeOptions {
   // image 方式
   Code?: FunctionCode;
 }
+
+export interface GetRequestStatusOptions {
+  // 函数名称
+  functionName: string;
+  // 请求 ID
+  functionRequestId: string;
+  // 命名空间
+  namespace?: string;
+  // 开始时间
+  startTime?: string;
+  // 结束时间
+  endTime?: string;
+}
+
+export interface GetRequestStatusOptions {
+  /**
+   * 函数名称
+   */
+  functionName: string
+
+  /**
+   * 需要查询状态的请求 id
+   */
+  functionRequestId: string
+
+  /**
+   * 函数的所在的命名空间
+   */
+  namespace?: string
+
+  /**
+   * 查询的开始时间，例如：2017-05-16 20:00:00，不填默认为当前时间 - 15min
+   */
+  startTime?: string
+
+  /**
+   * 查询的结束时间，例如：2017-05-16 20:59:59，不填默认为当前时间。EndTime 需要晚于 StartTime。
+   */
+  endTime?: string
+}