tencentcloud-sdk-nodejs 4.0.789 → 4.0.790

package/examples/cls/v20201016/cls.proto

@@ -0,0 +1,34 @@
+syntax = "proto2";
+
+package cls;
+
+message Log
+{
+    message Content
+    {
+        required string key   = 1; // 每组字段的 key
+        required string value = 2; // 每组字段的 value
+    }
+    required int64   time     = 1; // 时间戳，UNIX时间格式
+    repeated Content contents = 2; // 一条日志里的多个kv组合
+}
+
+message LogTag
+{
+    required string key       = 1;
+    required string value     = 2;
+}
+
+message LogGroup
+{
+    repeated Log    logs        = 1; // 多条日志合成的日志数组
+    optional string contextFlow = 2; // 目前暂无效用
+    optional string filename    = 3; // 日志文件名
+    optional string source      = 4; // 日志来源，一般使用机器IP
+    repeated LogTag logTags     = 5;
+}
+
+message LogGroupList
+{
+    repeated LogGroup logGroupList = 1; // 日志组列表
+}

package/examples/cls/v20201016/upload_log.js

@@ -0,0 +1,69 @@
+const { CommonClient } = require("../../../tencentcloud/common/common_client")
+const protobuf = require("protobufjs")
+const lz4 = require("lz4")
+const path = require("path")
+
+// 实例化要请求产品的client对象。profile可选。
+const clientConfig = {
+  credential: {
+    secretId: process.env.secretId,
+    secretKey: process.env.secretKey,
+  },
+  region: "ap-guangzhou",
+  profile: {
+    httpProfile: {
+      endpoint: "cls.tencentcloudapi.com",
+      headers: {
+        "X-CLS-TopicId": "", // 替换为自己业务的 topic
+        "X-CLS-HashKey": "", // 可选参数，具体参考官方文档：https://cloud.tencent.com/document/product/614/59470
+        "X-CLS-CompressType": "lz4", // lz4压缩方式, 空字符串意味不压缩
+      },
+    },
+  },
+}
+
+// 实例化要请求产品的client对象,clientProfile是可选的
+const client = new CommonClient("cls.tencentcloudapi.com", "2020-10-16", clientConfig)
+// lz4 压缩数据
+const params = compress(getBodyInfo())
+client.requestOctetStream("UploadLog", params).then(
+  (data) => {
+    console.log(data)
+  },
+  (err) => {
+    console.error("error", err)
+  }
+)
+
+function compress(input) {
+  const output = Buffer.alloc(lz4.encodeBound(input.length))
+  const compressedBlockSize = lz4.encodeBlock(input, output)
+  return output.slice(0, compressedBlockSize)
+}
+
+function getBodyInfo() {
+  const root = protobuf.loadSync(path.join(__dirname, "cls.proto"))
+  const LogGroupList = root.lookupType("cls.LogGroupList")
+  const payload = {
+    logGroupList: [
+      {
+        logs: [
+          {
+            time: Date.now(),
+            contents: [
+              {
+                key: "name",
+                value: "张三",
+              },
+              {
+                key: "age",
+                value: "18",
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  }
+  return LogGroupList.encode(payload).finish()
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs",
-  "version": "4.0.789",
+  "version": "4.0.790",
   "description": "腾讯云 API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

package/products.md

@@ -40,7 +40,7 @@
 | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-12-29 01:09:11 |
 | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-12-27 01:08:57 |
 | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-01-25 15:34:29 |
-| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-01-24 01:22:49 |
+| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-01-30 01:08:20 |
 | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2024-01-15 01:08:17 |
 | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2024-01-17 01:09:06 |
 | cds | [T-Sec-数据安全审计（DSA）](https://cloud.tencent.com/document/product/856) | 2024-01-24 01:23:26 |
@@ -94,10 +94,10 @@
 | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-12-20 01:36:00 |
 | eiam | [数字身份管控平台（员工版）](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
 | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
-| emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-01-29 01:13:24 |
+| emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-01-30 01:14:22 |
 | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-01-25 01:13:20 |
-| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-01-26 01:13:26 |
-| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-01-26 01:13:42 |
+| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-01-30 01:14:38 |
+| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2024-01-30 01:14:52 |
 | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-12-15 19:41:44 |
 | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-01-12 01:15:37 |
 | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-12-25 00:11:01 |
@@ -125,7 +125,7 @@
 | iotcloud | [物联网通信](https://cloud.tencent.com/document/product/634) | 2023-11-06 00:11:14 |
 | iotexplorer | [物联网开发平台](https://cloud.tencent.com/document/product/1081) | 2023-10-16 01:17:51 |
 | iottid | [物联网设备身份认证](https://cloud.tencent.com/document/product/1086) | 2023-05-18 01:33:02 |
-| iotvideo | [物联网智能视频服务](https://cloud.tencent.com/document/product/1131) | 2024-01-23 01:20:20 |
+| iotvideo | [物联网智能视频服务](https://cloud.tencent.com/document/product/1131) | 2024-01-30 01:16:52 |
 | iotvideoindustry | [物联网智能视频服务（行业版）](https://cloud.tencent.com/document/product/1361) | 2023-08-17 03:44:44 |
 | irp | [智能推荐平台](https://cloud.tencent.com/document/product/1541) | 2023-09-22 02:00:51 |
 | iss | [智能视图计算平台](https://cloud.tencent.com/document/product/1344) | 2024-01-26 01:15:52 |
@@ -143,7 +143,7 @@
 | memcached | [云数据库Memcached](https://cloud.tencent.com/document/product/241) | 2023-10-20 01:19:21 |
 | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-07-08 06:11:32 |
 | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2023-05-18 01:39:20 |
-| mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-12-01 01:19:47 |
+| mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2024-01-30 01:18:35 |
 | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2024-01-29 01:17:07 |
 | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2024-01-29 01:17:14 |
 | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2024-01-26 01:17:35 |
@@ -167,7 +167,7 @@
 | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2023-10-13 01:22:28 |
 | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-12-25 00:16:39 |
 | rp | [注册保护](https://cloud.tencent.com/document/product/1191) | 2022-04-04 07:04:06 |
-| rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2024-01-23 01:26:09 |
+| rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2024-01-30 01:20:45 |
 | scf | [云函数](https://cloud.tencent.com/document/product/583) | 2024-01-24 01:34:14 |
 | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2023-12-25 00:16:59 |
 | smh | [智能媒资托管](https://cloud.tencent.com/document/product/1339) | 2023-07-11 01:37:49 |
@@ -178,7 +178,7 @@
 | solar | [智汇零售](https://cloud.tencent.com/document/product) | 2020-03-19 08:01:59 |
 | sqlserver | [云数据库 SQL Server](https://cloud.tencent.com/document/product/238) | 2024-01-17 01:21:16 |
 | ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2023-11-15 02:18:28 |
-| ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-01-29 01:19:48 |
+| ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-01-30 01:21:39 |
 | sslpod | [证书监控 SSLPod](https://cloud.tencent.com/document/product/1084) | 2023-08-17 04:46:28 |
 | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2023-12-28 01:23:11 |
 | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2024-01-17 01:21:44 |
@@ -205,7 +205,7 @@
 | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-01-12 01:24:10 |
 | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-11-15 02:26:59 |
 | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-12-20 02:13:36 |
-| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-01-27 19:39:47 |
+| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-01-30 01:24:01 |
 | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-11-27 00:20:12 |
 | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
 | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
@@ -218,7 +218,7 @@
 | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2024-01-22 11:36:09 |
 | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
 | tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2024-01-12 01:25:58 |
-| tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2024-01-25 01:24:16 |
+| tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2024-01-30 01:25:25 |
 | tourism | [文旅客情大数据](https://cloud.tencent.com/document/product/1684) | 2023-08-10 01:43:37 |
 | trdp | [流量风险决策平台](https://cloud.tencent.com/document/product/1604) | 2023-05-18 02:01:19 |
 | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-01-23 01:30:19 |
@@ -233,11 +233,11 @@
 | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-12-22 01:27:31 |
 | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
 | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2024-01-25 01:25:21 |
-| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-01-26 01:24:53 |
+| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-01-30 01:27:12 |
 | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-11-27 00:23:42 |
 | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-01-26 01:25:28 |
 | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-11-15 02:42:49 |
-| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-01-26 10:56:08 |
+| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-01-30 01:28:12 |
 | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2024-01-17 01:27:53 |
 | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
 | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2023-12-26 02:06:57 |

package/src/common/abstract_client.ts

@@ -142,6 +142,38 @@ export class AbstractClient {
     }
   }
 
+  /**
+   * @inner
+   */
+  async requestOctetStream(
+    action: string,
+    req: any,
+    options?: ResponseCallback | RequestOptions,
+    cb?: ResponseCallback
+  ) {
+    if (typeof options === "function") {
+      cb = options
+      options = {} as RequestOptions
+    }
+
+    try {
+      const result = await this.doRequest(
+        action,
+        req ?? {},
+        Object.assign({}, options, {
+          headers: {
+            "Content-Type": "application/octet-stream; charset=utf-8",
+          },
+        })
+      )
+      cb && cb(null, result)
+      return result
+    } catch (e) {
+      cb && cb(e as any, null)
+      throw e
+    }
+  }
+
   /**
    * @inner
    */

package/src/common/http/http_connection.ts

@@ -142,8 +142,10 @@ export class HttpConnection {
       config.headers["Content-Type"] = "application/x-www-form-urlencoded"
     }
     if (method === "POST" && !multipart) {
-      config.body = JSONbigNative.stringify(data)
-      config.headers["Content-Type"] = "application/json"
+      config.body = data
+      const contentType = config.headers["Content-Type"] || "application/json"
+      if (!isBuffer(data)) config.body = JSONbigNative.stringify(data)
+      config.headers["Content-Type"] = contentType
     }
     if (method === "POST" && multipart) {
       form = new FormData()
@@ -164,6 +166,7 @@ export class HttpConnection {
       secretKey,
       multipart,
       boundary: form ? form.getBoundary() : undefined,
+      headers: config.headers,
     })
 
     config.headers["Authorization"] = signature

package/src/common/sdk_version.ts

@@ -1 +1 @@
-export const sdkVersion = "4.0.789"
+export const sdkVersion = "4.0.790"

package/src/common/sign.ts

@@ -36,6 +36,7 @@ export default class Sign {
     secretKey,
     multipart,
     boundary,
+    headers: configHeaders = {},
   }: {
     method?: string
     url?: string
@@ -46,21 +47,23 @@ export default class Sign {
     secretKey: string
     multipart: boolean
     boundary: string
+    headers: Record<string, string>
   }): string {
     const urlObj = new URL(url)
+    const contentType = configHeaders["Content-Type"]
 
     // 通用头部
     let headers = ""
     let signedHeaders = ""
     if (method === "GET") {
       signedHeaders = "content-type"
-      headers = "content-type:application/x-www-form-urlencoded\n"
+      headers = `content-type:${contentType}\n`
     } else if (method === "POST") {
       signedHeaders = "content-type"
       if (multipart) {
         headers = `content-type:multipart/form-data; boundary=${boundary}\n`
       } else {
-        headers = "content-type:application/json\n"
+        headers = `content-type:${contentType}\n`
       }
     }
     headers += `host:${urlObj.hostname}\n`
@@ -90,7 +93,8 @@ export default class Sign {
       hash.update(`--\r\n`)
       payload_hash = hash.digest("hex")
     } else {
-      payload_hash = payload ? getHash(JSONbigNative.stringify(payload)) : getHash("")
+      const hashMessage = Buffer.isBuffer(payload) ? payload : JSONbigNative.stringify(payload)
+      payload_hash = payload ? getHash(hashMessage) : getHash("")
     }
 
     const canonicalRequest =
@@ -130,7 +134,7 @@ function sha256(message: string, secret = "", encoding?: string): string {
   return hmac.update(message).digest(encoding as any)
 }
 
-function getHash(message: string, encoding = "hex"): string {
+function getHash(message: crypto.BinaryLike, encoding = "hex"): string {
   const hash = crypto.createHash("sha256")
   return hash.update(message).digest(encoding as any)
 }

package/src/services/cdb/v20170320/cdb_client.ts

@@ -108,6 +108,7 @@ import {
   ReleaseResult,
   CreateAuditLogFileRequest,
   AuditRule,
+  DescribeInstanceAlarmEventsRequest,
   DescribeBinlogsRequest,
   DescribeCdbProxyInfoRequest,
   RollbackDBName,
@@ -336,6 +337,7 @@ import {
   DescribeCdbProxyInfoResponse,
   ModifyAuditConfigRequest,
   DeviceDiskInfo,
+  DescribeInstanceAlarmEventsResponse,
   DescribeRoMinScaleResponse,
   RoWeightValue,
   DescribeSlowLogDataResponse,
@@ -1460,6 +1462,16 @@ export class Client extends AbstractClient {
     return this.request("CloseCDBProxy", req, cb)
   }
 
+  /**
+   * 修改置放群组的名称或者描述
+   */
+  async ModifyNameOrDescByDpId(
+    req: ModifyNameOrDescByDpIdRequest,
+    cb?: (error: string, rep: ModifyNameOrDescByDpIdResponse) => void
+  ): Promise<ModifyNameOrDescByDpIdResponse> {
+    return this.request("ModifyNameOrDescByDpId", req, cb)
+  }
+
   /**
    * 本接口(ModifyAccountMaxUserConnections)用于修改云数据库账户最大可用连接数。
    */
@@ -2023,13 +2035,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 修改置放群组的名称或者描述
+   * 查询实例发生的事件信息
    */
-  async ModifyNameOrDescByDpId(
-    req: ModifyNameOrDescByDpIdRequest,
-    cb?: (error: string, rep: ModifyNameOrDescByDpIdResponse) => void
-  ): Promise<ModifyNameOrDescByDpIdResponse> {
-    return this.request("ModifyNameOrDescByDpId", req, cb)
+  async DescribeInstanceAlarmEvents(
+    req?: DescribeInstanceAlarmEventsRequest,
+    cb?: (error: string, rep: DescribeInstanceAlarmEventsResponse) => void
+  ): Promise<DescribeInstanceAlarmEventsResponse> {
+    return this.request("DescribeInstanceAlarmEvents", req, cb)
   }
 
   /**

package/src/services/cdb/v20170320/cdb_models.ts

@@ -2307,6 +2307,11 @@ export interface AuditRule {
   AuditAll: boolean
 }
 
+/**
+ * DescribeInstanceAlarmEvents请求参数结构体
+ */
+export type DescribeInstanceAlarmEventsRequest = null
+
 /**
  * DescribeBinlogs请求参数结构体
  */
@@ -7664,6 +7669,16 @@ export interface DeviceDiskInfo {
   CapacityRatio: Array<number | bigint>
 }
 
+/**
+ * DescribeInstanceAlarmEvents返回参数结构体
+ */
+export interface DescribeInstanceAlarmEventsResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeRoMinScale返回参数结构体
  */

package/src/services/emr/v20190103/emr_models.ts

@@ -122,27 +122,27 @@ export interface ScaleOutInstanceResponse {
   /**
    * 实例ID。
    */
-  InstanceId: string
+  InstanceId?: string
   /**
    * 订单号。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  DealNames: Array<string>
+  DealNames?: Array<string>
   /**
    * 客户端Token。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ClientToken: string
+  ClientToken?: string
   /**
    * 扩容流程ID。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  FlowId: number
+  FlowId?: number
   /**
    * 大订单号。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  BillId: string
+  BillId?: string
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1126,7 +1126,7 @@ export interface ScaleOutInstanceRequest {
    */
   PayMode: number
   /**
-   * 客户端Token。
+   * 唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-751a-41b6-aad6-fae36063280
    */
   ClientToken?: string
   /**
@@ -3952,7 +3952,7 @@ export interface CreateInstanceRequest {
    */
   AutoRenew?: number
   /**
-   * 客户端Token。
+   * 唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-751a-41b6-aad6-fae36063280
    */
   ClientToken?: string
   /**

package/src/services/ess/v20201111/ess_client.ts

@@ -310,9 +310,16 @@ export class Client extends AbstractClient {
   /**
      * 用于撤销合同流程<br/>
 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
+- **可撤回合同状态**：未全部签署完成
+- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
 注:
-`如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+
+2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
+![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
+
+3. <font color='red'>撤销合同会返还合同额度</font>
      */
   async CancelFlow(
     req: CancelFlowRequest,
@@ -484,9 +491,20 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 注：此接口将会废弃，请使用撤销单个签署流程（CancelFlow）接口。
-指定需要批量撤回的签署流程Id，获取批量撤销链接。
-客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
+     * 指定需要批量撤回的签署流程Id，以获取批量撤销链接。
+客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。
+接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。
+
+- **可撤回合同状态**：未全部签署完成
+- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
+注：
+1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+
+2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
+![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
+
+3. <font color='red'>撤销合同会返还合同额度</font>
      */
   async CreateBatchCancelFlowUrl(
     req: CreateBatchCancelFlowUrlRequest,

package/src/services/ess/v20201111/ess_models.ts

@@ -1964,7 +1964,10 @@ export interface CreateSchemeUrlRequest {
   /**
    * 签署完成后是否自动回跳
 <ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
-注:  ` 该参数只针对"APP" 类型的签署链接有效`
+
+注: 
+1. 该参数<font color="red">只针对APP</font> 类型的签署链接有效
+2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
    */
   AutoJumpBack?: boolean
   /**
@@ -3639,20 +3642,24 @@ style String 为字体风格设置 风格支持： font : 目前支持 黑体、
 export interface FormField {
   /**
    * 控件填充vaule，ComponentType和传入值类型对应关系：
-TEXT - 文本内容
-MULTI_LINE_TEXT - 文本内容
-CHECK_BOX - true/false
-FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
-SELECTOR - 选项值
-DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
+TEXT ：  文本内容
+MULTI_LINE_TEXT ：文本内容
+CHECK_BOX ：true/false
+FILL_IMAGE、ATTACHMENT ： 附件的FileId，需要通过UploadFiles接口上传获取
+SELECTOR ： 选项值
+DYNAMIC_TABLE ：传入json格式的表格内容，具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)
    */
   ComponentValue: string
   /**
    * 控件id，和ComponentName选择一项传入即可
+
+<a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件ID的方式</a>
    */
   ComponentId?: string
   /**
    * 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
+
+<a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件名字的方式</a>
    */
   ComponentName?: string
 }
@@ -6225,11 +6232,13 @@ export interface CancelFlowRequest {
   /**
    * 合同流程ID, 为32位字符串。
 
-可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+可登录腾讯电子签控制台，[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
    */
   FlowId: string
   /**
-   * 撤销此合同流程的原因，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
+   * 撤销此合同流程的**撤销理由**，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
+
+![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
    */
   CancelMessage: string
   /**
@@ -7235,7 +7244,7 @@ export interface CreateBatchCancelFlowUrlRequest {
   Operator: UserInfo
   /**
    * 需要执行撤回的流程(合同)的编号列表，最多100个.
-<br>列表中的流程(合同)编号不要重复.
+列表中的流程(合同)编号不要重复.
    */
   FlowIds: Array<string>
   /**

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -574,7 +574,7 @@ export class Client extends AbstractClient {
 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
 注:
-- 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+- 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
 - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
      */
   async ChannelCancelFlow(
@@ -680,13 +680,15 @@ export class Client extends AbstractClient {
 </table>
 
 **注**: 
-`1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+1. 发起合同时候,  作为<font color="red">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名
 
-`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
+2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
 
-`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）`
+3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
 
-`4. 静默（自动）签署不支持合同签署方存在填写功能`
+4. <font color="red">静默（自动）签署不支持合同签署方存在填写</font>
+
+5.  <font color="red">在下一步创建签署链接前，建议等待DocumentFill </font>[PDF合成完成的回调](https://qian.tencent.com/developers/partner/callback_types_file_resources)或者睡眠几秒，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
      */
   async CreateFlowsByTemplates(
     req: CreateFlowsByTemplatesRequest,
@@ -958,7 +960,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同,   返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开,  跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
+     * 通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同,   返回的链接需要有此权限的人<font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开,  跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
 
 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
 
@@ -1185,7 +1187,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
 注:
-- 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+- 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
 - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
      */
   async ChannelBatchCancelFlows(
@@ -1529,9 +1531,9 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   /**
      * 此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。 
 
-- **新增员工的场景**:    提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
+- **新增员工的场景**:    通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
 
-- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
+- **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
 
 ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
 

package/src/services/essbasic/v20210526/essbasic_models.ts

@@ -1711,11 +1711,15 @@ export interface FormField {
   /**
    * 表单域或控件的ID，跟ComponentName二选一，不能全为空；
 CreateFlowsByTemplates 接口不使用此字段。
+
+<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ComponentId?: string
   /**
    * 控件的名字，跟ComponentId二选一，不能全为空
+
+<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ComponentName?: string