tencentcloud-sdk-nodejs 4.0.463 → 4.0.465

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

@@ -787,6 +787,7 @@ CHECK_BOX - true/false
 FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
 SELECTOR - 选项值
 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
+SIGN_SEAL - 印章Id，于控制台查询获取
       */
   ComponentValue?: string
 
@@ -899,7 +900,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
   IsFullText?: boolean
 
   /**
-   * 签署前置条件：阅读时长限制，默认为不需要
+   * 签署前置条件：阅读时长限制，单位秒，默认为不需要
    */
   PreReadTime?: number
 
@@ -1824,32 +1825,20 @@ export interface SuccessDeleteStaffData {
  * CreateMultiFlowSignQRCode请求参数结构体
  */
 export interface CreateMultiFlowSignQRCodeRequest {
-  /**
-   * 模板ID
-   */
-  TemplateId: string
-
-  /**
-   * 签署流程名称，最大长度不超过200字符
-   */
-  FlowName: string
-
   /**
    * 用户信息
    */
   Operator: UserInfo
 
   /**
-   * 应用信息
+   * 模板ID
    */
-  Agent?: Agent
+  TemplateId: string
 
   /**
-      * 回调地址,最大长度1000字符串
-回调时机：
-用户通过签署二维码发起签署流程时，企业额度不足导致失败
-      */
-  CallbackUrl?: string
+   * 签署流程名称，最大长度不超过200字符
+   */
+  FlowName: string
 
   /**
       * 最大可发起签署流程份数，默认5份 
@@ -1870,6 +1859,23 @@ export interface CreateMultiFlowSignQRCodeRequest {
   /**
    * 限制二维码用户条件
    */
+  Restrictions?: Array<ApproverRestriction>
+
+  /**
+      * 回调地址,最大长度1000字符串
+回调时机：
+用户通过签署二维码发起签署流程时，企业额度不足导致失败
+      */
+  CallbackUrl?: string
+
+  /**
+   * 应用信息
+   */
+  Agent?: Agent
+
+  /**
+   * 限制二维码用户条件（已弃用）
+   */
   ApproverRestrictions?: ApproverRestriction
 }
 

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

@@ -145,7 +145,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
+   * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，请联系运营/客服咨询相关流程
    */
   async CreateSealByImage(
     req: CreateSealByImageRequest,
@@ -187,7 +187,7 @@ export class Client extends AbstractClient {
 
   /**
      * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
-
+合同发起人必须在电子签已经进行实名。
      */
   async CreateFlowsByTemplates(
     req: CreateFlowsByTemplatesRequest,
@@ -197,8 +197,24 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
-   */
+     * 创建跳转小程序查看或签署的链接。
+
+跳转小程序的几种方式：主要是设置不同的EndPoint
+1. 通过链接Url直接跳转到小程序，不需要返回
+设置EndPoint为WEIXINAPP，得到链接打开即可。（与短信提醒用户签署形式一样）。
+2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
+设置EndPoint为CHANNEL，指定JumpUrl，得到链接打开即可。
+3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
+跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
+全屏方式：
+（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
+半屏方式：
+（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
+其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+使用CreateSignUrls，设置EndPoint为APP，得到path。
+4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
+实现方式同App跳小程序。
+     */
   async CreateSignUrls(
     req: CreateSignUrlsRequest,
     cb?: (error: string, rep: CreateSignUrlsResponse) => void
@@ -211,7 +227,7 @@ export class Client extends AbstractClient {
 若子客企业未激活，会进入企业激活流程,首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）
 若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。
 若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
-
+返回的Url仅支持PC端操作。
      */
   async CreateConsoleLoginUrl(
     req: CreateConsoleLoginUrlRequest,
@@ -313,7 +329,7 @@ export class Client extends AbstractClient {
   /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-目前该接口只支持B2C，不建议使用。
+目前该接口只支持B2C，不建议使用，将会废弃。
      */
   async PrepareFlows(
     req: PrepareFlowsRequest,
@@ -323,8 +339,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
-   */
+     * 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。
+此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
+     */
   async DescribeResourceUrlsByFlows(
     req: DescribeResourceUrlsByFlowsRequest,
     cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void

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

@@ -114,7 +114,17 @@ export interface PdfVerifyResult {
 }
 
 /**
- * 创建签署流程签署人入参
+ * 创建签署流程签署人入参。
+
+其中签署方FlowApproverInfo需要传递的参数
+非单C、单B、B2C合同，ApproverType、RecipientId（模版发起合同时）必传，建议都传。其他身份标识
+1-个人：Name、Mobile必传
+2-渠道子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；
+3-渠道合作企业不指定经办人：（暂不支持）
+4-非渠道合作企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。
+
+RecipientId参数：
+从DescribeTemplates接口中，可以得到模版下的签署方Recipient列表，根据模版自定义的Rolename在此结构体中确定其RecipientId
  */
 export interface FlowApproverInfo {
   /**
@@ -628,7 +638,7 @@ export interface CreateSignUrlsRequest {
 
   /**
       * 签署链接生成类型，默认是 "ALL"；
-"ALL"：全部签署方签署链接；
+"ALL"：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接；
 "CHANNEL"：渠道合作企业；
 "NOT_CHANNEL"：非渠道合作企业；
 "PERSON"：个人；
@@ -713,6 +723,11 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
    */
   QrEffectiveDay?: number
 
+  /**
+   * 限制二维码用户条件
+   */
+  Restrictions?: Array<ApproverRestriction>
+
   /**
       * 回调地址，最大长度1000个字符
 不传默认使用渠道应用号配置的回调地址
@@ -721,14 +736,14 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
   CallbackUrl?: string
 
   /**
-   * 限制二维码用户条件
+   * 用户信息
    */
-  ApproverRestrictions?: ApproverRestriction
+  Operator?: UserInfo
 
   /**
-   * 用户信息
+   * 限制二维码用户条件（已弃用）
    */
-  Operator?: UserInfo
+  ApproverRestrictions?: ApproverRestriction
 }
 
 /**
@@ -919,13 +934,13 @@ export interface ChannelVerifyPdfResponse {
  */
 export interface SignUrlInfo {
   /**
-      * 签署链接
+      * 签署链接，过期时间为30天
 注意：此字段可能返回 null，表示取不到有效值。
       */
   SignUrl: string
 
   /**
-      * 链接失效时间,默认30分钟
+      * 合同过期时间
 注意：此字段可能返回 null，表示取不到有效值。
       */
   Deadline: number
@@ -1002,6 +1017,12 @@ PERSON 自然人
 /**
  * 此结构体 (Component) 用于描述控件属性。
 
+在通过文件发起合同时，对应的component有三种定位方式
+1. 绝对定位方式
+2. 表单域(FIELD)定位方式
+3. 关键字(KEYWORD)定位方式
+可以参考官网说明
+https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
  */
 export interface Component {
   /**
@@ -1096,7 +1117,10 @@ KEYWORD - 关键字
   /**
       * 参数控件样式，json格式表述
 不同类型的控件会有部分非通用参数
-TEXT控件可以指定字体
+TEXT/MULTI_LINE_TEXT控件可以指定
+1 Font：目前只支持黑体、宋体
+2 FontSize： 范围12-72
+3 FontAlign： Left/Right/Center，左对齐/居中/右对齐
 例如：{"FontSize":12}
       */
   ComponentExtra?: string
@@ -1619,12 +1643,14 @@ export interface SyncProxyOrganizationOperatorsRequest {
  */
 export interface CreateConsoleLoginUrlResponse {
   /**
-   * 子客Web控制台url，此链接5分钟内有效，且只能访问一次
-   */
+      * 子客Web控制台url，此链接5分钟内有效，且只能访问一次。同时需要注意：
+1. 此链接仅单次有效，使用后需要再次创建新的链接（部分聊天软件，如企业微信默认会对链接进行解析，此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接）；
+2. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
+      */
   ConsoleUrl: string
 
   /**
-   * 渠道子客企业是否已开通腾讯电子签。
+   * 渠道子客企业是否已开通腾讯电子签
    */
   IsActivated: boolean
 
@@ -1649,7 +1675,7 @@ export interface CreateFlowsByTemplatesRequest {
   FlowInfos: Array<FlowInfo>
 
   /**
-      * 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，则返回PreviewUrls；
+      * 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls（此Url返回的是PDF文件流 ）；
 预览链接有效期300秒；
       */
   NeedPreview?: boolean
@@ -1887,7 +1913,7 @@ export interface DescribeResourceUrlsByFlowsRequest {
   Agent: Agent
 
   /**
-   * 查询资源所对应的签署流程Id，最多支持50个。
+   * 查询资源所对应的签署流程Id，最多支持50个
    */
   FlowIds?: Array<string>
 

package/src/services/monitor/v20180724/monitor_client.ts

@@ -184,10 +184,11 @@ import {
   CreateGrafanaIntegrationResponse,
   BindPrometheusManagedGrafanaRequest,
   ResumeGrafanaInstanceResponse,
-  UpdateAlertRuleStateResponse,
+  AlarmHierarchicalNotice,
   Instance,
   DescribeProductEventListResponse,
   CreateGrafanaInstanceRequest,
+  UpdateAlertRuleStateResponse,
   BindingPolicyObjectDimension,
   UnbindPrometheusManagedGrafanaResponse,
   DescribeBasicAlarmListAlarms,

package/src/services/monitor/v20180724/monitor_models.ts

@@ -975,6 +975,16 @@ export interface CreateAlarmPolicyRequest {
    * 日志告警信息
    */
   LogAlarmReqInfo?: LogAlarmReq
+
+  /**
+   * 告警分级通知规则配置
+   */
+  HierarchicalNotices?: Array<AlarmHierarchicalNotice>
+
+  /**
+   * 迁移策略专用字段，0-走鉴权逻辑，1-跳过鉴权逻辑
+   */
+  MigrateFlag?: number
 }
 
 /**
@@ -4280,13 +4290,20 @@ export interface ResumeGrafanaInstanceResponse {
 }
 
 /**
- * UpdateAlertRuleState返回参数结构体
+ * 通知模版ID及通知等级列表，["Remind","Serious"]表示该通知模板仅接收提醒和严重类别的告警
  */
-export interface UpdateAlertRuleStateResponse {
+export interface AlarmHierarchicalNotice {
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
+      * 通知模板ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  NoticeId?: string
+
+  /**
+      * 通知等级列表，["Remind","Serious"]表示该通知模板仅接收提醒和严重类别的告警
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Classification?: Array<string>
 }
 
 /**
@@ -4361,6 +4378,16 @@ export interface CreateGrafanaInstanceRequest {
   TagSpecification?: Array<PrometheusTag>
 }
 
+/**
+ * UpdateAlertRuleState返回参数结构体
+ */
+export interface UpdateAlertRuleStateResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 策略绑定实例维度信息
  */

package/src/services/pts/v20210728/pts_models.ts

@@ -237,6 +237,12 @@ export interface Concurrency {
 注意：此字段可能返回 null，表示取不到有效值。
       */
   MaxRequestsPerSecond?: number
+
+  /**
+      * 优雅终止任务的等待时间
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  GracefulStopSeconds?: number
 }
 
 /**
@@ -890,6 +896,12 @@ export interface CustomSample {
    * 指标对应的单位，当前单位有：s,bytes,bytes/s,reqs,reqs/s,checks,checks/s,iters,iters/s,VUs, %
    */
   Unit: string
+
+  /**
+      * 指标序列名字
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Name: string
 }
 
 /**
@@ -1934,6 +1946,12 @@ export interface RequestsPerSecond {
 注意：此字段可能返回 null，表示取不到有效值。
       */
   TargetRequestsPerSecond?: number
+
+  /**
+      * 优雅关停的等待时间
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  GracefulStopSeconds?: number
 }
 
 /**
@@ -4061,6 +4079,24 @@ export interface File {
 注意：此字段可能返回 null，表示取不到有效值。
       */
   ProjectId: string
+
+  /**
+      * 用户账号的 App ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AppID: number
+
+  /**
+      * 用户主账号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Uin: string
+
+  /**
+      * 用户子账号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SubAccountUin: string
 }
 
 /**

package/src/services/ssm/v20190923/ssm_models.ts

@@ -213,7 +213,7 @@ False --  表示仅仅清理此凭据中存储的SSH密钥信息，不在CVM进
  */
 export interface CreateSecretRequest {
   /**
-   * 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。
+   * 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。一旦创建不可修改。
    */
   SecretName: string
 

package/src/services/tcb/v20180608/tcb_models.ts

@@ -2110,6 +2110,13 @@ export interface CreateWxCloudBaseRunServerDBClusterRequest {
    * mysql内核版本，支持5.7,8.0
    */
   DbVersion?: string
+
+  /**
+      * 0: 非大小写敏感
+1: 大小写敏感
+默认 0
+      */
+  LowerCaseTableName?: string
 }
 
 /**

package/src/services/tcm/v20210413/tcm_client.ts

@@ -25,10 +25,13 @@ import {
   LoadBalancerStatus,
   DescribeMeshResponse,
   AutoInjectionNamespaceState,
+  UnlinkClusterResponse,
+  LinkClusterListResponse,
   ModifyMeshResponse,
   IngressGatewayStatus,
   ResourceMetricSource,
   CreateMeshResponse,
+  LinkClusterListRequest,
   ClusterConfig,
   MetricSpec,
   WorkloadConfig,
@@ -54,9 +57,11 @@ import {
   ExtensiveCluster,
   SmartDNSConfig,
   DescribeMeshListRequest,
+  UnlinkClusterRequest,
   CLS,
   TracingConfig,
   IngressGateway,
+  EgressGatewayStatus,
   ExtensiveClusters,
   SelectedItems,
   ModifyMeshRequest,
@@ -92,13 +97,33 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 创建网格
+   * 关联集群
    */
-  async CreateMesh(
-    req: CreateMeshRequest,
-    cb?: (error: string, rep: CreateMeshResponse) => void
-  ): Promise<CreateMeshResponse> {
-    return this.request("CreateMesh", req, cb)
+  async LinkClusterList(
+    req: LinkClusterListRequest,
+    cb?: (error: string, rep: LinkClusterListResponse) => void
+  ): Promise<LinkClusterListResponse> {
+    return this.request("LinkClusterList", req, cb)
+  }
+
+  /**
+   * 查询网格列表
+   */
+  async DescribeMeshList(
+    req: DescribeMeshListRequest,
+    cb?: (error: string, rep: DescribeMeshListResponse) => void
+  ): Promise<DescribeMeshListResponse> {
+    return this.request("DescribeMeshList", req, cb)
+  }
+
+  /**
+   * 解关联集群
+   */
+  async UnlinkCluster(
+    req: UnlinkClusterRequest,
+    cb?: (error: string, rep: UnlinkClusterResponse) => void
+  ): Promise<UnlinkClusterResponse> {
+    return this.request("UnlinkCluster", req, cb)
   }
 
   /**
@@ -111,6 +136,16 @@ export class Client extends AbstractClient {
     return this.request("ModifyMesh", req, cb)
   }
 
+  /**
+   * 创建网格
+   */
+  async CreateMesh(
+    req: CreateMeshRequest,
+    cb?: (error: string, rep: CreateMeshResponse) => void
+  ): Promise<CreateMeshResponse> {
+    return this.request("CreateMesh", req, cb)
+  }
+
   /**
    * 查询网格详情
    */
@@ -120,14 +155,4 @@ export class Client extends AbstractClient {
   ): Promise<DescribeMeshResponse> {
     return this.request("DescribeMesh", req, cb)
   }
-
-  /**
-   * 查询网格列表
-   */
-  async DescribeMeshList(
-    req: DescribeMeshListRequest,
-    cb?: (error: string, rep: DescribeMeshListResponse) => void
-  ): Promise<DescribeMeshListResponse> {
-    return this.request("DescribeMeshList", req, cb)
-  }
 }

package/src/services/tcm/v20210413/tcm_models.ts

@@ -179,6 +179,26 @@ export interface AutoInjectionNamespaceState {
   State?: string
 }
 
+/**
+ * UnlinkCluster返回参数结构体
+ */
+export interface UnlinkClusterResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * LinkClusterList返回参数结构体
+ */
+export interface LinkClusterListResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * ModifyMesh返回参数结构体
  */
@@ -197,6 +217,21 @@ export interface IngressGatewayStatus {
    * 负载均衡实例状态
    */
   LoadBalancer: LoadBalancerStatus
+
+  /**
+   * ingress gateway 当前的版本
+   */
+  CurrentVersion: string
+
+  /**
+   * ingress gateway 目标的版本
+   */
+  DesiredVersion: string
+
+  /**
+   * ingress gateway的状态，取值running, upgrading, rollbacking
+   */
+  State: string
 }
 
 /**
@@ -234,6 +269,21 @@ export interface CreateMeshResponse {
   RequestId?: string
 }
 
+/**
+ * LinkClusterList请求参数结构体
+ */
+export interface LinkClusterListRequest {
+  /**
+   * 网格Id
+   */
+  MeshId: string
+
+  /**
+   * 关联集群
+   */
+  ClusterList: Array<Cluster>
+}
+
 /**
  * 集群配置
  */
@@ -342,6 +392,11 @@ export interface EgressGateway {
    * 工作负载配置
    */
   Workload?: WorkloadConfig
+
+  /**
+   * 工作负载的状态
+   */
+  Status?: EgressGatewayStatus
 }
 
 /**
@@ -456,6 +511,11 @@ export interface Mesh {
    * Mesh详细状态
    */
   Status: MeshStatus
+
+  /**
+   * 标签列表
+   */
+  TagList: Array<Tag>
 }
 
 /**
@@ -868,6 +928,21 @@ export interface DescribeMeshListRequest {
   Offset?: number
 }
 
+/**
+ * UnlinkCluster请求参数结构体
+ */
+export interface UnlinkClusterRequest {
+  /**
+   * 网格Id
+   */
+  MeshId: string
+
+  /**
+   * 取消关联的集群Id
+   */
+  ClusterId?: string
+}
+
 /**
  * 腾讯云日志服务相关参数
  */
@@ -964,6 +1039,26 @@ export interface IngressGateway {
   LoadBalancerId?: string
 }
 
+/**
+ * egress gateway 的状态
+ */
+export interface EgressGatewayStatus {
+  /**
+   * egress gateway的当前版本
+   */
+  CurrentVersion: string
+
+  /**
+   * egress gateway的目标版本
+   */
+  DesiredVersion: string
+
+  /**
+   * egress gateway的状态，取值：running，upgrading，rollbacking
+   */
+  State: string
+}
+
 /**
  * 内网独占集群配置列表
  */