tccli 3.0.1052.1__py2.py3-none-any.whl → 3.0.1053.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
tccli/__init__.py CHANGED
@@ -1 +1 @@
1
- __version__ = '3.0.1052.1'
1
+ __version__ = '3.0.1053.1'
@@ -0,0 +1,18 @@
1
+ **Example 1: 查询实例事件信息**
2
+
3
+
4
+
5
+ Input:
6
+
7
+ ```
8
+ tccli cdb DescribeInstanceAlarmEvents --cli-unfold-argument ```
9
+
10
+ Output:
11
+ ```
12
+ {
13
+ "Response": {
14
+ "RequestId": "mnksadas-cb0d-4943-9b17-c3306ed3d"
15
+ }
16
+ }
17
+ ```
18
+
@@ -23,6 +23,7 @@ Output:
23
23
  "CSType": 1,
24
24
  "CSShiftDuration": 1,
25
25
  "CSExpiredTime": 0,
26
+ "ChannelId": 1,
26
27
  "CreatedAt": 0,
27
28
  "UpdatedAt": 0
28
29
  }
@@ -6309,6 +6309,58 @@ def doModifyAccountPassword(args, parsed_globals):
6309
6309
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
6310
6310
 
6311
6311
 
6312
+ def doDescribeInstanceAlarmEvents(args, parsed_globals):
6313
+ g_param = parse_global_arg(parsed_globals)
6314
+
6315
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
6316
+ cred = credential.CVMRoleCredential()
6317
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
6318
+ cred = credential.STSAssumeRoleCredential(
6319
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
6320
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
6321
+ )
6322
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
6323
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
6324
+ else:
6325
+ cred = credential.Credential(
6326
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
6327
+ )
6328
+ http_profile = HttpProfile(
6329
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
6330
+ reqMethod="POST",
6331
+ endpoint=g_param[OptionsDefine.Endpoint],
6332
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
6333
+ )
6334
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
6335
+ if g_param[OptionsDefine.Language]:
6336
+ profile.language = g_param[OptionsDefine.Language]
6337
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
6338
+ client = mod.CdbClient(cred, g_param[OptionsDefine.Region], profile)
6339
+ client._sdkVersion += ("_CLI_" + __version__)
6340
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
6341
+ model = models.DescribeInstanceAlarmEventsRequest()
6342
+ model.from_json_string(json.dumps(args))
6343
+ start_time = time.time()
6344
+ while True:
6345
+ rsp = client.DescribeInstanceAlarmEvents(model)
6346
+ result = rsp.to_json_string()
6347
+ try:
6348
+ json_obj = json.loads(result)
6349
+ except TypeError as e:
6350
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
6351
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
6352
+ break
6353
+ cur_time = time.time()
6354
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
6355
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
6356
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
6357
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
6358
+ else:
6359
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
6360
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
6361
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
6362
+
6363
+
6312
6364
  def doDescribeUploadedFiles(args, parsed_globals):
6313
6365
  g_param = parse_global_arg(parsed_globals)
6314
6366
 
@@ -8365,6 +8417,7 @@ ACTION_MAP = {
8365
8417
  "ResetRootAccount": doResetRootAccount,
8366
8418
  "ModifyAuditRuleTemplates": doModifyAuditRuleTemplates,
8367
8419
  "ModifyAccountPassword": doModifyAccountPassword,
8420
+ "DescribeInstanceAlarmEvents": doDescribeInstanceAlarmEvents,
8368
8421
  "DescribeUploadedFiles": doDescribeUploadedFiles,
8369
8422
  "ModifyAccountDescription": doModifyAccountDescription,
8370
8423
  "DescribeSlowLogData": doDescribeSlowLogData,
@@ -546,6 +546,13 @@
546
546
  "output": "DescribeErrorLogDataResponse",
547
547
  "status": "online"
548
548
  },
549
+ "DescribeInstanceAlarmEvents": {
550
+ "document": "查询实例发生的事件信息",
551
+ "input": "DescribeInstanceAlarmEventsRequest",
552
+ "name": "查询实例发生的事件信息",
553
+ "output": "DescribeInstanceAlarmEventsResponse",
554
+ "status": "online"
555
+ },
549
556
  "DescribeInstanceParamRecords": {
550
557
  "document": "该接口(DescribeInstanceParamRecords)用于查询实例参数修改历史。",
551
558
  "input": "DescribeInstanceParamRecordsRequest",
@@ -10322,6 +10329,23 @@
10322
10329
  ],
10323
10330
  "type": "object"
10324
10331
  },
10332
+ "DescribeInstanceAlarmEventsRequest": {
10333
+ "document": "DescribeInstanceAlarmEvents请求参数结构体",
10334
+ "members": [],
10335
+ "type": "object"
10336
+ },
10337
+ "DescribeInstanceAlarmEventsResponse": {
10338
+ "document": "DescribeInstanceAlarmEvents返回参数结构体",
10339
+ "members": [
10340
+ {
10341
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
10342
+ "member": "string",
10343
+ "name": "RequestId",
10344
+ "type": "string"
10345
+ }
10346
+ ],
10347
+ "type": "object"
10348
+ },
10325
10349
  "DescribeInstanceParamRecordsRequest": {
10326
10350
  "document": "DescribeInstanceParamRecords请求参数结构体",
10327
10351
  "members": [
@@ -666,6 +666,14 @@
666
666
  "title": "查询实例错误日志"
667
667
  }
668
668
  ],
669
+ "DescribeInstanceAlarmEvents": [
670
+ {
671
+ "document": "",
672
+ "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceAlarmEvents\n<公共请求参数>\n\n{}",
673
+ "output": "{\n \"Response\": {\n \"RequestId\": \"mnksadas-cb0d-4943-9b17-c3306ed3d\"\n }\n}",
674
+ "title": "查询实例事件信息"
675
+ }
676
+ ],
669
677
  "DescribeInstanceParamRecords": [
670
678
  {
671
679
  "document": "",
@@ -1916,8 +1916,8 @@
1916
1916
  },
1917
1917
  {
1918
1918
  "disabled": false,
1919
- "document": "客户端Token。",
1920
- "example": "sdcdwxxxws",
1919
+ "document": "唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280",
1920
+ "example": "a9a90aa6-751a-41b6-aad6-fae36063280",
1921
1921
  "member": "string",
1922
1922
  "name": "ClientToken",
1923
1923
  "required": false,
@@ -9072,8 +9072,8 @@
9072
9072
  },
9073
9073
  {
9074
9074
  "disabled": false,
9075
- "document": "客户端Token。",
9076
- "example": "\"\"",
9075
+ "document": "唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280",
9076
+ "example": "a9a90aa6-751a-41b6-aad6-fae36063280",
9077
9077
  "member": "string",
9078
9078
  "name": "ClientToken",
9079
9079
  "required": false,
@@ -9280,7 +9280,7 @@
9280
9280
  "example": "emr-5n3l5c83",
9281
9281
  "member": "string",
9282
9282
  "name": "InstanceId",
9283
- "required": true,
9283
+ "output_required": true,
9284
9284
  "type": "string",
9285
9285
  "value_allowed_null": false
9286
9286
  },
@@ -9290,7 +9290,7 @@
9290
9290
  "example": "[\"20200309357833\",\"20200309357834\",\"20200309357835\",\"20200309357836\"]",
9291
9291
  "member": "string",
9292
9292
  "name": "DealNames",
9293
- "required": true,
9293
+ "output_required": true,
9294
9294
  "type": "list",
9295
9295
  "value_allowed_null": true
9296
9296
  },
@@ -9300,7 +9300,7 @@
9300
9300
  "example": "\"\"",
9301
9301
  "member": "string",
9302
9302
  "name": "ClientToken",
9303
- "required": true,
9303
+ "output_required": true,
9304
9304
  "type": "string",
9305
9305
  "value_allowed_null": true
9306
9306
  },
@@ -9310,7 +9310,7 @@
9310
9310
  "example": "0",
9311
9311
  "member": "int64",
9312
9312
  "name": "FlowId",
9313
- "required": true,
9313
+ "output_required": true,
9314
9314
  "type": "int",
9315
9315
  "value_allowed_null": true
9316
9316
  },
@@ -9320,7 +9320,7 @@
9320
9320
  "example": "\"\"",
9321
9321
  "member": "string",
9322
9322
  "name": "BillId",
9323
- "required": true,
9323
+ "output_required": true,
9324
9324
  "type": "string",
9325
9325
  "value_allowed_null": true
9326
9326
  },
@@ -8,7 +8,7 @@
8
8
  "status": "online"
9
9
  },
10
10
  "CancelFlow": {
11
- "document": "用于撤销合同流程<br/>\n适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>\n\n注:\n`如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow\" target=\"_blank\">发起解除合同流程</a>接口。",
11
+ "document": "用于撤销合同流程<br/>\n适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n注:\n1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow\" target=\"_blank\">发起解除合同流程</a>接口。\n\n2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>\n![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)\n\n3. <font color='red'>撤销合同会返还合同额度</font>",
12
12
  "input": "CancelFlowRequest",
13
13
  "name": "撤销单个合同流程",
14
14
  "output": "CancelFlowResponse",
@@ -29,9 +29,9 @@
29
29
  "status": "online"
30
30
  },
31
31
  "CreateBatchCancelFlowUrl": {
32
- "document": "注:此接口将会废弃,请使用撤销单个签署流程(CancelFlow)接口。\n指定需要批量撤回的签署流程Id,获取批量撤销链接。\n客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。",
32
+ "document": "指定需要批量撤回的签署流程Id,以获取批量撤销链接。\n客户需指定要撤回的签署流程Id,最多可指定100个,超过100则不处理。\n接口调用成功后,将返回批量撤回合同的链接。通过点击链接,可跳转至电子签小程序完成批量撤回操作。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n注:\n1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow\" target=\"_blank\">发起解除合同流程</a>接口。\n\n2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>\n![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)\n\n3. <font color='red'>撤销合同会返还合同额度</font>",
33
33
  "input": "CreateBatchCancelFlowUrlRequest",
34
- "name": "批量撤销签署流程",
34
+ "name": "获取批量撤销签署流程腾讯电子签小程序链接",
35
35
  "output": "CreateBatchCancelFlowUrlResponse",
36
36
  "status": "online"
37
37
  },
@@ -1371,7 +1371,7 @@
1371
1371
  },
1372
1372
  {
1373
1373
  "disabled": false,
1374
- "document": "合同流程ID, 为32位字符串。\n\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)",
1374
+ "document": "合同流程ID, 为32位字符串。\n\n可登录腾讯电子签控制台,[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
1375
1375
  "example": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
1376
1376
  "member": "string",
1377
1377
  "name": "FlowId",
@@ -1380,7 +1380,7 @@
1380
1380
  },
1381
1381
  {
1382
1382
  "disabled": false,
1383
- "document": "撤销此合同流程的原因,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。",
1383
+ "document": "撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。\n\n![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)",
1384
1384
  "example": "这个合同里边的付款金额写错",
1385
1385
  "member": "string",
1386
1386
  "name": "CancelMessage",
@@ -1891,7 +1891,7 @@
1891
1891
  },
1892
1892
  {
1893
1893
  "disabled": false,
1894
- "document": "需要执行撤回的流程(合同)的编号列表,最多100个.\n<br>列表中的流程(合同)编号不要重复.",
1894
+ "document": "需要执行撤回的流程(合同)的编号列表,最多100个.\n列表中的流程(合同)编号不要重复.",
1895
1895
  "example": "无",
1896
1896
  "member": "string",
1897
1897
  "name": "FlowIds",
@@ -4984,7 +4984,7 @@
4984
4984
  },
4985
4985
  {
4986
4986
  "disabled": false,
4987
- "document": "签署完成后是否自动回跳\n<ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>\n注: ` 该参数只针对\"APP\" 类型的签署链接有效`",
4987
+ "document": "签署完成后是否自动回跳\n<ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>\n\n注: \n1. 该参数<font color=\"red\">只针对APP</font> 类型的签署链接有效\n2. <font color=\"red\">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)",
4988
4988
  "example": "false",
4989
4989
  "member": "bool",
4990
4990
  "name": "AutoJumpBack",
@@ -8900,7 +8900,7 @@
8900
8900
  "members": [
8901
8901
  {
8902
8902
  "disabled": false,
8903
- "document": "控件填充vaule,ComponentType和传入值类型对应关系:\nTEXT - 文本内容\nMULTI_LINE_TEXT - 文本内容\nCHECK_BOX - true/false\nFILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取\nSELECTOR - 选项值\nDYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo",
8903
+ "document": "控件填充vaule,ComponentType和传入值类型对应关系:\nTEXT 文本内容\nMULTI_LINE_TEXT :文本内容\nCHECK_BOX true/false\nFILL_IMAGE、ATTACHMENT 附件的FileId,需要通过UploadFiles接口上传获取\nSELECTOR 选项值\nDYNAMIC_TABLE :传入json格式的表格内容,具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)",
8904
8904
  "example": "ComponentValue",
8905
8905
  "member": "string",
8906
8906
  "name": "ComponentValue",
@@ -8911,7 +8911,7 @@
8911
8911
  },
8912
8912
  {
8913
8913
  "disabled": false,
8914
- "document": "控件id,和ComponentName选择一项传入即可",
8914
+ "document": "控件id,和ComponentName选择一项传入即可\n\n<a href=\"https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4\" target=\"_blank\">点击查看在模版中找到控件ID的方式</a>",
8915
8915
  "example": "componentId",
8916
8916
  "member": "string",
8917
8917
  "name": "ComponentId",
@@ -8922,7 +8922,7 @@
8922
8922
  },
8923
8923
  {
8924
8924
  "disabled": false,
8925
- "document": "控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可",
8925
+ "document": "控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可\n\n<a href=\"https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4\" target=\"_blank\">点击查看在模版中找到控件名字的方式</a>",
8926
8926
  "example": "ComponentName",
8927
8927
  "member": "string",
8928
8928
  "name": "ComponentName",
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "actions": {
3
3
  "ChannelBatchCancelFlows": {
4
- "document": "通过合同编号批量撤销合同,单次最多支持撤销100份合同。\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>",
4
+ "document": "通过合同编号批量撤销合同,单次最多支持撤销100份合同。\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>",
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>",
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>",
12
12
  "input": "ChannelCancelFlowRequest",
13
13
  "name": "撤销合同流程",
14
14
  "output": "ChannelCancelFlowResponse",
@@ -29,7 +29,7 @@
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注:\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>",
32
+ "document": "通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同\n\n适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n\n- **可撤回合同状态**:未全部签署完成\n- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。\n\n注:\n- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href=\"https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow\" target=\"_blank\">发起解除合同流程接口</a>",
33
33
  "input": "ChannelCreateBatchCancelFlowUrlRequest",
34
34
  "name": "获取批量撤销合同流程的腾讯电子签小程序链接",
35
35
  "output": "ChannelCreateBatchCancelFlowUrlResponse",
@@ -337,7 +337,7 @@
337
337
  "status": "online"
338
338
  },
339
339
  "CreateFlowsByTemplates": {
340
- "document": "接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。\n如若在模板中配置了动态表格, 上传的附件必须为A4大小 \n合同发起人必须在电子签已经进行实名。\n\n**整体的逻辑如下**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)\n\n**可以作为发起方和签署方的角色列表**\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B(不指定经办人)</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景五</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n**注**: \n`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`\n\n`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`\n\n`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)`\n\n`4. 静默(自动)签署不支持合同签署方存在填写功能`",
340
+ "document": "接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。\n如若在模板中配置了动态表格, 上传的附件必须为A4大小 \n合同发起人必须在电子签已经进行实名。\n\n**整体的逻辑如下**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)\n\n**可以作为发起方和签署方的角色列表**\n<table>\n<thead>\n<tr>\n<th>场景编号</th>\n<th>可作为发起方类型</th>\n<th>可作为签署方的类型</th>\n</tr>\n</thead>\n\n<tbody>\n<tr>\n<td>场景一</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业A员工</td>\n</tr>\n\n<tr>\n<td>场景二</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B(不指定经办人)</td>\n</tr>\n\n<tr>\n<td>场景三</td>\n<td>第三方子企业A员工</td>\n<td>第三方子企业B员工</td>\n</tr>\n\n<tr>\n<td>场景四</td>\n<td>第三方子企业A员工</td>\n<td>个人/自然人</td>\n</tr>\n\n<tr>\n<td>场景五</td>\n<td>第三方子企业A员工</td>\n<td>SaaS平台企业员工</td>\n</tr>\n</tbody>\n</table>\n\n**注**: \n1. 发起合同时候, 作为<font color=\"red\">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名\n\n2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明\n\n3. <font color=\"red\">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)\n\n4. <font color=\"red\">静默(自动)签署不支持合同签署方存在填写</font>\n\n5. <font color=\"red\">在下一步创建签署链接前,建议等待DocumentFill </font>[PDF合成完成的回调](https://qian.tencent.com/developers/partner/callback_types_file_resources)或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。",
341
341
  "input": "CreateFlowsByTemplatesRequest",
342
342
  "name": "用模板创建签署流程",
343
343
  "output": "CreateFlowsByTemplatesResponse",
@@ -484,7 +484,7 @@
484
484
  "status": "online"
485
485
  },
486
486
  "SyncProxyOrganizationOperators": {
487
- "document": "此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。 \n\n- **新增员工的场景**: 提前导入员工列表, 然后调用<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署\n\n- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)\n\n**注**: \n- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理\n- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职\n- 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖",
487
+ "document": "此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。 \n\n- **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href=\"https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl\" target=\"_blank\">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署\n\n- **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)\n\n**注**: \n- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理\n- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职\n- 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖",
488
488
  "input": "SyncProxyOrganizationOperatorsRequest",
489
489
  "name": "企业员工新增或离职",
490
490
  "output": "SyncProxyOrganizationOperatorsResponse",
@@ -8739,7 +8739,7 @@
8739
8739
  },
8740
8740
  {
8741
8741
  "disabled": false,
8742
- "document": "表单域或控件的ID,跟ComponentName二选一,不能全为空;\nCreateFlowsByTemplates 接口不使用此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8742
+ "document": "表单域或控件的ID,跟ComponentName二选一,不能全为空;\nCreateFlowsByTemplates 接口不使用此字段。\n\n<a href=\"https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4\" target=\"_blank\">点击此处查看模板上控件ID的获取方式</a>\n注意:此字段可能返回 null,表示取不到有效值。",
8743
8743
  "example": "391963b9d3cb2de35dedc6eb0a60e535",
8744
8744
  "member": "string",
8745
8745
  "name": "ComponentId",
@@ -8750,7 +8750,7 @@
8750
8750
  },
8751
8751
  {
8752
8752
  "disabled": false,
8753
- "document": "控件的名字,跟ComponentId二选一,不能全为空\n注意:此字段可能返回 null,表示取不到有效值。",
8753
+ "document": "控件的名字,跟ComponentId二选一,不能全为空\n\n<a href=\"https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4\" target=\"_blank\">点击此处查看模板上控件名字的获取方式</a>\n注意:此字段可能返回 null,表示取不到有效值。",
8754
8754
  "example": "住房地址",
8755
8755
  "member": "string",
8756
8756
  "name": "ComponentName",
@@ -5225,6 +5225,15 @@
5225
5225
  "name": "Offset",
5226
5226
  "required": true,
5227
5227
  "type": "int"
5228
+ },
5229
+ {
5230
+ "disabled": false,
5231
+ "document": "通道id",
5232
+ "example": "0",
5233
+ "member": "uint64",
5234
+ "name": "ChannelId",
5235
+ "required": false,
5236
+ "type": "int"
5228
5237
  }
5229
5238
  ],
5230
5239
  "type": "object"
@@ -8534,6 +8543,16 @@
8534
8543
  "output_required": false,
8535
8544
  "type": "string",
8536
8545
  "value_allowed_null": true
8546
+ },
8547
+ {
8548
+ "disabled": false,
8549
+ "document": "通道id",
8550
+ "example": "0",
8551
+ "member": "uint64",
8552
+ "name": "ChannelId",
8553
+ "output_required": false,
8554
+ "type": "int",
8555
+ "value_allowed_null": false
8537
8556
  }
8538
8557
  ],
8539
8558
  "usage": "out"
@@ -436,7 +436,7 @@
436
436
  {
437
437
  "document": "",
438
438
  "input": "POST / HTTP/1.1\nHost: iotvideo.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDevicePackages\n<公共请求参数>\n\n{\n \"ProductId\": \"abc\",\n \"DeviceName\": \"abc\",\n \"Limit\": 1,\n \"Offset\": 1\n}",
439
- "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Packages\": [\n {\n \"Status\": 0,\n \"CSType\": 1,\n \"CSShiftDuration\": 1,\n \"CSExpiredTime\": 0,\n \"CreatedAt\": 0,\n \"UpdatedAt\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
439
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Packages\": [\n {\n \"Status\": 0,\n \"CSType\": 1,\n \"CSShiftDuration\": 1,\n \"CSExpiredTime\": 0,\n \"ChannelId\": 1,\n \"CreatedAt\": 0,\n \"UpdatedAt\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
440
440
  "title": "拉取有效套餐列表"
441
441
  }
442
442
  ],
@@ -2260,11 +2260,11 @@
2260
2260
  "members": [
2261
2261
  {
2262
2262
  "disabled": false,
2263
- "document": "流量值(bit)",
2263
+ "document": "流量值(byte)",
2264
2264
  "example": "98",
2265
2265
  "member": "float",
2266
2266
  "name": "Current",
2267
- "required": true,
2267
+ "output_required": true,
2268
2268
  "type": "float",
2269
2269
  "value_allowed_null": false
2270
2270
  },
@@ -2274,7 +2274,7 @@
2274
2274
  "example": "1690424186",
2275
2275
  "member": "string",
2276
2276
  "name": "Time",
2277
- "required": true,
2277
+ "output_required": true,
2278
2278
  "type": "string",
2279
2279
  "value_allowed_null": false
2280
2280
  }
@@ -3819,8 +3819,8 @@
3819
3819
  },
3820
3820
  {
3821
3821
  "disabled": false,
3822
- "document": "无需关注,是否查询zhiyan",
3823
- "example": "",
3822
+ "document": "1: 查询智研\n0: 走旧逻辑,已下线,勿使用",
3823
+ "example": "1",
3824
3824
  "member": "int64",
3825
3825
  "name": "IsNewData",
3826
3826
  "required": false,
@@ -1028,7 +1028,7 @@
1028
1028
  },
1029
1029
  {
1030
1030
  "disabled": false,
1031
- "document": "证书套餐类型:\nnull = 用户上传证书(没有套餐类型),\n1 = GeoTrust DV SSL CA - G3, 2 = TrustAsia TLS RSA CA, 3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书。\n注意:此字段可能返回 null,表示取不到有效值。",
1031
+ "document": "证书套餐类型:\n2 = TrustAsia TLS RSA CA,3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书,25 = Wotrus 域名型证书,26 = Wotrus 域名型多域名证书,27 = Wotrus 域名型通配符证书,28 = Wotrus 企业型证书,29 = Wotrus 企业型多域名证书,30 = Wotrus 企业型通配符证书,31 = Wotrus 增强型证书,32 = Wotrus 增强型多域名证书,33 = Wotrus 国密域名型证书,34 = Wotrus 国密域名型多域名证书,35 = Wotrus 国密域名型通配符证书,37 = Wotrus 国密企业型证书,38 = Wotrus 国密企业型多域名证书,39 = Wotrus 国密企业型通配符证书,40 = Wotrus 国密增强型证书,41 = Wotrus 国密增强型多域名证书,42 = TrustAsia 域名型通配符多域名证书,43 = DNSPod-企业型(OV)SSL证书,44 = DNSPod-企业型(OV)通配符SSL证书,45 = DNSPod-企业型(OV)多域名SSL证书, 46 = DNSPod-增强型(EV)SSL证书,47 = DNSPod-增强型(EV)多域名SSL证书,48 = DNSPod-域名型(DV)SSL证书,49 = DNSPod-域名型(DV)通配符SSL证书,50 = DNSPod-域名型(DV)多域名SSL证书,51 = DNSPod(国密)-企业型(OV)SSL证书,52 = DNSPod(国密)-企业型(OV)通配符SSL证书,53 = DNSPod(国密)-企业型(OV)多域名SSL证书,54 = DNSPod(国密)-域名型(DV)SSL证书,55 = DNSPod(国密)-域名型(DV)通配符SSL证书, 56 = DNSPod(国密)-域名型(DV)多域名SSL证书,57 = SecureSite 企业型专业版多域名(OV Pro),58 = SecureSite 企业型多域名(OV),59 = SecureSite 增强型专业版多域名(EV Pro),60 = SecureSite 增强型多域名(EV),61 = Geotrust 增强型多域名(EV)\n注意:此字段可能返回 null,表示取不到有效值。",
1032
1032
  "example": "无",
1033
1033
  "member": "string",
1034
1034
  "name": "PackageType",
@@ -4151,7 +4151,7 @@
4151
4151
  },
4152
4152
  {
4153
4153
  "disabled": false,
4154
- "document": "每页数量,默认20。最大1000",
4154
+ "document": "每页数量,默认10。最大1000",
4155
4155
  "example": "11",
4156
4156
  "member": "uint64",
4157
4157
  "name": "Limit",