tccli 3.0.1323.1__py2.py3-none-any.whl → 3.0.1325.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.
Files changed (38) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/autoscaling/v20180419/api.json +2 -2
  3. tccli/services/batch/v20170312/api.json +16 -16
  4. tccli/services/cfs/v20190719/api.json +45 -45
  5. tccli/services/cfs/v20190719/examples.json +1 -1
  6. tccli/services/cloudaudit/v20190319/api.json +4 -4
  7. tccli/services/csip/v20221121/api.json +1 -1
  8. tccli/services/cvm/v20170312/api.json +35 -35
  9. tccli/services/cvm/v20170312/examples.json +6 -6
  10. tccli/services/cynosdb/cynosdb_client.py +334 -16
  11. tccli/services/cynosdb/v20190107/api.json +565 -7
  12. tccli/services/cynosdb/v20190107/examples.json +48 -0
  13. tccli/services/emr/v20190103/api.json +4 -4
  14. tccli/services/ess/v20201111/api.json +2 -2
  15. tccli/services/essbasic/v20210526/api.json +2 -2
  16. tccli/services/iotexplorer/v20190423/api.json +1 -1
  17. tccli/services/lighthouse/v20200324/api.json +1 -1
  18. tccli/services/lke/v20231130/examples.json +1 -1
  19. tccli/services/lkeap/v20240522/api.json +1 -1
  20. tccli/services/monitor/v20180724/api.json +5 -2
  21. tccli/services/monitor/v20180724/examples.json +1 -1
  22. tccli/services/mqtt/mqtt_client.py +57 -4
  23. tccli/services/mqtt/v20240516/api.json +260 -124
  24. tccli/services/mqtt/v20240516/examples.json +9 -1
  25. tccli/services/ocr/v20181119/api.json +201 -2
  26. tccli/services/ocr/v20181119/examples.json +1 -1
  27. tccli/services/ses/ses_client.py +170 -11
  28. tccli/services/ses/v20201002/api.json +138 -0
  29. tccli/services/ses/v20201002/examples.json +24 -0
  30. tccli/services/tcss/v20201101/api.json +3 -3
  31. tccli/services/tcss/v20201101/examples.json +1 -1
  32. tccli/services/trtc/v20190722/api.json +2 -2
  33. tccli/services/trtc/v20190722/examples.json +6 -0
  34. {tccli-3.0.1323.1.dist-info → tccli-3.0.1325.1.dist-info}/METADATA +2 -2
  35. {tccli-3.0.1323.1.dist-info → tccli-3.0.1325.1.dist-info}/RECORD +38 -38
  36. {tccli-3.0.1323.1.dist-info → tccli-3.0.1325.1.dist-info}/WHEEL +0 -0
  37. {tccli-3.0.1323.1.dist-info → tccli-3.0.1325.1.dist-info}/entry_points.txt +0 -0
  38. {tccli-3.0.1323.1.dist-info → tccli-3.0.1325.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/cynosdb/v20190107/examples.json CHANGED
@@ -330,6 +330,14 @@
330
330
  "title": "查询备份配置信息"
331
331
  }
332
332
  ],
333
+ "DescribeBackupDownloadRestriction": [
334
+ {
335
+ "document": "查询备份下载限制",
336
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupDownloadRestriction\n<公共请求参数>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-2p3wjmzt\"\n ]\n}",
337
+ "output": "{\n \"Response\": {\n \"BackupLimitClusterRestrictions\": [\n {\n \"BackupLimitRestriction\": {\n \"IpComparisonSymbol\": \"In\",\n \"LimitIps\": [],\n \"LimitType\": \"Customize\",\n \"LimitVpcs\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"VpcList\": []\n }\n ],\n \"VpcComparisonSymbol\": \"In\"\n },\n \"ClusterId\": \"cynosdbmysql-2p3wjmzt\"\n }\n ],\n \"RequestId\": \"36eca298-c9b7-4e13-8f33-3c07926ee0d8\"\n }\n}",
338
+ "title": "查询备份下载限制"
339
+ }
340
+ ],
333
341
  "DescribeBackupDownloadUrl": [
334
342
  {
335
343
  "document": "",
@@ -338,6 +346,14 @@
338
346
  "title": "查询集群备份文件下载地址"
339
347
  }
340
348
  ],
349
+ "DescribeBackupDownloadUserRestriction": [
350
+ {
351
+ "document": "当前地域用户级别设置的默认备份下载来源限制",
352
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupDownloadUserRestriction\n<公共请求参数>\n\n{\n \"Limit\": 1,\n \"Offset\": 0,\n \"OnlyUserRestriction\": false\n}",
353
+ "output": "{\n \"Response\": {\n \"BackupLimitClusterRestrictions\": [\n {\n \"BackupLimitRestriction\": {\n \"IpComparisonSymbol\": \"In\",\n \"LimitIps\": [],\n \"LimitType\": \"Customize\",\n \"LimitVpcs\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"VpcList\": []\n }\n ],\n \"VpcComparisonSymbol\": \"In\"\n },\n \"ClusterId\": \"cynosdbmysql-2p3wjmzt\"\n }\n ],\n \"RequestId\": \"36eca298-c9b7-4e13-8f33-3c07926ee0d8\"\n }\n}",
354
+ "title": "当前地域用户级别设置的默认备份下载来源限制"
355
+ }
356
+ ],
341
357
  "DescribeBackupList": [
342
358
  {
343
359
  "document": "查询备份文件列表",
@@ -458,6 +474,14 @@
458
474
  "title": "查看集群密码复杂度详情"
459
475
  }
460
476
  ],
477
+ "DescribeClusterReadOnly": [
478
+ {
479
+ "document": "",
480
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterReadOnly\n<公共请求参数>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-jl17y89v\",\n \"cynosdbmysql-2d9pq38h\"\n ]\n}",
481
+ "output": "{\n \"Response\": {\n \"ClusterReadOnlyValues\": [\n {\n \"ClusterId\": \"cynosdbmysql-jl17y89v\",\n \"ReadOnlyValue\": \"ON\"\n },\n {\n \"ClusterId\": \"cynosdbmysql-2d9pq38h\",\n \"ReadOnlyValue\": \"ON\"\n }\n ],\n \"RequestId\": \"48b7cd8a-f6dd-4e47-a78a-ssfff\"\n }\n}",
482
+ "title": "查询集群只读开关"
483
+ }
484
+ ],
461
485
  "DescribeClusterTransparentEncryptInfo": [
462
486
  {
463
487
  "document": "",
@@ -856,6 +880,22 @@
856
880
  "title": "修改集群备份配置"
857
881
  }
858
882
  ],
883
+ "ModifyBackupDownloadRestriction": [
884
+ {
885
+ "document": "",
886
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBackupDownloadRestriction\n<公共请求参数>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-2p3wjmzt\"\n ],\n \"LimitType\": \"NoLimit\",\n \"VpcComparisonSymbol\": \"\",\n \"IpComparisonSymbol\": \"\",\n \"LimitVpcs\": [],\n \"LimitIps\": []\n}",
887
+ "output": "{\n \"Response\": {\n \"RequestId\": \"1530aee8-5130-45ce-9f4e-dfb50a55e4d4\"\n }\n}",
888
+ "title": "修改集群下载限制"
889
+ }
890
+ ],
891
+ "ModifyBackupDownloadUserRestriction": [
892
+ {
893
+ "document": "",
894
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBackupDownloadUserRestriction\n<公共请求参数>\n\n{\n \"LimitType\": \"NoLimit\",\n \"VpcComparisonSymbol\": \"\",\n \"IpComparisonSymbol\": \"\",\n \"LimitVpcs\": [],\n \"LimitIps\": []\n}",
895
+ "output": "{\n \"Response\": {\n \"RequestId\": \"1530aee8-5130-45ce-9f4e-dfb50a55e4d4\"\n }\n}",
896
+ "title": "修改用户当前地域的备份文件限制"
897
+ }
898
+ ],
859
899
  "ModifyBackupName": [
860
900
  {
861
901
  "document": "",
@@ -912,6 +952,14 @@
912
952
  "title": "用于修改/开启集群密码复杂度"
913
953
  }
914
954
  ],
955
+ "ModifyClusterReadOnly": [
956
+ {
957
+ "document": "",
958
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterReadOnly\n<公共请求参数>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-jl17y89v\",\n \"cynosdbmysql-2d9pq38h\"\n ],\n \"ReadOnlyOperation\": \"ON\",\n \"IsInMaintainPeriod\": \"no\"\n}",
959
+ "output": "{\n \"Response\": {\n \"ClusterTaskIds\": [\n {\n \"ClusterId\": \"cynosdbmysql-jl17y89v\",\n \"TaskId\": \"176551\"\n },\n {\n \"ClusterId\": \"cynosdbmysql-2d9pq38h\",\n \"TaskId\": \"176552\"\n }\n ],\n \"RequestId\": \"48b7cd8a-f6dd-4e47-a78a-ssfff\"\n }\n}",
960
+ "title": "修改集群只读开关"
961
+ }
962
+ ],
915
963
  "ModifyClusterSlaveZone": [
916
964
  {
917
965
  "document": "",
tccli/services/emr/v20190103/api.json CHANGED
@@ -442,11 +442,11 @@
442
442
  "status": "online"
443
443
  },
444
444
  "ModifyResourceScheduleConfig": {
445
- "document": "修改YARN资源调度的资源配置。已废弃，请使用`ModifyYarnQueueV2`来修改队列配置",
445
+ "document": "已废弃，请使用ModifyYarnQueueV2来修改队列配置，近一年无相关日志\n\n修改YARN资源调度的资源配置。已废弃，请使用`ModifyYarnQueueV2`来修改队列配置",
446
446
  "input": "ModifyResourceScheduleConfigRequest",
447
447
  "name": "修改YARN资源调度的资源配置（旧）",
448
448
  "output": "ModifyResourceScheduleConfigResponse",
449
- "status": "online"
449
+ "status": "deprecated"
450
450
  },
451
451
  "ModifyResourceScheduler": {
452
452
  "document": "修改了yarn的资源调度器，点击部署生效。",
@@ -498,11 +498,11 @@
498
498
  "status": "online"
499
499
  },
500
500
  "ModifyYarnDeploy": {
501
- "document": "部署生效。已废弃，请使用`DeployYarnConf`接口进行部署生效",
501
+ "document": "该接口已废弃，请使用DeployYarnConf完成部署生效\n\n部署生效。已废弃，请使用`DeployYarnConf`接口进行部署生效",
502
502
  "input": "ModifyYarnDeployRequest",
503
503
  "name": "部署生效（旧）",
504
504
  "output": "ModifyYarnDeployResponse",
505
- "status": "online"
505
+ "status": "deprecated"
506
506
  },
507
507
  "ModifyYarnQueueV2": {
508
508
  "document": "修改资源调度中队列信息",
tccli/services/ess/v20201111/api.json CHANGED
@@ -2009,7 +2009,7 @@
2009
2009
  "members": [
2010
2010
  {
2011
2011
  "disabled": false,
2012
- "document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
2012
+ "document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
2013
2013
  "example": "SIGN_SEAL",
2014
2014
  "member": "string",
2015
2015
  "name": "ComponentType",
@@ -2141,7 +2141,7 @@
2141
2141
  },
2142
2142
  {
2143
2143
  "disabled": false,
2144
- "document": "\n**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
2144
+ "document": "\n**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、\"仿宋\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
2145
2145
  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
2146
2146
  "member": "string",
2147
2147
  "name": "ComponentExtra",
tccli/services/essbasic/v20210526/api.json CHANGED
@@ -6151,7 +6151,7 @@
6151
6151
  },
6152
6152
  {
6153
6153
  "disabled": false,
6154
- "document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n</ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
6154
+ "document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n</ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
6155
6155
  "example": "SIGN_SEAL",
6156
6156
  "member": "string",
6157
6157
  "name": "ComponentType",
@@ -6272,7 +6272,7 @@
6272
6272
  },
6273
6273
  {
6274
6274
  "disabled": false,
6275
- "document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
6275
+ "document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li>\n<li> <b>FontSize</b>： 范围6 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li>\n<li> <b>OTHER</b> : 其他</li>\n</ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"、仿宋，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
6276
6276
  "example": "ComponentExtra",
6277
6277
  "member": "string",
6278
6278
  "name": "ComponentExtra",
tccli/services/iotexplorer/v20190423/api.json CHANGED
@@ -4022,7 +4022,7 @@
4022
4022
  },
4023
4023
  {
4024
4024
  "disabled": false,
4025
- "document": "加密类型 ，1表示证书认证，2表示秘钥认证，21表示TID认证-SE方式，22表示TID认证-软加固方式",
4025
+ "document": "加密类型 ，1表示证书认证，2表示密钥认证，21表示TID认证-SE方式，22表示TID认证-软加固方式",
4026
4026
  "example": "1",
4027
4027
  "member": "string",
4028
4028
  "name": "EncryptionType",
tccli/services/lighthouse/v20200324/api.json CHANGED
@@ -6261,7 +6261,7 @@
6261
6261
  },
6262
6262
  {
6263
6263
  "disabled": false,
6264
- "document": "应用模板的执行状态。\n\n- SUCCESS：成功\n- FAILED：失败",
6264
+ "document": "应用模板的执行状态。\n\n- SUCCESS：成功\n- RUNNING：运行中\n- FAILED：失败",
6265
6265
  "example": "SUCCESS",
6266
6266
  "member": "string",
6267
6267
  "name": "ApplyState",
tccli/services/lke/v20231130/examples.json CHANGED
@@ -767,7 +767,7 @@
767
767
  "SaveDoc": [
768
768
  {
769
769
  "document": "",
770
- "input": "POST / HTTP/1.1\nHost: lke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SaveDoc\n<公共请求参数>\n\n{\n \"BotBizId\": \"1727231073371148288\",\n \"FileName\": \"测试.docx\",\n \"FileType\": \"docx\",\n \"CosUrl\": \"/corp/23432432/233432/doc/zeSOHIBjwcWoEmlMMXOp-1796022574489010176.docx\",\n \"ETag\": \"\\\"58e88ad7665f11c4f66eba0eada383a5\\\"\",\n \"CosHash\": \"xxxxxxxxx\",\n \"Size\": \"643000\",\n \"Source\": 1,\n \"WebUrl\": \"\",\n \"AttrRange\": 1,\n \"AttrLabels\": [],\n \"ReferUrlType\": 0\n}",
770
+ "input": "POST / HTTP/1.1\nHost: lke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SaveDoc\n<公共请求参数>\n\n{\n \"BotBizId\": \"1727231073371148288\",\n \"FileName\": \"测试.docx\",\n \"FileType\": \"docx\",\n \"CosUrl\": \"/corp/23432432/233432/doc/zeSOHIBjwcWoEmlMMXOp-1796022574489010176.docx\",\n \"ETag\": \"\\\"58e88ad7665f11c4f66eba0eada383a5\\\"\",\n \"CosHash\": \"xxxxxxxxx\",\n \"Size\": \"643000\",\n \"Source\": 0,\n \"WebUrl\": \"\",\n \"AttrRange\": 1,\n \"AttrLabels\": [],\n \"ReferUrlType\": 0\n}",
771
771
  "output": "{\n \"Response\": {\n \"DocBizId\": \"1694921462777761792\",\n \"ErrorMsg\": \"\",\n \"ErrorLink\": \"\",\n \"ErrorLinkText\": \"\",\n \"RequestId\": \"e3338103-3165-49c0-b218-245be865cca5\"\n }\n}",
772
772
  "title": "知识库文档录入"
773
773
  }
tccli/services/lkeap/v20240522/api.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "ChatCompletions": {
4
- "document": "### 接口功能\n\n调用接口，发起一次对话请求。默认该接口下的单账号QPM上限为15000 ，TPM上限为1200000\n如需使用OpenAI兼容接口， 请参考文档：[Deepseek OpenAI对话接口](https://cloud.tencent.com/document/product/1772/115969)\n\n#### 在线体验\n如您希望在网页内直接体验 DeepSeek 模型对话，推荐您前往[腾讯云智能体开发平台](https://cloud.tencent.com/product/lke)，使用[ DeepSeek 联网助手](https://lke.cloud.tencent.com/webim_exp/#/chat/wQrAwR)。\n\n#### 已支持的模型\n- DeepSeek-V3-0324（model 参数值为**deepseek-v3-0324**）\n - DeepSeek-V3-0324为671B参数MoE模型，在编程与技术能力、上下文理解与长文本处理等方面优势突出。\n - 支持128K上下文长度，最大输出16k（不含思维链）。\n - 注意：相比于DeepSeek-V3，DeepSeek-V3-0324仅更新了模型权重，未增加参数量。总模型大小为685B，其中包括671B的主模型权重和 14B 的多令牌预测（MTP）模块权重，后续均描述主模型参数量。\n- DeepSeek-V3（model 参数值为**deepseek-v3**）\n - DeepSeek-V3为671B参数MoE模型，在百科知识、数学推理等多项任务上优势突出，评测成绩在主流榜单中位列开源模型榜首。\n - 支持64K上下文长度，最大输出16k。\n- DeepSeek-R1（model 参数值为**deepseek-r1**）\n - DeepSeek-R1为671B模型，使用强化学习训练，推理过程包含大量反思和验证，思维链长度可达数万字。 该系列模型在数学、代码以及各种复杂逻辑推理任务上推理效果优异，并为用户展现了完整的思考过程。\n - 支持96K上下文长度，最大输入长度64k，最大输出16k（默认4k），最大思维链输出长度32k。\n- DeepSeek-Prover-V2（model 参数值为**deepseek-prover-v2**）\n - DeepSeek-Prover-V2 为671B 参数 MoE 模型，在数学定理证明和复杂计算任务中表现出色。\n - 支持64K上下文长度，最大输出16k。\n\n\n### 计费说明\n\n- 标准计费（2025年2月26日起生效），计费模式为后付费小时结，为保证您账户资源的正常使用，请提前[开通后付费](https://lke.cloud.tencent.com/lke#/app/system/charge/postpaid)并及时[充值](https://console.cloud.tencent.com/expense/recharge)。\n\n - DeepSeek-R1 模型 | 输入：0.004元/千token | 输出（含思维链）：0.016元/千token\n\n - DeepSeek-V3 模型 | 输入：0.002元/千token | 输出：0.008元/千token\n\n - DeepSeek-V3-0324 模型 | 输入：0.002元/千token | 输出：0.008元/千token\n\n - DeepSeek-Prover-V2 模型 | 暂不计费\n\n\n### Openai兼容协议接口\n知识引擎原子能力大模型对话 API 兼容了 OpenAI 的接口规范，这意味着您可以直接使用 OpenAI 官方提供的 SDK 来调用大模型对话接口。您仅需要将 base_url 和 [api_key](https://cloud.tencent.com/document/product/1772/115970) 替换成相关配置，不需要对应用做额外修改，即可无缝将您的应用切换到相应的大模型。请参考文档：[Deepseek OpenAI对话接口](https://cloud.tencent.com/document/product/1772/115969)。\n> base_url： https://api.lkeap.cloud.tencent.com/v1\n\n> api_key的获取请参考[API KEY管理](https://cloud.tencent.com/document/product/1772/115970)\n\n\n### 快速接入\n1. 完成[实名认证](https://console.cloud.tencent.com/developer/auth)。\n2. 主账户前往[控制台](https://console.cloud.tencent.com/lkeap)开通服务。若为子账户，需由主账号在[权限管理](https://console.cloud.tencent.com/cam)中为子账号授权，关联预设策略，策略名称：QcloudLKEAPFullAccess。\n3. 通过API Explorer[在线调试](https://console.cloud.tencent.com/api/explorer?Product=lkeap&Version=2024-05-22&Action=ChatCompletions)。\n4. 使用[官方 SDK ](https://cloud.tencent.com/document/product/1772/115963#SDK)调用本接口（支持Python/Java/PHP/Go/Node.js/.NET等语言）。\n\n-----------\n\n### SDK调用示例\n通过本地代码调用本接口（支持Python/Java/PHP/Go/Node.js/.NET等语言）：下面的代码以 Python 语言为例，展示如何访问腾讯云上的DeepSeek模型API的样例。\n（1）安装环境\n```\npython3 -m pip install --upgrade tencentcloud-sdk-python-common\npython3 -m pip install --upgrade tencentcloud-sdk-python-lkeap\n```\n\n（2）示例代码\n\n- 其中SecretKey和SecretID需要从腾讯云控制台获取\n\n- 参数params中模型Model字段可以选择“deepseek-r1“和“deepseek-v3”\n\n```\n# -*- coding: utf-8 -*-\nimport json\n\nfrom tencentcloud.common.common_client import CommonClient\nfrom tencentcloud.common import credential\nfrom tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException\nfrom tencentcloud.common.profile.client_profile import ClientProfile\nfrom tencentcloud.common.profile.http_profile import HttpProfile\n\nclass NonStreamResponse(object):\n def __init__(self):\n self.response = \"\"\n\n def _deserialize(self, obj):\n self.response = json.dumps(obj)\n\ntry:\n # 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密\n # 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305\n # 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取\n cred = credential.Credential(\"\", \"\")\n\n httpProfile = HttpProfile()\n httpProfile.endpoint = \"lkeap.tencentcloudapi.com\"\n httpProfile.reqTimeout = 40000 # 流式接口可能耗时较长\n clientProfile = ClientProfile()\n clientProfile.httpProfile = httpProfile\n\n params = \"{\\\"Model\\\":\\\"deepseek-r1\\\",\\\"Messages\\\":[{\\\"Role\\\":\\\"user\\\",\\\"Content\\\":\\\"你好\\\"}],\\\"Stream\\\":true}\";\n common_client = CommonClient(\"lkeap\", \"2024-05-22\", cred, \"ap-guangzhou\", profile=clientProfile)\n resp = common_client._call_and_deserialize(\"ChatCompletions\", json.loads(params), NonStreamResponse)\n if isinstance(resp, NonStreamResponse): # 非流式响应\n print(resp.response)\n else: # 流式响应\n for event in resp:\n print(event)\nexcept TencentCloudSDKException as err:\n print(err)\n\n```\n\n**DeepSeek-R1使用建议**\n\n1. 将温度设置在 0.5-0.7 范围内（建议为0.6），以防止无休止的重复或不连贯的输出。\n2. 避免添加system prompt，所有说明都应包含在user prompt中。",
4
+ "document": "### 接口功能\n\n调用接口，发起一次对话请求。默认该接口下的单账号QPM上限为15000 ，TPM上限为1200000\n如需使用OpenAI兼容接口， 请参考文档：[Deepseek OpenAI对话接口](https://cloud.tencent.com/document/product/1772/115969)\n\n#### 在线体验\n如您希望在网页内直接体验 DeepSeek 模型对话，推荐您前往[腾讯云智能体开发平台](https://cloud.tencent.com/product/lke)，使用[ DeepSeek 联网助手](https://lke.cloud.tencent.com/webim_exp/#/chat/wQrAwR)。\n\n#### 已支持的模型\n- DeepSeek-V3-0324（model 参数值为**deepseek-v3-0324**）\n - DeepSeek-V3-0324为671B参数MoE模型，在编程与技术能力、上下文理解与长文本处理等方面优势突出。\n - 支持128K上下文长度，最大输出16k（不含思维链）。\n - 注意：相比于DeepSeek-V3，DeepSeek-V3-0324仅更新了模型权重，未增加参数量。总模型大小为685B，其中包括671B的主模型权重和 14B 的多令牌预测（MTP）模块权重，后续均描述主模型参数量。\n- DeepSeek-V3（model 参数值为**deepseek-v3**）\n - DeepSeek-V3为671B参数MoE模型，在百科知识、数学推理等多项任务上优势突出，评测成绩在主流榜单中位列开源模型榜首。\n - 支持64K上下文长度，最大输出16k。\n- DeepSeek-R1（model 参数值为**deepseek-r1**）\n - DeepSeek-R1为671B模型，使用强化学习训练，推理过程包含大量反思和验证，思维链长度可达数万字。 该系列模型在数学、代码以及各种复杂逻辑推理任务上推理效果优异，并为用户展现了完整的思考过程。\n - 支持96K上下文长度，最大输入长度64k，最大输出16k（默认4k），最大思维链输出长度32k。\n- DeepSeek-R1-0528（model 参数值为**deepseek-r1-0528**）\n - DeepSeek-R1-0528为671B 模型，架构优化与训练策略升级后，相比上一版本在代码生成、长文本处理和复杂推理领域提升明显。\n - 支持96K上下文长度，最大输入长度64k，最大输出16k（默认4k），最大思维链输出长度32k。\n- DeepSeek-Prover-V2（model 参数值为**deepseek-prover-v2**）\n - DeepSeek-Prover-V2 为671B 参数 MoE 模型，在数学定理证明和复杂计算任务中表现出色。\n - 支持64K上下文长度，最大输出16k。\n\n\n### 计费说明\n\n- 标准计费（2025年2月26日起生效），计费模式为后付费小时结，为保证您账户资源的正常使用，请提前[开通后付费](https://lke.cloud.tencent.com/lke#/app/system/charge/postpaid)并及时[充值](https://console.cloud.tencent.com/expense/recharge)。\n\n - DeepSeek-R1 模型 | 输入：0.004元/千token | 输出（含思维链）：0.016元/千token\n\n - DeepSeek-R1-0528 模型 | 输入：0.004元/千token | 输出（含思维链）：0.016元/千token\n\n - DeepSeek-V3 模型 | 输入：0.002元/千token | 输出：0.008元/千token\n\n - DeepSeek-V3-0324 模型 | 输入：0.002元/千token | 输出：0.008元/千token\n\n - DeepSeek-Prover-V2 模型 | 暂不计费\n\n\n### Openai兼容协议接口\n知识引擎原子能力大模型对话 API 兼容了 OpenAI 的接口规范，这意味着您可以直接使用 OpenAI 官方提供的 SDK 来调用大模型对话接口。您仅需要将 base_url 和 [api_key](https://cloud.tencent.com/document/product/1772/115970) 替换成相关配置，不需要对应用做额外修改，即可无缝将您的应用切换到相应的大模型。请参考文档：[Deepseek OpenAI对话接口](https://cloud.tencent.com/document/product/1772/115969)。\n> base_url： https://api.lkeap.cloud.tencent.com/v1\n\n> api_key的获取请参考[API KEY管理](https://cloud.tencent.com/document/product/1772/115970)\n\n\n### 快速接入\n1. 完成[实名认证](https://console.cloud.tencent.com/developer/auth)。\n2. 主账户前往[控制台](https://console.cloud.tencent.com/lkeap)开通服务。若为子账户，需由主账号在[权限管理](https://console.cloud.tencent.com/cam)中为子账号授权，关联预设策略，策略名称：QcloudLKEAPFullAccess。\n3. 通过API Explorer[在线调试](https://console.cloud.tencent.com/api/explorer?Product=lkeap&Version=2024-05-22&Action=ChatCompletions)。\n4. 使用[官方 SDK ](https://cloud.tencent.com/document/product/1772/115963#SDK)调用本接口（支持Python/Java/PHP/Go/Node.js/.NET等语言）。\n\n-----------\n\n### SDK调用示例\n通过本地代码调用本接口（支持Python/Java/PHP/Go/Node.js/.NET等语言）：下面的代码以 Python 语言为例，展示如何访问腾讯云上的DeepSeek模型API的样例。\n（1）安装环境\n```\npython3 -m pip install --upgrade tencentcloud-sdk-python-common\npython3 -m pip install --upgrade tencentcloud-sdk-python-lkeap\n```\n\n（2）示例代码\n\n- 其中SecretKey和SecretID需要从腾讯云控制台获取\n\n- 参数params中模型Model字段可以选择“deepseek-r1“和“deepseek-v3”\n\n```\n# -*- coding: utf-8 -*-\nimport json\n\nfrom tencentcloud.common.common_client import CommonClient\nfrom tencentcloud.common import credential\nfrom tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException\nfrom tencentcloud.common.profile.client_profile import ClientProfile\nfrom tencentcloud.common.profile.http_profile import HttpProfile\n\nclass NonStreamResponse(object):\n def __init__(self):\n self.response = \"\"\n\n def _deserialize(self, obj):\n self.response = json.dumps(obj)\n\ntry:\n # 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密\n # 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305\n # 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取\n cred = credential.Credential(\"\", \"\")\n\n httpProfile = HttpProfile()\n httpProfile.endpoint = \"lkeap.tencentcloudapi.com\"\n httpProfile.reqTimeout = 40000 # 流式接口可能耗时较长\n clientProfile = ClientProfile()\n clientProfile.httpProfile = httpProfile\n\n params = \"{\\\"Model\\\":\\\"deepseek-r1\\\",\\\"Messages\\\":[{\\\"Role\\\":\\\"user\\\",\\\"Content\\\":\\\"你好\\\"}],\\\"Stream\\\":true}\";\n common_client = CommonClient(\"lkeap\", \"2024-05-22\", cred, \"ap-guangzhou\", profile=clientProfile)\n resp = common_client._call_and_deserialize(\"ChatCompletions\", json.loads(params), NonStreamResponse)\n if isinstance(resp, NonStreamResponse): # 非流式响应\n print(resp.response)\n else: # 流式响应\n for event in resp:\n print(event)\nexcept TencentCloudSDKException as err:\n print(err)\n\n```\n\n**DeepSeek-R1使用建议**\n\n1. 将温度设置在 0.5-0.7 范围内（建议为0.6），以防止无休止的重复或不连贯的输出。\n2. 避免添加system prompt，所有说明都应包含在user prompt中。",
5
5
  "input": "ChatCompletionsRequest",
6
6
  "name": "DeepSeek API 接口",
7
7
  "output": "ChatCompletionsResponse",
tccli/services/monitor/v20180724/api.json CHANGED
@@ -2315,9 +2315,10 @@
2315
2315
  {
2316
2316
  "disabled": false,
2317
2317
  "document": "告警触发条件的判断方式. 0: 任意; 1: 全部; 2: 复合. 当取值为2的时候为复合告警，与参数 ComplexExpression 配合使用.\n注意：此字段可能返回 null，表示取不到有效值。",
2318
- "example": "无",
2318
+ "example": "0",
2319
2319
  "member": "int64",
2320
2320
  "name": "IsUnionRule",
2321
+ "output_required": true,
2321
2322
  "required": true,
2322
2323
  "type": "int",
2323
2324
  "value_allowed_null": true
@@ -2325,9 +2326,10 @@
2325
2326
  {
2326
2327
  "disabled": false,
2327
2328
  "document": "告警触发条件列表\n注意：此字段可能返回 null，表示取不到有效值。",
2328
- "example": "无",
2329
+ "example": "[{\"MetricName\": \"CpuUsage\", \"Period\": 60, \"Operator\": \"gt\", \"Value\": 60}]",
2329
2330
  "member": "AlarmPolicyRule",
2330
2331
  "name": "Rules",
2332
+ "output_required": true,
2331
2333
  "required": true,
2332
2334
  "type": "list",
2333
2335
  "value_allowed_null": true
@@ -2338,6 +2340,7 @@
2338
2340
  "example": "(1 OR 2) AND (3 OR 4)",
2339
2341
  "member": "string",
2340
2342
  "name": "ComplexExpression",
2343
+ "output_required": true,
2341
2344
  "required": false,
2342
2345
  "type": "string",
2343
2346
  "value_allowed_null": true
tccli/services/monitor/v20180724/examples.json CHANGED
@@ -577,7 +577,7 @@
577
577
  },
578
578
  {
579
579
  "document": "按照实例过滤策略，需要填入监控类型、策略类型、实例的维度信息。我们以搜索两个云服务器为例，假设他们的实例 ID 分别为 `ins-qr8d555g`, `ins-qr8d555h`。\n\nMonitorTypes 指定为 `MT_QCE`\n\nNamespaces 指定为 `cvm_device`\n\nDimensions 的 JSON 字符串为\n\n```\n[\n {\n \"Dimensions\": {\n \"unInstanceId\": \"ins-qr8d555g\"\n }\n },\n {\n \"Dimensions\": {\n \"unInstanceId\": \"ins-qr8d555h\"\n }\n }\n]\n```\n\n不同云产品参数示例详见 [维度信息Dimensions列表](https://cloud.tencent.com/document/product/248/50397)",
580
- "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAlarmPolicies\n<公共请求参数>\n\n{\n \"Module\": \"monitor\",\n \"PageSize\": 10,\n \"PageNumber\": 1,\n \"MonitorTypes\": [\n \"MT_QCE\"\n ],\n \"Namespaces\": [\n \"cvm_device\"\n ],\n \"Dimensions\": \"[{\\\"Dimensions\\\": { \\\"unInstanceId\\\": \\\"ins-qr8d555g\\\"}},{ \\\"Dimensions\\\": { \\\"unInstanceId\\\": \\\"ins-qr8d555h\\\"}}]\"\n}",
580
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAlarmPolicies\n<公共请求参数>\n\n{\n \"Module\": \"monitor\",\n \"PageSize\": 10,\n \"PageNumber\": 1,\n \"MonitorTypes\": [\n \"MT_QCE\"\n ],\n \"Namespaces\": [\n \"cvm_device\"\n ],\n \"Dimensions\": \"[[{\\\"name\\\":\\\"unInstanceId\\\",\\\"value\\\":\\\"ins-qr8d555g\\\"}],[{\\\"name\\\":\\\"unInstanceId\\\",\\\"value\\\":\\\"ins-qr8d555g\\\"}]]\"\n}",
581
581
  "output": "{\n \"Response\": {\n \"Policies\": [\n {\n \"AdvancedMetricNumber\": 0,\n \"CanSetDefault\": 1,\n \"Condition\": {\n \"ComplexExpression\": \"\",\n \"IsUnionRule\": 0,\n \"Rules\": [\n {\n \"ContinuePeriod\": 1,\n \"Description\": \"CPU利用率\",\n \"Filter\": {\n \"Dimensions\": \"\",\n \"Type\": \"\"\n },\n \"HierarchicalValue\": {\n \"Remind\": \"\",\n \"Serious\": \"\",\n \"Warn\": \"\"\n },\n \"IsAdvanced\": 0,\n \"IsLatenessMetric\": 0,\n \"IsOpen\": 1,\n \"IsPowerNotice\": 0,\n \"MetricName\": \"CpuUsage\",\n \"NoticeFrequency\": 300,\n \"Operator\": \"gt\",\n \"Period\": 60,\n \"ProductId\": \"\",\n \"RuleType\": \"STATIC\",\n \"Unit\": \"%\",\n \"Value\": \"1\",\n \"ValueMax\": 100,\n \"ValueMin\": 0\n },\n {\n \"ContinuePeriod\": 1,\n \"Description\": \"外网出带宽使用率\",\n \"Filter\": {\n \"Dimensions\": \"\",\n \"Type\": \"\"\n },\n \"HierarchicalValue\": {\n \"Remind\": \"\",\n \"Serious\": \"\",\n \"Warn\": \"\"\n },\n \"IsAdvanced\": 0,\n \"IsLatenessMetric\": 0,\n \"IsOpen\": 1,\n \"IsPowerNotice\": 0,\n \"MetricName\": \"Outratio\",\n \"NoticeFrequency\": 300,\n \"Operator\": \"gt\",\n \"Period\": 60,\n \"ProductId\": \"\",\n \"RuleType\": \"STATIC\",\n \"Unit\": \"%\",\n \"Value\": \"1\",\n \"ValueMax\": 100,\n \"ValueMin\": 0\n },\n {\n \"ContinuePeriod\": 1,\n \"Description\": \"内存利用率\",\n \"Filter\": {\n \"Dimensions\": \"\",\n \"Type\": \"\"\n },\n \"HierarchicalValue\": {\n \"Remind\": \"\",\n \"Serious\": \"\",\n \"Warn\": \"\"\n },\n \"IsAdvanced\": 0,\n \"IsLatenessMetric\": 0,\n \"IsOpen\": 1,\n \"IsPowerNotice\": 0,\n \"MetricName\": \"MemUsage\",\n \"NoticeFrequency\": 300,\n \"Operator\": \"gt\",\n \"Period\": 60,\n \"ProductId\": \"\",\n \"RuleType\": \"STATIC\",\n \"Unit\": \"%\",\n \"Value\": \"1\",\n \"ValueMax\": 100,\n \"ValueMin\": 0\n },\n {\n \"ContinuePeriod\": 1,\n \"Description\": \"磁盘利用率\",\n \"Filter\": {\n \"Dimensions\": \"\",\n \"Type\": \"\"\n },\n \"HierarchicalValue\": {\n \"Remind\": \"\",\n \"Serious\": \"\",\n \"Warn\": \"\"\n },\n \"IsAdvanced\": 0,\n \"IsLatenessMetric\": 0,\n \"IsOpen\": 1,\n \"IsPowerNotice\": 0,\n \"MetricName\": \"CvmDiskUsage\",\n \"NoticeFrequency\": 300,\n \"Operator\": \"gt\",\n \"Period\": 60,\n \"ProductId\": \"\",\n \"RuleType\": \"STATIC\",\n \"Unit\": \"%\",\n \"Value\": \"1\",\n \"ValueMax\": 100,\n \"ValueMin\": 0\n },\n {\n \"ContinuePeriod\": 1,\n \"Description\": \"基础CPU利用率\",\n \"Filter\": {\n \"Dimensions\": \"\",\n \"Type\": \"\"\n },\n \"HierarchicalValue\": {\n \"Remind\": \"\",\n \"Serious\": \"\",\n \"Warn\": \"\"\n },\n \"IsAdvanced\": 0,\n \"IsLatenessMetric\": 0,\n \"IsOpen\": 1,\n \"IsPowerNotice\": 0,\n \"MetricName\": \"BaseCpuUsage\",\n \"NoticeFrequency\": 300,\n \"Operator\": \"gt\",\n \"Period\": 60,\n \"ProductId\": \"\",\n \"RuleType\": \"STATIC\",\n \"Unit\": \"%\",\n \"Value\": \"0\",\n \"ValueMax\": 100,\n \"ValueMin\": 0\n }\n ]\n },\n \"ConditionTemplateId\": \"\",\n \"ConditionsTemp\": {\n \"Condition\": null,\n \"EventCondition\": null,\n \"TemplateName\": \"\"\n },\n \"Enable\": 0,\n \"EventCondition\": {\n \"Rules\": [\n {\n \"ContinuePeriod\": 0,\n \"Description\": \"机器重启\",\n \"Filter\": null,\n \"HierarchicalValue\": null,\n \"IsAdvanced\": 0,\n \"IsLatenessMetric\": 0,\n \"IsOpen\": 0,\n \"IsPowerNotice\": 0,\n \"MetricName\": \"cvm:ErrorEvent:GuestReboot\",\n \"NoticeFrequency\": 0,\n \"Operator\": \"\",\n \"Period\": 0,\n \"ProductId\": \"\",\n \"RuleType\": \"\",\n \"Unit\": \"\",\n \"Value\": \"\",\n \"ValueMax\": null,\n \"ValueMin\": null\n }\n ]\n },\n \"Filter\": null,\n \"FilterDimensionsParam\": \"\",\n \"GroupBy\": null,\n \"HierarchicalNotices\": [\n {\n \"Classification\": [\n \"\"\n ],\n \"NoticeId\": \"notice-lnrxepp7\",\n \"PolicyId\": \"policy-s5yso1am\"\n },\n {\n \"Classification\": [\n \"\"\n ],\n \"NoticeId\": \"notice-lzpys7tu\",\n \"PolicyId\": \"policy-s5yso1am\"\n }\n ],\n \"InsertTime\": 1739863161,\n \"InstanceGroupId\": 0,\n \"InstanceGroupName\": \"\",\n \"InstanceSum\": 0,\n \"IsBindAll\": 0,\n \"IsDefault\": 0,\n \"IsOneClick\": 0,\n \"IsSupportAlarmTag\": 1,\n \"LastEditUin\": \"700000233161\",\n \"MonitorType\": \"MT_QCE\",\n \"Namespace\": \"cvm_device\",\n \"NamespaceShowName\": \"云服务器-基础监控\",\n \"NoticeContentTmplBindInfos\": null,\n \"NoticeIds\": [\n \"notice-lnrxepp7\",\n \"notice-lzpys7tu\"\n ],\n \"Notices\": [\n {\n \"AMPConsumerId\": \"\",\n \"CLSNotices\": [],\n \"Id\": \"notice-lnrxepp7\",\n \"IsPreset\": 1,\n \"Name\": \"系统预设通知模板\",\n \"NoticeLanguage\": \"zh-CN\",\n \"NoticeType\": \"ALL\",\n \"PolicyIds\": null,\n \"Tags\": null,\n \"URLNotices\": [],\n \"UpdatedAt\": \"2020-11-13 17:02:44\",\n \"UpdatedBy\": \"1500000685\",\n \"UserNotices\": [\n {\n \"EndTime\": 86399,\n \"GroupIds\": [],\n \"NeedPhoneArriveNotice\": 0,\n \"NoticeWay\": [\n \"SMS\",\n \"EMAIL\"\n ],\n \"OnCallFormIDs\": [\n \"\"\n ],\n \"PhoneCircleInterval\": 0,\n \"PhoneCircleTimes\": 0,\n \"PhoneInnerInterval\": 0,\n \"PhoneOrder\": [],\n \"ReceiverType\": \"USER\",\n \"StartTime\": 0,\n \"UserIds\": [\n 1000909\n ],\n \"Weekday\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7\n ]\n }\n ]\n },\n {\n \"AMPConsumerId\": \"\",\n \"CLSNotices\": [],\n \"Id\": \"notice-lzpys7tu\",\n \"IsPreset\": 0,\n \"Name\": \"Eric-告警回调\",\n \"NoticeLanguage\": \"zh-CN\",\n \"NoticeType\": \"ALL\",\n \"PolicyIds\": null,\n \"Tags\": null,\n \"URLNotices\": [\n {\n \"EndTime\": 86399,\n \"IsValid\": 0,\n \"StartTime\": 0,\n \"URL\": \"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=47483435-2b48-4706-b76e-ac56e98be374\",\n \"ValidationCode\": \"\",\n \"Weekday\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7\n ]\n },\n {\n \"EndTime\": 86399,\n \"IsValid\": 0,\n \"StartTime\": 0,\n \"URL\": \"http://123.com\",\n \"ValidationCode\": \"\",\n \"Weekday\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7\n ]\n }\n ],\n \"UpdatedAt\": \"2023-05-08 20:47:39\",\n \"UpdatedBy\": \"700000233161\",\n \"UserNotices\": []\n }\n ],\n \"OneClickStatus\": 0,\n \"OriginId\": \"2963911\",\n \"PolicyId\": \"policy-s5yso1am\",\n \"PolicyName\": \"Eric-新增收敛测试\",\n \"ProjectId\": 0,\n \"ProjectName\": \"默认项目\",\n \"Region\": [\n \"bj\",\n \"bjjr\",\n \"cd\",\n \"cgoec\",\n \"cq\",\n \"csec\",\n \"de\",\n \"fzec\",\n \"gz\",\n \"gzopen\",\n \"gzwxzf\",\n \"hfeec\",\n \"hk\",\n \"hzec\",\n \"in\",\n \"jkt\",\n \"jnec\",\n \"jp\",\n \"kr\",\n \"nj\",\n \"qy\",\n \"qyxa\",\n \"sao\",\n \"sg\",\n \"sh\",\n \"shadc\",\n \"sheec\",\n \"shhqcft\",\n \"shjr\",\n \"shwxzf\",\n \"sjwec\",\n \"szjr\",\n \"szjxcft\",\n \"szsycft\",\n \"szx\",\n \"th\",\n \"tpe\",\n \"tsn\",\n \"use\",\n \"usw\",\n \"whec\",\n \"xbec\",\n \"xiyec\"\n ],\n \"Remark\": \"\",\n \"RuleType\": \"STATIC\",\n \"TagInstances\": [],\n \"TagOperation\": \"\",\n \"Tags\": [],\n \"TriggerTasks\": [],\n \"UpdateTime\": 1741072433,\n \"UseSum\": 4\n }\n ],\n \"RequestId\": \"cd403f27-3cea-4565-8856-36907e07a026\",\n \"TotalCount\": 216\n }\n}",
582
582
  "title": "搜索一个云服务器绑定的告警策略"
583
583
  }
tccli/services/mqtt/mqtt_client.py CHANGED
@@ -1161,7 +1161,7 @@ def doActivateCaCertificate(args, parsed_globals):
1161
1161
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1162
1162
 
1163
1163
 
1164
- def doCreateTopic(args, parsed_globals):
1164
+ def doDescribeMessageByTopic(args, parsed_globals):
1165
1165
  g_param = parse_global_arg(parsed_globals)
1166
1166
 
1167
1167
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -1190,11 +1190,11 @@ def doCreateTopic(args, parsed_globals):
1190
1190
  client = mod.MqttClient(cred, g_param[OptionsDefine.Region], profile)
1191
1191
  client._sdkVersion += ("_CLI_" + __version__)
1192
1192
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
1193
- model = models.CreateTopicRequest()
1193
+ model = models.DescribeMessageByTopicRequest()
1194
1194
  model.from_json_string(json.dumps(args))
1195
1195
  start_time = time.time()
1196
1196
  while True:
1197
- rsp = client.CreateTopic(model)
1197
+ rsp = client.DescribeMessageByTopic(model)
1198
1198
  result = rsp.to_json_string()
1199
1199
  try:
1200
1200
  json_obj = json.loads(result)
@@ -1993,6 +1993,58 @@ def doDescribeInstanceList(args, parsed_globals):
1993
1993
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1994
1994
 
1995
1995
 
1996
+ def doCreateTopic(args, parsed_globals):
1997
+ g_param = parse_global_arg(parsed_globals)
1998
+
1999
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
2000
+ cred = credential.CVMRoleCredential()
2001
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
2002
+ cred = credential.STSAssumeRoleCredential(
2003
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
2004
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
2005
+ )
2006
+ 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):
2007
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
2008
+ else:
2009
+ cred = credential.Credential(
2010
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
2011
+ )
2012
+ http_profile = HttpProfile(
2013
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
2014
+ reqMethod="POST",
2015
+ endpoint=g_param[OptionsDefine.Endpoint],
2016
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
2017
+ )
2018
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
2019
+ if g_param[OptionsDefine.Language]:
2020
+ profile.language = g_param[OptionsDefine.Language]
2021
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
2022
+ client = mod.MqttClient(cred, g_param[OptionsDefine.Region], profile)
2023
+ client._sdkVersion += ("_CLI_" + __version__)
2024
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
2025
+ model = models.CreateTopicRequest()
2026
+ model.from_json_string(json.dumps(args))
2027
+ start_time = time.time()
2028
+ while True:
2029
+ rsp = client.CreateTopic(model)
2030
+ result = rsp.to_json_string()
2031
+ try:
2032
+ json_obj = json.loads(result)
2033
+ except TypeError as e:
2034
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
2035
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
2036
+ break
2037
+ cur_time = time.time()
2038
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
2039
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
2040
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
2041
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
2042
+ else:
2043
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
2044
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
2045
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
2046
+
2047
+
1996
2048
  def doModifyAuthorizationPolicy(args, parsed_globals):
1997
2049
  g_param = parse_global_arg(parsed_globals)
1998
2050
 
@@ -2754,7 +2806,7 @@ ACTION_MAP = {
2754
2806
  "DescribeProductSKUList": doDescribeProductSKUList,
2755
2807
  "DescribeCaCertificates": doDescribeCaCertificates,
2756
2808
  "ActivateCaCertificate": doActivateCaCertificate,
2757
- "CreateTopic": doCreateTopic,
2809
+ "DescribeMessageByTopic": doDescribeMessageByTopic,
2758
2810
  "DeleteDeviceCertificate": doDeleteDeviceCertificate,
2759
2811
  "ApplyRegistrationCode": doApplyRegistrationCode,
2760
2812
  "ModifyJWKSAuthenticator": doModifyJWKSAuthenticator,
@@ -2770,6 +2822,7 @@ ACTION_MAP = {
2770
2822
  "CreateJWKSAuthenticator": doCreateJWKSAuthenticator,
2771
2823
  "ModifyUser": doModifyUser,
2772
2824
  "DescribeInstanceList": doDescribeInstanceList,
2825
+ "CreateTopic": doCreateTopic,
2773
2826
  "ModifyAuthorizationPolicy": doModifyAuthorizationPolicy,
2774
2827
  "DeleteAuthorizationPolicy": doDeleteAuthorizationPolicy,
2775
2828
  "ModifyHttpAuthenticator": doModifyHttpAuthenticator,