tccli 3.0.1137.1__py2.py3-none-any.whl → 3.0.1139.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 +1 -1
- tccli/command.py +1 -1
- tccli/help_command.py +1 -1
- tccli/services/__init__.py +3 -0
- tccli/services/aiart/aiart_client.py +53 -0
- tccli/services/aiart/v20221229/api.json +98 -0
- tccli/services/aiart/v20221229/examples.json +8 -0
- tccli/services/asr/v20190614/api.json +9 -0
- tccli/services/cbs/v20170312/api.json +5 -8
- tccli/services/cdwch/v20200915/api.json +1 -1
- tccli/services/ckafka/v20190819/api.json +25 -25
- tccli/services/ckafka/v20190819/examples.json +18 -18
- tccli/services/cls/v20201016/api.json +44 -5
- tccli/services/cls/v20201016/examples.json +1 -1
- tccli/services/cwp/cwp_client.py +61 -114
- tccli/services/cwp/v20180228/api.json +0 -70
- tccli/services/cwp/v20180228/examples.json +0 -8
- tccli/services/domain/v20180808/api.json +36 -0
- tccli/services/emr/v20190103/api.json +534 -15
- tccli/services/emr/v20190103/examples.json +4 -4
- tccli/services/ess/v20201111/api.json +4 -4
- tccli/services/ess/v20201111/examples.json +2 -2
- tccli/services/essbasic/v20210526/api.json +3 -3
- tccli/services/essbasic/v20210526/examples.json +2 -2
- tccli/services/ims/v20201229/api.json +2 -2
- tccli/services/ioa/v20220601/api.json +132 -92
- tccli/services/iotexplorer/v20190423/api.json +11 -0
- tccli/services/mps/v20190612/api.json +163 -115
- tccli/services/mps/v20190612/examples.json +11 -11
- tccli/services/ocr/v20181119/api.json +19 -0
- tccli/services/redis/v20180412/api.json +23 -23
- tccli/services/rum/v20210622/api.json +1 -0
- tccli/services/scf/v20180416/examples.json +1 -1
- tccli/services/ssl/ssl_client.py +53 -0
- tccli/services/ssl/v20191205/api.json +251 -5
- tccli/services/ssl/v20191205/examples.json +9 -1
- tccli/services/tdmq/v20200217/api.json +171 -22
- tccli/services/tdmq/v20200217/examples.json +6 -6
- tccli/services/thpc/v20230321/api.json +42 -21
- tccli/services/tke/v20180525/api.json +149 -71
- tccli/services/tke/v20180525/examples.json +69 -57
- tccli/services/trtc/v20190722/api.json +1 -1
- tccli/services/tsf/v20180326/api.json +1 -1
- tccli/services/vclm/__init__.py +4 -0
- tccli/services/vclm/v20240523/api.json +695 -0
- tccli/services/vclm/v20240523/examples.json +73 -0
- tccli/services/vclm/vclm_client.py +513 -0
- tccli/services/vdb/v20230616/api.json +20 -0
- {tccli-3.0.1137.1.dist-info → tccli-3.0.1139.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1137.1.dist-info → tccli-3.0.1139.1.dist-info}/RECORD +53 -49
- {tccli-3.0.1137.1.dist-info → tccli-3.0.1139.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1137.1.dist-info → tccli-3.0.1139.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1137.1.dist-info → tccli-3.0.1139.1.dist-info}/license_files/LICENSE +0 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
"AddMetricScaleStrategy": [
|
4
4
|
{
|
5
5
|
"document": "",
|
6
|
-
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddMetricScaleStrategy\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"StrategyType\": 0,\n \"TimeAutoScaleStrategy\": {\n \"StrategyId\": 1,\n \"StrategyName\": \"abc\",\n \"IntervalTime\": 1,\n \"ScaleAction\": 1,\n \"ScaleNum\": 1,\n \"StrategyStatus\": 1,\n \"Priority\": 1,\n \"RetryValidTime\": 1,\n \"RepeatStrategy\": {\n \"RepeatType\": \"abc\",\n \"DayRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"Step\": 1\n },\n \"WeekRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfWeek\": [\n 1\n ]\n },\n \"MonthRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfMonthRange\": [\n 1\n ]\n },\n \"NotRepeat\": {\n \"ExecuteAt\": \"abc\"\n },\n \"Expire\": \"abc\"\n },\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"TerminatePolicy\": \"abc\",\n \"MaxUse\": 0,\n \"SoftDeployInfo\": [\n 0\n ],\n \"ServiceNodeInfo\": [\n 0\n ],\n \"CompensateFlag\": 0,\n \"GroupId\": 0\n }\n}",
|
6
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddMetricScaleStrategy\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"StrategyType\": 0,\n \"LoadAutoScaleStrategy\": {\n \"StrategyId\": 0,\n \"StrategyName\": \"abc\",\n \"CalmDownTime\": 0,\n \"ScaleAction\": 0,\n \"ScaleNum\": 0,\n \"LoadMetrics\": \"abc\",\n \"MetricId\": 0,\n \"StatisticPeriod\": 0,\n \"ProcessMethod\": 0,\n \"TriggerThreshold\": 0,\n \"TriggerConditions\": {\n \"Conditions\": [\n {\n \"CompareMethod\": 0,\n \"Threshold\": 0\n }\n ]\n },\n \"Priority\": 0,\n \"StrategyStatus\": 0,\n \"YarnNodeLabel\": \"abc\",\n \"PeriodValid\": \"abc\",\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"LoadMetricsConditions\": {\n \"LoadMetrics\": [\n {\n \"StatisticPeriod\": 0,\n \"TriggerThreshold\": 0,\n \"LoadMetrics\": \"abc\",\n \"MetricId\": 0,\n \"Conditions\": [\n {\n \"CompareMethod\": 0,\n \"Threshold\": 0\n }\n ]\n }\n ]\n }\n },\n \"TimeAutoScaleStrategy\": {\n \"StrategyId\": 1,\n \"StrategyName\": \"abc\",\n \"IntervalTime\": 1,\n \"ScaleAction\": 1,\n \"ScaleNum\": 1,\n \"StrategyStatus\": 1,\n \"Priority\": 1,\n \"RetryValidTime\": 1,\n \"RepeatStrategy\": {\n \"RepeatType\": \"abc\",\n \"DayRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"Step\": 1\n },\n \"WeekRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfWeek\": [\n 1\n ]\n },\n \"MonthRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfMonthRange\": [\n 1\n ]\n },\n \"NotRepeat\": {\n \"ExecuteAt\": \"abc\"\n },\n \"Expire\": \"abc\"\n },\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"TerminatePolicy\": \"abc\",\n \"MaxUse\": 0,\n \"SoftDeployInfo\": [\n 0\n ],\n \"ServiceNodeInfo\": [\n 0\n ],\n \"CompensateFlag\": 0,\n \"GroupId\": 0\n }\n}",
|
7
7
|
"output": "{\n \"Response\": {\n \"RequestId\": \"41ac1575-64fa-4e23-b6df-6c1f509dd528\"\n }\n}",
|
8
8
|
"title": "添加扩缩容规则成功示例"
|
9
9
|
}
|
@@ -52,7 +52,7 @@
|
|
52
52
|
{
|
53
53
|
"document": "",
|
54
54
|
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAutoScaleGroupGlobalConf\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}",
|
55
|
-
"output": "{\n \"Response\": {\n \"GroupGlobalConfs\": [\n {\n \"GroupGlobalConf\": {\n \"Id\": 0,\n \"ClusterId\": 0,\n \"ScaleLowerBound\": 0,\n \"ScaleUpperBound\": 0,\n \"StrategyType\": 0,\n \"NextTimeCanScale\": 1,\n \"GraceDownFlag\": true\n },\n \"CurrentNodes\": 0,\n \"CurrentPostPaidNodes\": 0,\n \"CurrentSpotPaidNodes\": 0\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}",
|
55
|
+
"output": "{\n \"Response\": {\n \"GroupGlobalConfs\": [\n {\n \"GroupGlobalConf\": {\n \"Id\": 0,\n \"ClusterId\": 0,\n \"ScaleLowerBound\": 0,\n \"ScaleUpperBound\": 0,\n \"StrategyType\": 0,\n \"NextTimeCanScale\": 1,\n \"GraceDownFlag\": true,\n \"HardwareType\": \"abc\",\n \"PayMode\": \"abc\",\n \"PostPayPercentMin\": 0,\n \"ChangeToPod\": 0,\n \"GroupName\": \"abc\",\n \"YarnNodeLabel\": \"abc\",\n \"GroupStatus\": 0\n },\n \"CurrentNodes\": 0,\n \"CurrentPostPaidNodes\": 0,\n \"CurrentSpotPaidNodes\": 0\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}",
|
56
56
|
"title": "获取伸缩组全局配置"
|
57
57
|
}
|
58
58
|
],
|
@@ -68,7 +68,7 @@
|
|
68
68
|
{
|
69
69
|
"document": "",
|
70
70
|
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAutoScaleStrategies\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"GroupId\": 0\n}",
|
71
|
-
"output": "{\n \"Response\": {\n \"TimeBasedAutoScaleStrategies\": [\n {\n \"StrategyId\": 1,\n \"StrategyName\": \"abc\",\n \"IntervalTime\": 1,\n \"ScaleAction\": 1,\n \"ScaleNum\": 1,\n \"StrategyStatus\": 1,\n \"Priority\": 1,\n \"RetryValidTime\": 1,\n \"RepeatStrategy\": {\n \"RepeatType\": \"abc\",\n \"DayRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"Step\": 1\n },\n \"WeekRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfWeek\": [\n 1\n ]\n },\n \"MonthRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfMonthRange\": [\n 1\n ]\n },\n \"NotRepeat\": {\n \"ExecuteAt\": \"abc\"\n },\n \"Expire\": \"abc\"\n },\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"TerminatePolicy\": \"abc\",\n \"MaxUse\": 0,\n \"SoftDeployInfo\": [\n 0\n ],\n \"ServiceNodeInfo\": [\n 0\n ],\n \"CompensateFlag\": 0,\n \"GroupId\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
71
|
+
"output": "{\n \"Response\": {\n \"LoadAutoScaleStrategies\": [\n {\n \"StrategyId\": 0,\n \"StrategyName\": \"abc\",\n \"CalmDownTime\": 0,\n \"ScaleAction\": 0,\n \"ScaleNum\": 0,\n \"LoadMetrics\": \"abc\",\n \"MetricId\": 0,\n \"StatisticPeriod\": 0,\n \"ProcessMethod\": 0,\n \"TriggerThreshold\": 0,\n \"TriggerConditions\": {\n \"Conditions\": [\n {\n \"CompareMethod\": 0,\n \"Threshold\": 0\n }\n ]\n },\n \"Priority\": 0,\n \"StrategyStatus\": 0,\n \"YarnNodeLabel\": \"abc\",\n \"PeriodValid\": \"abc\",\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"LoadMetricsConditions\": {\n \"LoadMetrics\": [\n {\n \"StatisticPeriod\": 0,\n \"TriggerThreshold\": 0,\n \"LoadMetrics\": \"abc\",\n \"MetricId\": 0,\n \"Conditions\": [\n {\n \"CompareMethod\": 0,\n \"Threshold\": 0\n }\n ]\n }\n ]\n }\n }\n ],\n \"TimeBasedAutoScaleStrategies\": [\n {\n \"StrategyId\": 1,\n \"StrategyName\": \"abc\",\n \"IntervalTime\": 1,\n \"ScaleAction\": 1,\n \"ScaleNum\": 1,\n \"StrategyStatus\": 1,\n \"Priority\": 1,\n \"RetryValidTime\": 1,\n \"RepeatStrategy\": {\n \"RepeatType\": \"abc\",\n \"DayRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"Step\": 1\n },\n \"WeekRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfWeek\": [\n 1\n ]\n },\n \"MonthRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfMonthRange\": [\n 1\n ]\n },\n \"NotRepeat\": {\n \"ExecuteAt\": \"abc\"\n },\n \"Expire\": \"abc\"\n },\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"TerminatePolicy\": \"abc\",\n \"MaxUse\": 0,\n \"SoftDeployInfo\": [\n 0\n ],\n \"ServiceNodeInfo\": [\n 0\n ],\n \"CompensateFlag\": 0,\n \"GroupId\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
72
72
|
"title": "获取自动扩缩容规则"
|
73
73
|
}
|
74
74
|
],
|
@@ -249,7 +249,7 @@
|
|
249
249
|
"ModifyAutoScaleStrategy": [
|
250
250
|
{
|
251
251
|
"document": "修改扩缩容规则",
|
252
|
-
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAutoScaleStrategy\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"StrategyType\": 0,\n \"TimeAutoScaleStrategies\": [\n {\n \"StrategyId\": 1,\n \"StrategyName\": \"abc\",\n \"IntervalTime\": 1,\n \"ScaleAction\": 1,\n \"ScaleNum\": 1,\n \"StrategyStatus\": 1,\n \"Priority\": 1,\n \"RetryValidTime\": 1,\n \"RepeatStrategy\": {\n \"RepeatType\": \"abc\",\n \"DayRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"Step\": 1\n },\n \"WeekRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfWeek\": [\n 1\n ]\n },\n \"MonthRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfMonthRange\": [\n 1\n ]\n },\n \"NotRepeat\": {\n \"ExecuteAt\": \"abc\"\n },\n \"Expire\": \"abc\"\n },\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"TerminatePolicy\": \"abc\",\n \"MaxUse\": 0,\n \"SoftDeployInfo\": [\n 0\n ],\n \"ServiceNodeInfo\": [\n 0\n ],\n \"CompensateFlag\": 0\n }\n ]\n}",
|
252
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAutoScaleStrategy\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"StrategyType\": 0,\n \"LoadAutoScaleStrategies\": [\n {\n \"StrategyId\": 0,\n \"StrategyName\": \"abc\",\n \"CalmDownTime\": 0,\n \"ScaleAction\": 0,\n \"ScaleNum\": 0,\n \"LoadMetrics\": \"abc\",\n \"MetricId\": 0,\n \"StatisticPeriod\": 0,\n \"ProcessMethod\": 0,\n \"TriggerThreshold\": 0,\n \"TriggerConditions\": {\n \"Conditions\": [\n {\n \"CompareMethod\": 0,\n \"Threshold\": 0\n }\n ]\n },\n \"Priority\": 0,\n \"StrategyStatus\": 0,\n \"YarnNodeLabel\": \"abc\",\n \"PeriodValid\": \"abc\",\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"LoadMetricsConditions\": {\n \"LoadMetrics\": [\n {\n \"StatisticPeriod\": 0,\n \"TriggerThreshold\": 0,\n \"LoadMetrics\": \"abc\",\n \"MetricId\": 0,\n \"Conditions\": [\n {\n \"CompareMethod\": 0,\n \"Threshold\": 0\n }\n ]\n }\n ]\n }\n }\n ],\n \"TimeAutoScaleStrategies\": [\n {\n \"StrategyId\": 1,\n \"StrategyName\": \"abc\",\n \"IntervalTime\": 1,\n \"ScaleAction\": 1,\n \"ScaleNum\": 1,\n \"StrategyStatus\": 1,\n \"Priority\": 1,\n \"RetryValidTime\": 1,\n \"RepeatStrategy\": {\n \"RepeatType\": \"abc\",\n \"DayRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"Step\": 1\n },\n \"WeekRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfWeek\": [\n 1\n ]\n },\n \"MonthRepeat\": {\n \"ExecuteAtTimeOfDay\": \"abc\",\n \"DaysOfMonthRange\": [\n 1\n ]\n },\n \"NotRepeat\": {\n \"ExecuteAt\": \"abc\"\n },\n \"Expire\": \"abc\"\n },\n \"GraceDownFlag\": true,\n \"GraceDownTime\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"ConfigGroupAssigned\": \"abc\",\n \"MeasureMethod\": \"abc\",\n \"TerminatePolicy\": \"abc\",\n \"MaxUse\": 0,\n \"SoftDeployInfo\": [\n 0\n ],\n \"ServiceNodeInfo\": [\n 0\n ],\n \"CompensateFlag\": 0\n }\n ]\n}",
|
253
253
|
"output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
|
254
254
|
"title": "修改扩缩容规则"
|
255
255
|
},
|
@@ -99,7 +99,7 @@
|
|
99
99
|
"status": "online"
|
100
100
|
},
|
101
101
|
"CreateFlowBlockchainEvidenceUrl": {
|
102
|
-
"document": "
|
102
|
+
"document": "获取区块链存证证书查看链接/二维码接口\n\n适用场景:企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码,以供他人扫码打开腾讯电子签小程序查看。\n\n[点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)\n\n注:\n<ul><li>1. 二维码下载链接过期时间为5分钟,请尽快下载保存。二维码/短链的过期时间为<font color=\"red\">7天</font>,超过有效期则不可用。</li>\n<li>2. 合同状态需为<font color=\"red\">签署完成</font> 、<font color=\"red\">已解除</font>才能生成证书查看二维码/短链。</li>\n<li>3. 调用接口时,需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>\n<li>4. 通过扫码或者点击链接,用户无需登录或者鉴权即可查看对应合同的区块链存证证书,请妥善保管好二维码或链接。</li></ul>",
|
103
103
|
"input": "CreateFlowBlockchainEvidenceUrlRequest",
|
104
104
|
"name": "获取签署存证证书查看二维码",
|
105
105
|
"output": "CreateFlowBlockchainEvidenceUrlResponse",
|
@@ -1719,7 +1719,7 @@
|
|
1719
1719
|
"members": [
|
1720
1720
|
{
|
1721
1721
|
"disabled": false,
|
1722
|
-
"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_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
1722
|
+
"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_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li></ul>\n \n注:` 表单域的控件不能作为印章和签名控件`",
|
1723
1723
|
"example": "SIGN_SEAL",
|
1724
1724
|
"member": "string",
|
1725
1725
|
"name": "ComponentType",
|
@@ -1851,7 +1851,7 @@
|
|
1851
1851
|
},
|
1852
1852
|
{
|
1853
1853
|
"disabled": false,
|
1854
|
-
"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>: 范围12 :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>: 范围12 :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<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></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类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
1854
|
+
"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>: 范围12 :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>: 范围12 :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<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></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类型时</font>,支持以下参数:\n<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>\n<b>参数样例</b>:` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
1855
1855
|
"example": "无",
|
1856
1856
|
"member": "string",
|
1857
1857
|
"name": "ComponentExtra",
|
@@ -2940,7 +2940,7 @@
|
|
2940
2940
|
},
|
2941
2941
|
{
|
2942
2942
|
"disabled": false,
|
2943
|
-
"document": "
|
2943
|
+
"document": "查看短链,可直接点击短链查看证书。",
|
2944
2944
|
"example": "https://test.essurl.cn/SR04UBxxxx",
|
2945
2945
|
"member": "string",
|
2946
2946
|
"name": "Url",
|
@@ -342,10 +342,10 @@
|
|
342
342
|
],
|
343
343
|
"CreateFlowBlockchainEvidenceUrl": [
|
344
344
|
{
|
345
|
-
"document": "
|
345
|
+
"document": "拥有访问权限的员工生成合同区块链存证证书查看二维码/链接",
|
346
346
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowBlockchainEvidenceUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDR0fUUgyg*********jE1RTDui4pB\"\n },\n \"FlowId\": \"yDCANUUc************SI8fHrn0LCd\"\n}",
|
347
347
|
"output": "{\n \"Response\": {\n \"ExpiredOn\": 1719463451,\n \"QrCode\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d7914ff197f4b2b0*********27ec738d02a519c7a9f\",\n \"RequestId\": \"s1718858684971\",\n \"Url\": \"https://test.essurl.cn/SR0*****HF9B\"\n }\n}",
|
348
|
-
"title": "
|
348
|
+
"title": "生成合同区块链存证证书查看二维码/链接"
|
349
349
|
}
|
350
350
|
],
|
351
351
|
"CreateFlowByFiles": [
|
@@ -344,7 +344,7 @@
|
|
344
344
|
"status": "online"
|
345
345
|
},
|
346
346
|
"CreateFlowBlockchainEvidenceUrl": {
|
347
|
-
"document": "
|
347
|
+
"document": "获取区块链存证证书查看链接/二维码接口\n\n适用场景:企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码,以供他人扫码打开腾讯电子签小程序查看。\n\n[点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)\n\n注:\n<ul><li>1. 二维码下载链接过期时间为5分钟,请尽快下载保存。二维码/短链的过期时间为<font color=\"red\">7天</font>,超过有效期则不可用。</li>\n<li>2. 合同状态需为<font color=\"red\">签署完成</font> 、<font color=\"red\">已解除</font>才能生成证书查看二维码/短链。</li>\n<li>3. 调用接口时,需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>\n<li>4. 通过扫码或者点击链接,用户无需登录或者鉴权即可查看对应合同的区块链存证证书,请妥善保管好二维码或链接。</li></ul>",
|
348
348
|
"input": "CreateFlowBlockchainEvidenceUrlRequest",
|
349
349
|
"name": "获取签署存证证书查看二维码",
|
350
350
|
"output": "CreateFlowBlockchainEvidenceUrlResponse",
|
@@ -6044,7 +6044,7 @@
|
|
6044
6044
|
},
|
6045
6045
|
{
|
6046
6046
|
"disabled": false,
|
6047
|
-
"document": "第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。\n<font color=\"red\"
|
6047
|
+
"document": "第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。\n<font color=\"red\">在测试环境联调的过程中,企业名称请使用以下名称 \n**子客测试专用企业1 - 子客测试专用企业9**</font>\n\n注:\n `1. 如果名称中包含英文括号(),请使用中文括号()代替。`\n `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。 `",
|
6048
6048
|
"example": "典子谦示例企业测试",
|
6049
6049
|
"member": "string",
|
6050
6050
|
"name": "ProxyOrganizationName",
|
@@ -6252,7 +6252,7 @@
|
|
6252
6252
|
},
|
6253
6253
|
{
|
6254
6254
|
"disabled": false,
|
6255
|
-
"document": "
|
6255
|
+
"document": "查看短链,可直接点击短链查看证书。",
|
6256
6256
|
"example": "https://test.essurl.cn/SR04UBxxxx",
|
6257
6257
|
"member": "string",
|
6258
6258
|
"name": "Url",
|
@@ -748,10 +748,10 @@
|
|
748
748
|
],
|
749
749
|
"CreateFlowBlockchainEvidenceUrl": [
|
750
750
|
{
|
751
|
-
"document": "
|
751
|
+
"document": "拥有访问权限的员工生成合同区块链存证证书查看二维码/链接",
|
752
752
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowBlockchainEvidenceUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"ianc_1111\"\n },\n \"ProxyOrganizationOpenId\": \"ABC_organization_open_id\",\n \"AppId\": \"16fd2f7d7*****f8d501d57b5ec\"\n },\n \"FlowId\": \"yDCANUUckp******7SI8fHrn0LCd\"\n}",
|
753
753
|
"output": "{\n \"Response\": {\n \"ExpiredOn\": 1719463451,\n \"QrCode\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d7914ff197f4b2b099ab565a5733**************3a5b2d692827ec738d02a519c7a9f\",\n \"RequestId\": \"s17188843684971\",\n \"Url\": \"https://test.essurl.cn/SR0****F9B\"\n }\n}",
|
754
|
-
"title": "
|
754
|
+
"title": "生成合同区块链存证证书查看二维码/链接"
|
755
755
|
}
|
756
756
|
],
|
757
757
|
"CreateFlowGroupSignReview": [
|
@@ -1,14 +1,14 @@
|
|
1
1
|
{
|
2
2
|
"actions": {
|
3
3
|
"CreateImageModerationAsyncTask": {
|
4
|
-
"document": "本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。\n### 接口使用说明:\n- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**3000张图片**识别额度,有效期为15天。\n- 该接口为收费接口,计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。\n\n### 接口功能说明:\n- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;\n- 支持对GIF图/长图进行截帧或拆分检测;\n- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;\n- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;\n- 支持根据不同的业务场景配置自定义的审核策略;\n- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);\n- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。\n### 接口调用说明:\n-
|
4
|
+
"document": "本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。\n### 接口使用说明:\n- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**3000张图片**识别额度,有效期为15天。\n- 该接口为收费接口,计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。\n\n### 接口功能说明:\n- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;\n- 支持对GIF图/长图进行截帧或拆分检测;\n- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;\n- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;\n- 支持根据不同的业务场景配置自定义的审核策略;\n- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);\n- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。\n### 接口调用说明:\n- 图片文件大小限制:**Base64编码内容应小于10MB**;**图片资源应小于100MB**\n- 图片尺寸支持:**长和宽 需>50分辨率且<40000分辨率,并且图片长宽比<90:1;**\n- 图片文件分辨率支持:建议**分辨率大于256x256**,否则可能会影响识别效果;\n- 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式;\n- 图片文件链接支持的传输协议:HTTP、HTTPS;\n- 若传入图片文件的访问链接,则需要注意**图片下载时间限制为3秒**,为保障被检测图片的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;\n- 默认接口请求频率限制:**20次/秒**,超过此调用频率则会报错。",
|
5
5
|
"input": "CreateImageModerationAsyncTaskRequest",
|
6
6
|
"name": "图片异步检测",
|
7
7
|
"output": "CreateImageModerationAsyncTaskResponse",
|
8
8
|
"status": "online"
|
9
9
|
},
|
10
10
|
"ImageModeration": {
|
11
|
-
"document": "本接口(Image Moderation, IM)用于提交图片文件进行同步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。\n### 接口使用说明:\n- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms)”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**3000张图片**识别额度,有效期为15天。\n- 该接口为收费接口,计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。\n\n### 接口功能说明:\n- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;\n- 支持对GIF图/长图进行截帧或拆分检测;\n- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;\n- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;\n- 支持根据不同的业务场景配置自定义的审核策略;\n- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);\n- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。\n\n### 接口调用说明:\n-
|
11
|
+
"document": "本接口(Image Moderation, IM)用于提交图片文件进行同步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。\n### 接口使用说明:\n- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms)”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**3000张图片**识别额度,有效期为15天。\n- 该接口为收费接口,计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。\n\n### 接口功能说明:\n- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;\n- 支持对GIF图/长图进行截帧或拆分检测;\n- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;\n- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;\n- 支持根据不同的业务场景配置自定义的审核策略;\n- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);\n- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。\n\n### 接口调用说明:\n- 图片文件大小限制:**Base64编码内容应小于10MB**;**URL资源应小于30MB**\n- 图片默认尺寸支持:**长和宽 需>50分辨率且<10000分辨率,并且图片长宽比<90:1;**\n- 图片文件分辨率支持:建议**分辨率大于256x256**,否则可能会影响识别效果;\n- 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式;\n- 图片文件链接支持的传输协议:HTTP、HTTPS;\n- 若传入图片文件的访问链接,则需要注意**图片下载时间限制为3秒**,为保障被检测图片的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;\n\n\n<div class=\"rno-api-explorer\" style=\"margin-bottom:20px\">\n <div class=\"rno-api-explorer-inner\">\n <div class=\"rno-api-explorer-hd\">\n <div class=\"rno-api-explorer-title\">\n 关于版本迭代的描述\n </div>\n </div>\n <div class=\"rno-api-explorer-body\">\n <div class=\"rno-api-explorer-cont\">\n <p>当前页面版本为图片内容安全2020版本,2020.11.3日前接入的图片内容安全接口为2019版本,在此时间前接入的用户可直接访问以下链接进行维护操作:<a href=\"https://cloud.tencent.com/document/product/1125/38206\" target=\"_blank\">图片内容安全-2019版本</a></p>\n <p>2020版本相对2019版本进行了升级,支持更灵活的多场景业务策略配置以及更丰富的识别回调信息,满足不同业务的识别需求,建议按照2020版本接入指引进行接口升级;同时,2019版本也会持续维护直至用户不再使用为止。</p>\n </div>\n </div>\n </div>\n</div>",
|
12
12
|
"input": "ImageModerationRequest",
|
13
13
|
"name": "图片同步检测",
|
14
14
|
"output": "ImageModerationResponse",
|