tccli 3.0.1199.1__py2.py3-none-any.whl → 3.0.1200.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "actions": {
3
3
  "ChannelBatchCancelFlows": {
4
- "document": "通过合同编号批量撤销合同,单次最多支持撤销100份合同。\n\n适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。\n\n\n注:\n- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>",
4
+ "document": "通过合同编号批量撤销合同,单次最多支持撤销100份合同。\n\n适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。\n\n\n注:\n- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>\n- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。",
5
5
  "input": "ChannelBatchCancelFlowsRequest",
6
6
  "name": "批量撤销合同流程",
7
7
  "output": "ChannelBatchCancelFlowsResponse",
8
8
  "status": "online"
9
9
  },
10
10
  "ChannelCancelFlow": {
11
- "document": "撤销签署流程接口\n\n适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n注:\n- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>",
11
+ "document": "撤销签署流程接口\n\n适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n注:\n- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>\n- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。",
12
12
  "input": "ChannelCancelFlowRequest",
13
13
  "name": "撤销合同流程",
14
14
  "output": "ChannelCancelFlowResponse",
@@ -29,16 +29,16 @@
29
29
  "status": "online"
30
30
  },
31
31
  "ChannelCreateBatchCancelFlowUrl": {
32
- "document": "通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同\n\n适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。\n\n注:\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>",
32
+ "document": "通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同\n\n适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。\n\n注:\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>\n- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>\n- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。",
33
33
  "input": "ChannelCreateBatchCancelFlowUrlRequest",
34
34
  "name": "获取批量撤销合同流程的腾讯电子签小程序链接",
35
35
  "output": "ChannelCreateBatchCancelFlowUrlResponse",
36
36
  "status": "online"
37
37
  },
38
38
  "ChannelCreateBatchQuickSignUrl": {
39
- "document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意**:\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。\n2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。\n3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。\n4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
39
+ "document": "该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件** 。\n3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
40
40
  "input": "ChannelCreateBatchQuickSignUrlRequest",
41
- "name": "获取H5批量签署链接",
41
+ "name": "获取H5批量签署或查看链接",
42
42
  "output": "ChannelCreateBatchQuickSignUrlResponse",
43
43
  "status": "online"
44
44
  },
@@ -344,7 +344,7 @@
344
344
  "status": "online"
345
345
  },
346
346
  "CreateConsoleLoginUrl": {
347
- "document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员工认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程,需要注意如下情况:\n\n1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>",
347
+ "document": "此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员工认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程,需要注意如下情况:\n\n1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>",
348
348
  "input": "CreateConsoleLoginUrlRequest",
349
349
  "name": "生成子客登录链接",
350
350
  "output": "CreateConsoleLoginUrlResponse",
@@ -6328,6 +6328,15 @@
6328
6328
  "name": "TopNavigationStatus",
6329
6329
  "required": false,
6330
6330
  "type": "string"
6331
+ },
6332
+ {
6333
+ "disabled": false,
6334
+ "document": "是否自动激活子客",
6335
+ "example": "无",
6336
+ "member": "bool",
6337
+ "name": "AutoActive",
6338
+ "required": false,
6339
+ "type": "bool"
6331
6340
  }
6332
6341
  ],
6333
6342
  "type": "object"
@@ -8991,7 +9000,7 @@
8991
9000
  },
8992
9001
  {
8993
9002
  "disabled": false,
8994
- "document": "视频核身意图配置,可指定问答模式或者点头模式的语音文本。\n\n注:\n `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`\n`2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`",
9003
+ "document": "<b>只有在生成H5签署链接的情形下</b>( 如调用<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口),该配置才会生效。\n\n您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。\n\n注意:\n1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。\n2. 使用视频认证时,<b>合同发起的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。\n3. 签署完成后,可以通过<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo\" target=\"_blank\">查询签署认证人脸视频</a>获取到当时的视频。",
8995
9004
  "example": "无",
8996
9005
  "member": "Intention",
8997
9006
  "name": "Intention",
@@ -95,12 +95,6 @@
95
95
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"在合同[yDwFkUUckpstzjhfUugNAWf1KibXqS26]中无法找到参与人[姓名:典子谦,手机号:13200000000,证件号:620000198802020000,证件类型:ID_CARD,参与人类型:1]\"\n },\n \"RequestId\": \"s1698**53\"\n }\n}",
96
96
  "title": "错误示例-创建签署链接中指定的C端个人用户不在合同参与人列表中"
97
97
  },
98
- {
99
- "document": "1. 合同已经创建完成,其中个人用户A需要补充一些合同信息\n2. 给个人用户A创建批量签署链接",
100
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\"\n },\n \"FlowApproverInfo\": {\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"IdCardNumber\": \"620000198802020000\",\n \"IdCardType\": \"ID_CARD\"\n },\n \"SignatureTypes\": [\n 0,\n 1\n ],\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowIds\": [\n \"yDwFkUUckpstzjhfUugNAWf1KibXqS26\"\n ]\n}",
101
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"个人H5批量签署,不支持还需签署方推拽签署控件的合同。不满足合同:[\\\"yDwFkUUckpstzjhfUugNAWf1KibXqS26\\\"]\"\n },\n \"RequestId\": \"s1698**1759\"\n }\n}",
102
- "title": "错误示例-创建批量签署链接中的合同,个人用户还有填写控件需要补充"
103
- },
104
98
  {
105
99
  "document": "1. 指定了合同流程ID信息\n2. 指定了合同组ID信息",
106
100
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\"\n },\n \"FlowApproverInfo\": {\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"IdCardNumber\": \"620000198802020000\",\n \"IdCardType\": \"ID_CARD\"\n },\n \"FlowGroupId\": \"yDSL9UUckpo*****jwSsug2y3cW\",\n \"FlowIds\": [\n \"yDRSRUUgygj6******7wUuaaadqccc\",\n \"yDRSRUUgygj6rq***Cpxxxsdfa\"\n ]\n}",
@@ -232,7 +232,7 @@
232
232
  "value_allowed_null": true
233
233
  },
234
234
  {
235
- "disabled": false,
235
+ "disabled": true,
236
236
  "document": "Git信息。\n注意:此字段可能返回 null,表示取不到有效值。",
237
237
  "example": "无",
238
238
  "member": "string",
@@ -240,6 +240,16 @@
240
240
  "output_required": false,
241
241
  "type": "string",
242
242
  "value_allowed_null": true
243
+ },
244
+ {
245
+ "disabled": false,
246
+ "document": "Git信息。\n注意:此字段可能返回 null,表示取不到有效值。",
247
+ "example": "无",
248
+ "member": "GitInfo",
249
+ "name": "GitSource",
250
+ "output_required": false,
251
+ "type": "object",
252
+ "value_allowed_null": true
243
253
  }
244
254
  ],
245
255
  "usage": "out"
@@ -723,7 +733,7 @@
723
733
  },
724
734
  {
725
735
  "disabled": false,
726
- "document": "过滤器,支持过滤字段:\n- Name:任务批次名称\n- RunGroupId:任务批次ID\n- Status:任务批次状态",
736
+ "document": "过滤器,支持过滤字段:\n- Name:任务批次名称\n- RunGroupId:任务批次ID\n- Status:任务批次状态\n- ApplicationId:应用ID\n- Type:类型(支持WDL,NEXTFLOW)",
727
737
  "example": "无",
728
738
  "member": "Filter",
729
739
  "name": "Filters",
@@ -797,7 +807,7 @@
797
807
  },
798
808
  {
799
809
  "disabled": false,
800
- "document": "过滤器,支持过滤字段:\n- RunGroupId:任务批次ID\n- Status:任务状态\n- RunUuid:任务UUID\n- UserDefinedId:用户定义ID",
810
+ "document": "过滤器,支持过滤字段:\n- RunGroupId:任务批次ID\n- Status:任务状态\n- RunUuid:任务UUID\n- ApplicationId:应用ID\n- UserDefinedId:用户定义ID(批量运行表格第一列)",
801
811
  "example": "无",
802
812
  "member": "Filter",
803
813
  "name": "Filters",
@@ -1504,51 +1514,61 @@
1504
1514
  "members": [
1505
1515
  {
1506
1516
  "disabled": false,
1507
- "document": "Git地址。",
1517
+ "document": "Git地址。\n注意:此字段可能返回 null,表示取不到有效值。",
1508
1518
  "example": "无",
1509
1519
  "member": "string",
1510
1520
  "name": "GitHttpPath",
1521
+ "output_required": false,
1511
1522
  "required": true,
1512
- "type": "string"
1523
+ "type": "string",
1524
+ "value_allowed_null": true
1513
1525
  },
1514
1526
  {
1515
1527
  "disabled": false,
1516
- "document": "Git用户名。",
1528
+ "document": "Git用户名。\n注意:此字段可能返回 null,表示取不到有效值。",
1517
1529
  "example": "无",
1518
1530
  "member": "string",
1519
1531
  "name": "GitUserName",
1532
+ "output_required": false,
1520
1533
  "required": false,
1521
- "type": "string"
1534
+ "type": "string",
1535
+ "value_allowed_null": true
1522
1536
  },
1523
1537
  {
1524
1538
  "disabled": false,
1525
- "document": "Git密码或者Token",
1539
+ "document": "Git密码或者Token。\n注意:此字段可能返回 null,表示取不到有效值。",
1526
1540
  "example": "无",
1527
1541
  "member": "string",
1528
1542
  "name": "GitTokenOrPassword",
1543
+ "output_required": false,
1529
1544
  "required": false,
1530
- "type": "string"
1545
+ "type": "string",
1546
+ "value_allowed_null": true
1531
1547
  },
1532
1548
  {
1533
1549
  "disabled": false,
1534
- "document": "分支。",
1550
+ "document": "分支。\n注意:此字段可能返回 null,表示取不到有效值。",
1535
1551
  "example": "无",
1536
1552
  "member": "string",
1537
1553
  "name": "Branch",
1554
+ "output_required": false,
1538
1555
  "required": false,
1539
- "type": "string"
1556
+ "type": "string",
1557
+ "value_allowed_null": true
1540
1558
  },
1541
1559
  {
1542
1560
  "disabled": false,
1543
- "document": "标签。",
1561
+ "document": "标签。\n注意:此字段可能返回 null,表示取不到有效值。",
1544
1562
  "example": "无",
1545
1563
  "member": "string",
1546
1564
  "name": "Tag",
1565
+ "output_required": false,
1547
1566
  "required": false,
1548
- "type": "string"
1567
+ "type": "string",
1568
+ "value_allowed_null": true
1549
1569
  }
1550
1570
  ],
1551
- "usage": "in"
1571
+ "usage": "both"
1552
1572
  },
1553
1573
  "ImportTableFileRequest": {
1554
1574
  "document": "ImportTableFile请求参数结构体",
@@ -2367,6 +2387,26 @@
2367
2387
  "type": "string",
2368
2388
  "value_allowed_null": false
2369
2389
  },
2390
+ {
2391
+ "disabled": false,
2392
+ "document": "应用版本。\n注意:此字段可能返回 null,表示取不到有效值。",
2393
+ "example": "无",
2394
+ "member": "ApplicationVersion",
2395
+ "name": "ApplicationVersion",
2396
+ "output_required": false,
2397
+ "type": "object",
2398
+ "value_allowed_null": true
2399
+ },
2400
+ {
2401
+ "disabled": false,
2402
+ "document": "应用访问类型:\n- PRIVATE 私有应用\n- PUBLIC 公共应用\n注意:此字段可能返回 null,表示取不到有效值。",
2403
+ "example": "无",
2404
+ "member": "string",
2405
+ "name": "AccessMode",
2406
+ "output_required": false,
2407
+ "type": "string",
2408
+ "value_allowed_null": true
2409
+ },
2370
2410
  {
2371
2411
  "disabled": false,
2372
2412
  "document": "环境ID。",
@@ -2427,6 +2467,26 @@
2427
2467
  "type": "string",
2428
2468
  "value_allowed_null": false
2429
2469
  },
2470
+ {
2471
+ "disabled": false,
2472
+ "document": "任务批次类型 :\n- WDL\n- NEXTFLOW\n注意:此字段可能返回 null,表示取不到有效值。",
2473
+ "example": "无",
2474
+ "member": "string",
2475
+ "name": "Type",
2476
+ "output_required": false,
2477
+ "type": "string",
2478
+ "value_allowed_null": true
2479
+ },
2480
+ {
2481
+ "disabled": false,
2482
+ "document": "工作目录。\n注意:此字段可能返回 null,表示取不到有效值。",
2483
+ "example": "无",
2484
+ "member": "string",
2485
+ "name": "WorkDir",
2486
+ "output_required": false,
2487
+ "type": "string",
2488
+ "value_allowed_null": true
2489
+ },
2430
2490
  {
2431
2491
  "disabled": false,
2432
2492
  "document": "任务输入。",
@@ -2437,6 +2497,36 @@
2437
2497
  "type": "string",
2438
2498
  "value_allowed_null": false
2439
2499
  },
2500
+ {
2501
+ "disabled": false,
2502
+ "document": "任务输入类型:\n- JSON: 导入JSON\n- MANUAL: 手动输入\n- COS: COS文件\n注意:此字段可能返回 null,表示取不到有效值。",
2503
+ "example": "无",
2504
+ "member": "string",
2505
+ "name": "InputType",
2506
+ "output_required": false,
2507
+ "type": "string",
2508
+ "value_allowed_null": true
2509
+ },
2510
+ {
2511
+ "disabled": false,
2512
+ "document": "输入COS地址。\n注意:此字段可能返回 null,表示取不到有效值。",
2513
+ "example": "无",
2514
+ "member": "string",
2515
+ "name": "InputCosUri",
2516
+ "output_required": false,
2517
+ "type": "string",
2518
+ "value_allowed_null": true
2519
+ },
2520
+ {
2521
+ "disabled": false,
2522
+ "document": "输入模版ID。\n注意:此字段可能返回 null,表示取不到有效值。",
2523
+ "example": "无",
2524
+ "member": "string",
2525
+ "name": "InputTemplateId",
2526
+ "output_required": false,
2527
+ "type": "string",
2528
+ "value_allowed_null": true
2529
+ },
2440
2530
  {
2441
2531
  "disabled": false,
2442
2532
  "document": "WDL运行选项。",
@@ -2457,6 +2547,16 @@
2457
2547
  "type": "object",
2458
2548
  "value_allowed_null": true
2459
2549
  },
2550
+ {
2551
+ "disabled": false,
2552
+ "document": "使用的缓存卷。\n注意:此字段可能返回 null,表示取不到有效值。",
2553
+ "example": "无",
2554
+ "member": "VolumeInfo",
2555
+ "name": "Volumes",
2556
+ "output_required": false,
2557
+ "type": "list",
2558
+ "value_allowed_null": true
2559
+ },
2460
2560
  {
2461
2561
  "disabled": false,
2462
2562
  "document": "任务总数量。",
@@ -2497,6 +2597,16 @@
2497
2597
  "type": "string",
2498
2598
  "value_allowed_null": false
2499
2599
  },
2600
+ {
2601
+ "disabled": false,
2602
+ "document": "运行结果通知方式。\n注意:此字段可能返回 null,表示取不到有效值。",
2603
+ "example": "无",
2604
+ "member": "string",
2605
+ "name": "ResultNotify",
2606
+ "output_required": false,
2607
+ "type": "string",
2608
+ "value_allowed_null": true
2609
+ },
2500
2610
  {
2501
2611
  "disabled": false,
2502
2612
  "document": "创建时间。",
@@ -2536,26 +2646,6 @@
2536
2646
  "output_required": false,
2537
2647
  "type": "string",
2538
2648
  "value_allowed_null": true
2539
- },
2540
- {
2541
- "disabled": false,
2542
- "document": "运行结果通知方式。\n注意:此字段可能返回 null,表示取不到有效值。",
2543
- "example": "无",
2544
- "member": "string",
2545
- "name": "ResultNotify",
2546
- "output_required": false,
2547
- "type": "string",
2548
- "value_allowed_null": true
2549
- },
2550
- {
2551
- "disabled": false,
2552
- "document": "应用版本。\n注意:此字段可能返回 null,表示取不到有效值。",
2553
- "example": "无",
2554
- "member": "ApplicationVersion",
2555
- "name": "ApplicationVersion",
2556
- "output_required": false,
2557
- "type": "object",
2558
- "value_allowed_null": true
2559
2649
  }
2560
2650
  ],
2561
2651
  "usage": "out"
@@ -2743,6 +2833,16 @@
2743
2833
  "type": "bool",
2744
2834
  "value_allowed_null": true
2745
2835
  },
2836
+ {
2837
+ "disabled": false,
2838
+ "document": "工作目录。\n注意:此字段可能返回 null,表示取不到有效值。",
2839
+ "example": "无",
2840
+ "member": "string",
2841
+ "name": "WorkDir",
2842
+ "output_required": false,
2843
+ "type": "string",
2844
+ "value_allowed_null": true
2845
+ },
2746
2846
  {
2747
2847
  "disabled": false,
2748
2848
  "document": "标准输出。\n注意:此字段可能返回 null,表示取不到有效值。",
@@ -2833,6 +2933,17 @@
2833
2933
  "required": false,
2834
2934
  "type": "bool",
2835
2935
  "value_allowed_null": true
2936
+ },
2937
+ {
2938
+ "disabled": false,
2939
+ "document": "是否添加运行信息到输出目录中\n注意:此字段可能返回 null,表示取不到有效值。",
2940
+ "example": "无",
2941
+ "member": "bool",
2942
+ "name": "AddRunInfoToOutputDir",
2943
+ "output_required": false,
2944
+ "required": false,
2945
+ "type": "bool",
2946
+ "value_allowed_null": true
2836
2947
  }
2837
2948
  ],
2838
2949
  "usage": "both"
@@ -3390,6 +3501,42 @@
3390
3501
  }
3391
3502
  ],
3392
3503
  "usage": "out"
3504
+ },
3505
+ "VolumeInfo": {
3506
+ "document": "缓存卷信息。",
3507
+ "members": [
3508
+ {
3509
+ "disabled": false,
3510
+ "document": "缓存卷ID。\n注意:此字段可能返回 null,表示取不到有效值。",
3511
+ "example": "无",
3512
+ "member": "string",
3513
+ "name": "VolumeId",
3514
+ "output_required": false,
3515
+ "type": "string",
3516
+ "value_allowed_null": true
3517
+ },
3518
+ {
3519
+ "disabled": false,
3520
+ "document": "名称。\n注意:此字段可能返回 null,表示取不到有效值。",
3521
+ "example": "无",
3522
+ "member": "string",
3523
+ "name": "Name",
3524
+ "output_required": false,
3525
+ "type": "string",
3526
+ "value_allowed_null": true
3527
+ },
3528
+ {
3529
+ "disabled": false,
3530
+ "document": "挂载路径。\n注意:此字段可能返回 null,表示取不到有效值。",
3531
+ "example": "无",
3532
+ "member": "string",
3533
+ "name": "MountPath",
3534
+ "output_required": false,
3535
+ "type": "string",
3536
+ "value_allowed_null": true
3537
+ }
3538
+ ],
3539
+ "usage": "out"
3393
3540
  }
3394
3541
  },
3395
3542
  "version": "1.0"
@@ -1674,6 +1674,26 @@
1674
1674
  "output_required": false,
1675
1675
  "type": "string",
1676
1676
  "value_allowed_null": true
1677
+ },
1678
+ {
1679
+ "disabled": false,
1680
+ "document": "托管资源类型列表\n注意:此字段可能返回 null,表示取不到有效值。",
1681
+ "example": "无",
1682
+ "member": "string",
1683
+ "name": "HostingResourceTypes",
1684
+ "output_required": false,
1685
+ "type": "list",
1686
+ "value_allowed_null": true
1687
+ },
1688
+ {
1689
+ "disabled": false,
1690
+ "document": "托管配置信息\n注意:此字段可能返回 null,表示取不到有效值。",
1691
+ "example": "无",
1692
+ "member": "HostingConfig",
1693
+ "name": "HostingConfig",
1694
+ "output_required": false,
1695
+ "type": "object",
1696
+ "value_allowed_null": true
1677
1697
  }
1678
1698
  ],
1679
1699
  "usage": "out"
@@ -7139,6 +7159,34 @@
7139
7159
  ],
7140
7160
  "usage": "out"
7141
7161
  },
7162
+ "HostingConfig": {
7163
+ "document": "托管配置",
7164
+ "members": [
7165
+ {
7166
+ "disabled": false,
7167
+ "document": "托管资源替换时间, 默认为证书过期前30天存在续费证书则替换\n注意:此字段可能返回 null,表示取不到有效值。",
7168
+ "example": "无",
7169
+ "member": "int64",
7170
+ "name": "ReplaceTime",
7171
+ "output_required": false,
7172
+ "required": false,
7173
+ "type": "int",
7174
+ "value_allowed_null": true
7175
+ },
7176
+ {
7177
+ "disabled": false,
7178
+ "document": "托管发送消息类型:0,托管开始前消息提醒(没有续费证书也会收到该提示消息); 1, 托管开始消息提醒(存在续费证书才会收到消息提醒); 2, 托管资源替换失败消息提醒; 3 托管资源替换成功消息提醒\n注意:此字段可能返回 null,表示取不到有效值。",
7179
+ "example": "无",
7180
+ "member": "int64",
7181
+ "name": "MessageTypes",
7182
+ "output_required": false,
7183
+ "required": false,
7184
+ "type": "list",
7185
+ "value_allowed_null": true
7186
+ }
7187
+ ],
7188
+ "usage": "both"
7189
+ },
7142
7190
  "LighthouseInstanceDetail": {
7143
7191
  "document": "Lighthouse实例",
7144
7192
  "members": [
@@ -2388,6 +2388,17 @@
2388
2388
  "required": false,
2389
2389
  "type": "list",
2390
2390
  "value_allowed_null": true
2391
+ },
2392
+ {
2393
+ "disabled": false,
2394
+ "document": "挂载配置\n注意:此字段可能返回 null,表示取不到有效值。",
2395
+ "example": "Bidirectional",
2396
+ "member": "string",
2397
+ "name": "MountPropagation",
2398
+ "output_required": false,
2399
+ "required": false,
2400
+ "type": "string",
2401
+ "value_allowed_null": true
2391
2402
  }
2392
2403
  ],
2393
2404
  "usage": "both"
@@ -4521,6 +4532,15 @@
4521
4532
  "name": "OperatorRemark",
4522
4533
  "required": false,
4523
4534
  "type": "string"
4535
+ },
4536
+ {
4537
+ "disabled": false,
4538
+ "document": "延迟删除版本时间",
4539
+ "example": "0",
4540
+ "member": "int64",
4541
+ "name": "DelayedDeletionTime",
4542
+ "required": false,
4543
+ "type": "int"
4524
4544
  }
4525
4545
  ],
4526
4546
  "type": "object"
@@ -4534,7 +4554,7 @@
4534
4554
  "example": "succ",
4535
4555
  "member": "string",
4536
4556
  "name": "Result",
4537
- "required": true,
4557
+ "output_required": true,
4538
4558
  "type": "string",
4539
4559
  "value_allowed_null": true
4540
4560
  },
@@ -15,7 +15,7 @@
15
15
  "status": "online"
16
16
  },
17
17
  "TextToVoice": {
18
- "document": "腾讯云语音合成技术(TTS)可以将任意文本转化为语音,实现让机器和应用张口说话。\n腾讯TTS技术可以应用到很多场景,比如,移动APP语音播报新闻;智能设备语音提醒;依靠网上现有节目或少量录音,快速合成明星语音,降低邀约成本;支持车载导航语音合成的个性化语音播报。\n基础合成支持 SSML,语法详见 [SSML 标记语言](https://cloud.tencent.com/document/product/1073/49575)。\n默认接口请求频率限制:20次/秒。",
18
+ "document": "腾讯云语音合成技术(TTS)可以将任意文本转化为语音,实现让机器和应用张口说话。\n腾讯TTS技术可以应用到很多场景,比如,移动APP语音播报新闻;智能设备语音提醒;依靠网上现有节目或少量录音,快速合成明星语音,降低邀约成本;支持车载导航语音合成的个性化语音播报。\n基础合成支持 SSML,语法详见 [SSML 标记语言](https://cloud.tencent.com/document/product/1073/49575)。\n默认接口请求频率限制:\n精品音色和标准音色:20次/秒\n大模型音色:10次/秒\n一句话复刻音色:5次/秒",
19
19
  "input": "TextToVoiceRequest",
20
20
  "name": "基础语音合成",
21
21
  "output": "TextToVoiceResponse",
@@ -3014,6 +3014,16 @@
3014
3014
  "output_required": false,
3015
3015
  "type": "string",
3016
3016
  "value_allowed_null": true
3017
+ },
3018
+ {
3019
+ "disabled": false,
3020
+ "document": "CDC唯一ID\n注意:此字段可能返回 null,表示取不到有效值。",
3021
+ "example": "cluster-gbo27yc4",
3022
+ "member": "string",
3023
+ "name": "DedicatedClusterId",
3024
+ "output_required": false,
3025
+ "type": "string",
3026
+ "value_allowed_null": true
3017
3027
  }
3018
3028
  ],
3019
3029
  "usage": "out"
@@ -3448,6 +3458,15 @@
3448
3458
  "required": false,
3449
3459
  "type": "string"
3450
3460
  },
3461
+ {
3462
+ "disabled": false,
3463
+ "document": "CDC唯一ID",
3464
+ "example": "cluster-gbo27yc4",
3465
+ "member": "string",
3466
+ "name": "DedicatedClusterId",
3467
+ "required": false,
3468
+ "type": "string"
3469
+ },
3451
3470
  {
3452
3471
  "disabled": false,
3453
3472
  "document": "网络出口,当前仅支持精品BGP、静态单线,这2种IP 地址类型的指定出口传入,默认值:center_egress1,其它可选值:center_egress2、center_egress3",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tccli
3
- Version: 3.0.1199.1
3
+ Version: 3.0.1200.1
4
4
  Summary: Universal Command Line Environment for Tencent Cloud
5
5
  Project-URL: Bug Tracker, https://github.com/TencentCloud/tencentcloud-cli/issues
6
6
  Project-URL: Homepage, https://github.com/TencentCloud/tencentcloud-cli
@@ -13,7 +13,7 @@ Classifier: Programming Language :: Python :: 2.7
13
13
  Classifier: Programming Language :: Python :: 3
14
14
  Requires-Dist: jmespath==0.10.0
15
15
  Requires-Dist: six==1.16.0
16
- Requires-Dist: tencentcloud-sdk-python>=3.0.1199
16
+ Requires-Dist: tencentcloud-sdk-python>=3.0.1200
17
17
  Description-Content-Type: text/markdown
18
18
 
19
19
  # 命令行工具简介