tencentcloud-sdk-nodejs 4.0.821 → 4.0.823

package/tencentcloud/services/es/v20180416/es_models.d.ts

@@ -1617,7 +1617,7 @@ export interface CreateIndexRequest {
     /**
      * 【必填】创建的索引元数据JSON，如mappings、settings
      */
-    IndexMetaJson?: string;
+    IndexMetaJson: string;
     /**
      * 集群访问用户名
      */
@@ -2804,7 +2804,7 @@ export interface InstanceInfo {
      */
     SubnetUid?: string;
     /**
-     * 实例状态，0:处理中,1:正常,-1停止,-2:销毁中,-3:已销毁, 2:创建集群时初始化中
+     * 实例状态，0:处理中,1:正常,-1:停止,-2:销毁中,-3:已销毁, -4:隔离中,2:创建集群时初始化中
      */
     Status?: number;
     /**
@@ -2972,7 +2972,7 @@ export interface InstanceInfo {
      */
     DeployMode?: number;
     /**
-     * ES公网访问状态<li>OPEN：开启</li><li>CLOSE：关闭
+     * ES公网访问状态<li>OPEN：开启</li><li>CLOSE：关闭</li>
   注意：此字段可能返回 null，表示取不到有效值。
      */
     PublicAccess?: string;
@@ -2986,12 +2986,12 @@ export interface InstanceInfo {
      */
     KibanaPrivateUrl?: string;
     /**
-     * Kibana公网访问状态<li>OPEN：开启</li><li>CLOSE：关闭
+     * Kibana公网访问状态<li>OPEN：开启</li><li>CLOSE：关闭</li>
   注意：此字段可能返回 null，表示取不到有效值。
      */
     KibanaPublicAccess?: string;
     /**
-     * Kibana内网访问状态<li>OPEN：开启</li><li>CLOSE：关闭
+     * Kibana内网访问状态<li>OPEN：开启</li><li>CLOSE：关闭</li>
   注意：此字段可能返回 null，表示取不到有效值。
      */
     KibanaPrivateAccess?: string;
@@ -3141,7 +3141,7 @@ export interface InstanceInfo {
      */
     ProcessPercent?: number;
     /**
-     * Kibana的alerting外网告警策略<li>OPEN：开启</li><li>CLOSE：关闭
+     * Kibana的alerting外网告警策略<li>OPEN：开启</li><li>CLOSE：关闭</li>
   注意：此字段可能返回 null，表示取不到有效值。
      */
     KibanaAlteringPublicAccess?: string;
@@ -3165,6 +3165,16 @@ export interface InstanceInfo {
   注意：此字段可能返回 null，表示取不到有效值。
      */
     CustomKibanaPrivateUrl?: string;
+    /**
+     * 节点出站访问详细信息
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    OutboundPublicAcls?: Array<OutboundPublicAcl>;
+    /**
+     * 网络连接方案
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    NetConnectScheme?: string;
 }
 /**
  * 数据接入cvm实例信息
@@ -3334,29 +3344,19 @@ export interface DescribeLogstashPipelinesRequest {
     InstanceId: string;
 }
 /**
- * RestartNodes请求参数结构体
+ * 节点出站访问信息
  */
-export interface RestartNodesRequest {
-    /**
-     * 集群实例ID
-     */
-    InstanceId: string;
-    /**
-     * 节点名称列表
-     */
-    NodeNames: Array<string>;
-    /**
-     * 是否强制重启
-     */
-    ForceRestart?: boolean;
+export interface OutboundPublicAcl {
     /**
-     * 可选重启模式"in-place","blue-green"，分别表示重启，蓝绿重启；默认值为"in-place"
+     * 允许节点出站访问的节点类型
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    RestartMode?: string;
+    NodeType: string;
     /**
-     * 节点状态，在蓝绿模式中使用；离线节点蓝绿有风险
+     * 允许节点出站访问的白名单
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    IsOffline?: boolean;
+    WhiteHostList?: Array<string>;
 }
 /**
  * 自治索引信息
@@ -3957,75 +3957,79 @@ export interface NodeView {
     /**
      * 节点ID
      */
-    NodeId: string;
+    NodeId?: string;
     /**
      * 节点IP
      */
-    NodeIp: string;
+    NodeIp?: string;
     /**
      * 节点是否可见
      */
-    Visible: number;
+    Visible?: number;
     /**
      * 是否熔断
      */
-    Break: number;
+    Break?: number;
     /**
      * 节点总磁盘大小
      */
-    DiskSize: number;
+    DiskSize?: number;
     /**
      * 磁盘使用率
      */
-    DiskUsage: number;
+    DiskUsage?: number;
     /**
      * 节点内存大小，单位GB
      */
-    MemSize: number;
+    MemSize?: number;
     /**
      * 内存使用率
      */
-    MemUsage: number;
+    MemUsage?: number;
     /**
      * 节点cpu个数
      */
-    CpuNum: number;
+    CpuNum?: number;
     /**
      * cpu使用率
      */
-    CpuUsage: number;
+    CpuUsage?: number;
     /**
      * 可用区
      */
-    Zone: string;
+    Zone?: string;
     /**
      * 节点角色
      */
-    NodeRole: string;
+    NodeRole?: string;
     /**
      * 节点HTTP IP
      */
-    NodeHttpIp: string;
+    NodeHttpIp?: string;
     /**
      * JVM内存使用率
      */
-    JvmMemUsage: number;
+    JvmMemUsage?: number;
     /**
      * 节点分片数
      */
-    ShardNum: number;
+    ShardNum?: number;
     /**
      * 节点上磁盘ID列表
      */
-    DiskIds: Array<string>;
+    DiskIds?: Array<string>;
     /**
      * 是否为隐藏可用区
      */
-    Hidden: boolean;
+    Hidden?: boolean;
     /**
      * 是否充当协调节点的角色
      */
     IsCoordinationNode?: boolean;
+    /**
+     * CVM运行状态
+     */
+    CVMStatus?: string;
 }
 /**
  * ModifyEsVipSecurityGroup返回参数结构体
@@ -4198,6 +4202,21 @@ export interface UpdateInstanceRequest {
      * 变更为https集群，默认是http
      */
     Protocol?: string;
+    /**
+     * 节点出站访问详细信息
+  
+     */
+    OutboundPublicAcls?: Array<OutboundPublicAcl>;
+    /**
+     * 节点出站访问操作
+  OPEN 开启
+  CLOSE 关闭
+     */
+    OutboundPublicAccess?: string;
+    /**
+     * cvm延迟上架参数
+     */
+    CvmDelayOnlineTime?: number;
 }
 /**
  * CreateServerlessInstance返回参数结构体
@@ -4489,6 +4508,35 @@ export interface DescribeInstancePluginListRequest {
      */
     PluginType?: number;
 }
+/**
+ * RestartNodes请求参数结构体
+ */
+export interface RestartNodesRequest {
+    /**
+     * 集群实例ID
+     */
+    InstanceId: string;
+    /**
+     * 节点名称列表
+     */
+    NodeNames: Array<string>;
+    /**
+     * 是否强制重启
+     */
+    ForceRestart?: boolean;
+    /**
+     * 可选重启模式"in-place","blue-green"，分别表示重启，蓝绿重启；默认值为"in-place"
+     */
+    RestartMode?: string;
+    /**
+     * 节点状态，在蓝绿模式中使用；离线节点蓝绿有风险
+     */
+    IsOffline?: boolean;
+    /**
+     * cvm延迟上架时间
+     */
+    CvmDelayOnlineTime?: number;
+}
 /**
  * DescribeUserCosSnapshotList返回参数结构体
  */
@@ -4551,6 +4599,10 @@ export interface UpgradeInstanceRequest {
      * 滚动模式时，是否跳过检查，进行强制重启。默认值为false
      */
     SkipCheckForceRestart?: boolean;
+    /**
+     * cvm延迟上架参数
+     */
+    CvmDelayOnlineTime?: number;
 }
 /**
  * DescribeViews返回参数结构体

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -909,12 +909,12 @@ export interface CreateFlowOption {
      *   禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
   
      */
-    ForbidAddApprover?: string;
+    ForbidAddApprover?: boolean;
     /**
      *   禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
   
      */
-    ForbidEditFlowProperties?: string;
+    ForbidEditFlowProperties?: boolean;
     /**
      * 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用，具体的控件类型如下
   <ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
@@ -4030,13 +4030,12 @@ export interface ExtendAuthInfo {
  */
 export interface FlowCreateApprover {
     /**
-     * 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
-  0：企业
-  1：个人
-  3：企业静默签署
-  注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
-  7: 个人自动签署，适用于个人自动签场景。
-  注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
+     * 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
+  
+  <ul><li> <b>0</b> :企业B端。</li>
+  <li> <b>1</b> :个人C端。</li>
+  <li> <b>3</b> :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li>
+  <li> <b>7</b> :个人C端自动签署，适用于个人自动签场景。注: <b>个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。</b> </li></ul>
      */
     ApproverType: number;
     /**
@@ -4057,18 +4056,17 @@ export interface FlowCreateApprover {
      */
     ApproverName?: string;
     /**
-     * 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
-  请确认手机号所有方为此合同签署方。
+     * 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
   
-  在未指定签署人电子签UserId情况下，为必填参数
+  注：`在未指定签署人电子签UserId情况下，为必填参数`
   
      */
     ApproverMobile?: string;
     /**
      * 证件类型，支持以下类型
-  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
-  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
-  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
+  <ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>
+  <li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>
+  <li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
      */
     ApproverIdCardType?: string;
     /**
@@ -4080,15 +4078,17 @@ export interface FlowCreateApprover {
     ApproverIdCardNumber?: string;
     /**
      * 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
-  模板发起合同时，该参数为必填项。
-  文件发起合同时，该参数无需传值。
+  
+  <b>模板发起合同时，该参数为必填项，可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
+  <b>文件发起合同时，该参数无需传值。</b>
+  
   如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
      */
     RecipientId?: string;
     /**
      * 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
   
-  注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
+  注: <font color="red">将要废弃</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
      */
     VerifyChannel?: Array<string>;
     /**
@@ -4096,7 +4096,7 @@ export interface FlowCreateApprover {
   <ul><li>  **sms**  :  (默认)短信</li>
   <li>   **none**   : 不通知</li></ul>
   
-  注: `发起方也是签署方时不给此签署方发送短信`
+  注: `既是发起方又是签署方时，不给此签署方发送短信`
      */
     NotifyType?: string;
     /**
@@ -4104,17 +4104,25 @@ export interface FlowCreateApprover {
      */
     IsFullText?: boolean;
     /**
-     * 合同的强制预览时间：3~300s，未指定则按合同页数计算
+     * 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
+  
+  若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
+  <ul>
+  <li>合同页数少于等于2页，阅读时间为3秒；</li>
+  <li>合同页数为3到5页，阅读时间为5秒；</li>
+  <li>合同页数大于等于6页，阅读时间为10秒。</li>
+  </ul>
      */
     PreReadTime?: number;
     /**
      * 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
   
-  注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
+  注：
+  如果传进来的<font color="red">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）
      */
     UserId?: string;
     /**
-     * 字段已经废弃，当前只支持true，默认为true
+     * <font color="red">字段已经废弃</font>，当前只支持true，默认为true
      */
     Required?: boolean;
     /**
@@ -4142,9 +4150,12 @@ export interface FlowCreateApprover {
      */
     JumpUrl?: string;
     /**
-     * 签署ID
-  - 发起流程时系统自动补充
-  - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
+     * 签署人的签署ID
+  
+  <ul>
+  <li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。</li>
+  <li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>
+  </ul>
      */
     SignId?: string;
     /**
@@ -4184,11 +4195,16 @@ export interface FlowCreateApprover {
      */
     Components?: Array<Component>;
     /**
-     * 签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式
-      HANDWRITE – 手写签名
-      OCR_ESIGN -- AI智能识别手写签名
-      ESIGN -- 个人印章类型
-      SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
+     * 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
+  
+  <ul><li> <b>HANDWRITE</b> :手写签名。</li>
+  <li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
+  <li> <b>ESIGN</b> :个人印章类型。</li>
+  <li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
+  <li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
+  
+  各种签名的样式可以参考下图：
+  ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
      */
     ComponentLimitType?: Array<string>;
     /**
@@ -4227,8 +4243,7 @@ export interface FlowCreateApprover {
      */
     SignTypeSelector?: number;
     /**
-     * Deadline
-  签署人的签署截止时间，格式为Unix标准时间戳（秒）
+     * 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
   
   注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
      */
@@ -6266,8 +6281,10 @@ export interface ApproverOption {
     /**
      * 签署人信息补充类型，默认无需补充。
   
-  <ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>
-  </ul>
+  <ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
+  
+  注：
+  `使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
      */
     FillType?: number;
     /**

package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts

@@ -3023,6 +3023,10 @@ export interface CreateConsoleLoginUrlRequest {
   注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配,  当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`
      */
     ProxyOperatorName?: string;
+    /**
+     * 子客企业员工的手机码,  支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配,  当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`
+     */
+    ProxyOperatorMobile?: string;
     /**
      * Web控制台登录后进入的功能模块,  支持的模块包括：
   <ul>
@@ -4740,11 +4744,16 @@ export interface FlowApproverInfo {
      */
     SignComponents?: Array<Component>;
     /**
-     * 签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式
-      HANDWRITE – 手写签名
-      OCR_ESIGN -- AI智能识别手写签名
-      ESIGN -- 个人印章类型
-      SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
+     * 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
+  
+  <ul><li> <b>HANDWRITE</b> :手写签名。</li>
+  <li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
+  <li> <b>ESIGN</b> :个人印章类型。</li>
+  <li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
+  <li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
+  
+  各种签名的样式可以参考下图：
+  ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
      */
     ComponentLimitType?: Array<string>;
     /**
@@ -5958,8 +5967,10 @@ export interface ApproverOption {
     /**
      * 签署人信息补充类型，默认无需补充。
   
-  <ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>
-  </ul>
+  <ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
+  
+  注：
+  `使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
      */
     FillType?: number;
     /**