tccli 3.0.1246.1__py2.py3-none-any.whl → 3.0.1247.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/billing/v20180709/api.json +55 -1
- tccli/services/cam/v20190116/api.json +14 -14
- tccli/services/ccc/v20200210/api.json +61 -1
- tccli/services/cls/v20201016/api.json +3 -3
- tccli/services/dbbrain/v20210527/api.json +14 -5
- tccli/services/ecm/v20190719/api.json +17 -11
- tccli/services/ecm/v20190719/examples.json +1 -1
- tccli/services/ess/v20201111/api.json +1 -1
- tccli/services/essbasic/v20210526/api.json +1 -1
- tccli/services/hunyuan/v20230901/api.json +4 -4
- tccli/services/lcic/v20220817/api.json +110 -111
- tccli/services/lcic/v20220817/examples.json +40 -40
- tccli/services/lkeap/lkeap_client.py +53 -0
- tccli/services/lkeap/v20240522/api.json +91 -0
- tccli/services/lkeap/v20240522/examples.json +9 -1
- tccli/services/mongodb/v20180408/api.json +153 -112
- tccli/services/mongodb/v20180408/examples.json +2 -2
- tccli/services/mongodb/v20190725/api.json +202 -167
- tccli/services/mongodb/v20190725/examples.json +8 -8
- tccli/services/ocr/v20181119/api.json +10 -10
- tccli/services/ocr/v20181119/examples.json +15 -15
- tccli/services/ssl/v20191205/api.json +1 -1
- tccli/services/tcb/v20180608/api.json +236 -219
- tccli/services/tcb/v20180608/examples.json +9 -9
- tccli/services/tcbr/v20220217/api.json +46 -13
- tccli/services/tcbr/v20220217/examples.json +2 -8
- tccli/services/tcr/v20190924/api.json +72 -68
- tccli/services/tcr/v20190924/examples.json +40 -40
- tccli/services/tdmq/tdmq_client.py +57 -4
- tccli/services/tdmq/v20200217/api.json +107 -0
- tccli/services/tdmq/v20200217/examples.json +8 -0
- tccli/services/trtc/v20190722/api.json +33 -33
- tccli/services/vdb/v20230616/api.json +2 -2
- tccli/services/vpc/v20170312/api.json +38 -25
- tccli/services/vpc/v20170312/examples.json +6 -6
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1247.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1247.1.dist-info}/RECORD +41 -41
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1247.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1247.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1247.1.dist-info}/license_files/LICENSE +0 -0
tccli/__init__.py
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
__version__ = '3.0.
|
|
1
|
+
__version__ = '3.0.1247.1'
|
|
@@ -13456,6 +13456,60 @@
|
|
|
13456
13456
|
"name": "VoucherSubType",
|
|
13457
13457
|
"required": false,
|
|
13458
13458
|
"type": "string"
|
|
13459
|
+
},
|
|
13460
|
+
{
|
|
13461
|
+
"disabled": false,
|
|
13462
|
+
"document": "券有效时间开始时间",
|
|
13463
|
+
"example": "2021-01-01",
|
|
13464
|
+
"member": "string",
|
|
13465
|
+
"name": "StartTimeFrom",
|
|
13466
|
+
"required": false,
|
|
13467
|
+
"type": "string"
|
|
13468
|
+
},
|
|
13469
|
+
{
|
|
13470
|
+
"disabled": false,
|
|
13471
|
+
"document": "券有效时间结束时间",
|
|
13472
|
+
"example": "2021-01-01",
|
|
13473
|
+
"member": "string",
|
|
13474
|
+
"name": "StartTimeTo",
|
|
13475
|
+
"required": false,
|
|
13476
|
+
"type": "string"
|
|
13477
|
+
},
|
|
13478
|
+
{
|
|
13479
|
+
"disabled": false,
|
|
13480
|
+
"document": "券失效时间开始时间",
|
|
13481
|
+
"example": "2021-01-01",
|
|
13482
|
+
"member": "string",
|
|
13483
|
+
"name": "EndTimeFrom",
|
|
13484
|
+
"required": false,
|
|
13485
|
+
"type": "string"
|
|
13486
|
+
},
|
|
13487
|
+
{
|
|
13488
|
+
"disabled": false,
|
|
13489
|
+
"document": "券失效时间结束时间",
|
|
13490
|
+
"example": "2021-01-01",
|
|
13491
|
+
"member": "string",
|
|
13492
|
+
"name": "EndTimeTo",
|
|
13493
|
+
"required": false,
|
|
13494
|
+
"type": "string"
|
|
13495
|
+
},
|
|
13496
|
+
{
|
|
13497
|
+
"disabled": false,
|
|
13498
|
+
"document": "发券时间开始时间",
|
|
13499
|
+
"example": "2021-01-01",
|
|
13500
|
+
"member": "string",
|
|
13501
|
+
"name": "CreateTimeFrom",
|
|
13502
|
+
"required": false,
|
|
13503
|
+
"type": "string"
|
|
13504
|
+
},
|
|
13505
|
+
{
|
|
13506
|
+
"disabled": false,
|
|
13507
|
+
"document": "发券时间结束时间",
|
|
13508
|
+
"example": "2021-01-01",
|
|
13509
|
+
"member": "string",
|
|
13510
|
+
"name": "CreateTimeTo",
|
|
13511
|
+
"required": false,
|
|
13512
|
+
"type": "string"
|
|
13459
13513
|
}
|
|
13460
13514
|
],
|
|
13461
13515
|
"type": "object"
|
|
@@ -13486,7 +13540,7 @@
|
|
|
13486
13540
|
{
|
|
13487
13541
|
"disabled": false,
|
|
13488
13542
|
"document": "代金券相关信息",
|
|
13489
|
-
"example": "
|
|
13543
|
+
"example": "无",
|
|
13490
13544
|
"member": "VoucherInfos",
|
|
13491
13545
|
"name": "VoucherInfos",
|
|
13492
13546
|
"output_required": true,
|
|
@@ -3013,17 +3013,17 @@
|
|
|
3013
3013
|
"example": "11",
|
|
3014
3014
|
"member": "uint64",
|
|
3015
3015
|
"name": "ProviderType",
|
|
3016
|
-
"
|
|
3016
|
+
"output_required": true,
|
|
3017
3017
|
"type": "int",
|
|
3018
3018
|
"value_allowed_null": false
|
|
3019
3019
|
},
|
|
3020
3020
|
{
|
|
3021
3021
|
"disabled": false,
|
|
3022
3022
|
"document": "身份提供商URL",
|
|
3023
|
-
"example": "
|
|
3023
|
+
"example": "http://test-idp.com",
|
|
3024
3024
|
"member": "string",
|
|
3025
3025
|
"name": "IdentityUrl",
|
|
3026
|
-
"
|
|
3026
|
+
"output_required": true,
|
|
3027
3027
|
"type": "string",
|
|
3028
3028
|
"value_allowed_null": false
|
|
3029
3029
|
},
|
|
@@ -3033,7 +3033,7 @@
|
|
|
3033
3033
|
"example": "无",
|
|
3034
3034
|
"member": "string",
|
|
3035
3035
|
"name": "IdentityKey",
|
|
3036
|
-
"
|
|
3036
|
+
"output_required": true,
|
|
3037
3037
|
"type": "string",
|
|
3038
3038
|
"value_allowed_null": false
|
|
3039
3039
|
},
|
|
@@ -3043,17 +3043,17 @@
|
|
|
3043
3043
|
"example": "无",
|
|
3044
3044
|
"member": "string",
|
|
3045
3045
|
"name": "ClientId",
|
|
3046
|
-
"
|
|
3046
|
+
"output_required": true,
|
|
3047
3047
|
"type": "string",
|
|
3048
3048
|
"value_allowed_null": false
|
|
3049
3049
|
},
|
|
3050
3050
|
{
|
|
3051
3051
|
"disabled": false,
|
|
3052
3052
|
"document": "状态：0:未设置，11:已开启，2:已禁用",
|
|
3053
|
-
"example": "
|
|
3053
|
+
"example": "11",
|
|
3054
3054
|
"member": "uint64",
|
|
3055
3055
|
"name": "Status",
|
|
3056
|
-
"
|
|
3056
|
+
"output_required": true,
|
|
3057
3057
|
"type": "int",
|
|
3058
3058
|
"value_allowed_null": false
|
|
3059
3059
|
},
|
|
@@ -3063,7 +3063,7 @@
|
|
|
3063
3063
|
"example": "无",
|
|
3064
3064
|
"member": "string",
|
|
3065
3065
|
"name": "AuthorizationEndpoint",
|
|
3066
|
-
"
|
|
3066
|
+
"output_required": true,
|
|
3067
3067
|
"type": "string",
|
|
3068
3068
|
"value_allowed_null": false
|
|
3069
3069
|
},
|
|
@@ -3073,7 +3073,7 @@
|
|
|
3073
3073
|
"example": "无",
|
|
3074
3074
|
"member": "string",
|
|
3075
3075
|
"name": "Scope",
|
|
3076
|
-
"
|
|
3076
|
+
"output_required": true,
|
|
3077
3077
|
"type": "list",
|
|
3078
3078
|
"value_allowed_null": false
|
|
3079
3079
|
},
|
|
@@ -3083,7 +3083,7 @@
|
|
|
3083
3083
|
"example": "无",
|
|
3084
3084
|
"member": "string",
|
|
3085
3085
|
"name": "ResponseType",
|
|
3086
|
-
"
|
|
3086
|
+
"output_required": true,
|
|
3087
3087
|
"type": "string",
|
|
3088
3088
|
"value_allowed_null": false
|
|
3089
3089
|
},
|
|
@@ -3093,7 +3093,7 @@
|
|
|
3093
3093
|
"example": "无",
|
|
3094
3094
|
"member": "string",
|
|
3095
3095
|
"name": "ResponseMode",
|
|
3096
|
-
"
|
|
3096
|
+
"output_required": true,
|
|
3097
3097
|
"type": "string",
|
|
3098
3098
|
"value_allowed_null": false
|
|
3099
3099
|
},
|
|
@@ -3103,7 +3103,7 @@
|
|
|
3103
3103
|
"example": "无",
|
|
3104
3104
|
"member": "string",
|
|
3105
3105
|
"name": "MappingFiled",
|
|
3106
|
-
"
|
|
3106
|
+
"output_required": true,
|
|
3107
3107
|
"type": "string",
|
|
3108
3108
|
"value_allowed_null": false
|
|
3109
3109
|
},
|
|
@@ -3113,7 +3113,7 @@
|
|
|
3113
3113
|
"example": "无",
|
|
3114
3114
|
"member": "string",
|
|
3115
3115
|
"name": "Description",
|
|
3116
|
-
"
|
|
3116
|
+
"output_required": true,
|
|
3117
3117
|
"type": "string",
|
|
3118
3118
|
"value_allowed_null": false
|
|
3119
3119
|
},
|
|
@@ -3146,7 +3146,7 @@
|
|
|
3146
3146
|
},
|
|
3147
3147
|
{
|
|
3148
3148
|
"disabled": false,
|
|
3149
|
-
"document": "状态：0:未设置，
|
|
3149
|
+
"document": "状态：0:未设置，11:已开启，2:已禁用",
|
|
3150
3150
|
"example": "11",
|
|
3151
3151
|
"member": "uint64",
|
|
3152
3152
|
"name": "Status",
|
|
@@ -442,6 +442,39 @@
|
|
|
442
442
|
"serviceShortName": "ccc"
|
|
443
443
|
},
|
|
444
444
|
"objects": {
|
|
445
|
+
"AITransferItem": {
|
|
446
|
+
"document": "AI转人工配置项",
|
|
447
|
+
"members": [
|
|
448
|
+
{
|
|
449
|
+
"disabled": false,
|
|
450
|
+
"document": "转人工的function calling 名称",
|
|
451
|
+
"example": "transfer_to_human",
|
|
452
|
+
"member": "string",
|
|
453
|
+
"name": "TransferFunctionName",
|
|
454
|
+
"required": true,
|
|
455
|
+
"type": "string"
|
|
456
|
+
},
|
|
457
|
+
{
|
|
458
|
+
"disabled": false,
|
|
459
|
+
"document": "TransferFunctionEnable为true时生效；transfer_to_human function calling的desc，默认为 \"Transfer to human when the user has to transfer to human (like says transfer to human) or you are instructed to do so.\"",
|
|
460
|
+
"example": "无",
|
|
461
|
+
"member": "string",
|
|
462
|
+
"name": "TransferFunctionDesc",
|
|
463
|
+
"required": true,
|
|
464
|
+
"type": "string"
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"disabled": false,
|
|
468
|
+
"document": "转人工的技能组ID",
|
|
469
|
+
"example": "1",
|
|
470
|
+
"member": "uint64",
|
|
471
|
+
"name": "TransferSkillGroupId",
|
|
472
|
+
"required": true,
|
|
473
|
+
"type": "int"
|
|
474
|
+
}
|
|
475
|
+
],
|
|
476
|
+
"usage": "in"
|
|
477
|
+
},
|
|
445
478
|
"AbortPredictiveDialingCampaignRequest": {
|
|
446
479
|
"document": "AbortPredictiveDialingCampaign请求参数结构体",
|
|
447
480
|
"members": [
|
|
@@ -1674,6 +1707,24 @@
|
|
|
1674
1707
|
"required": false,
|
|
1675
1708
|
"type": "string"
|
|
1676
1709
|
},
|
|
1710
|
+
{
|
|
1711
|
+
"disabled": false,
|
|
1712
|
+
"document": "模型是否支持(或者开启)transfer_to_human function calling",
|
|
1713
|
+
"example": "true",
|
|
1714
|
+
"member": "bool",
|
|
1715
|
+
"name": "TransferFunctionEnable",
|
|
1716
|
+
"required": false,
|
|
1717
|
+
"type": "bool"
|
|
1718
|
+
},
|
|
1719
|
+
{
|
|
1720
|
+
"disabled": false,
|
|
1721
|
+
"document": "TransferFunctionEnable为true的时候生效: 转人工配置",
|
|
1722
|
+
"example": "无",
|
|
1723
|
+
"member": "AITransferItem",
|
|
1724
|
+
"name": "TransferItems",
|
|
1725
|
+
"required": false,
|
|
1726
|
+
"type": "list"
|
|
1727
|
+
},
|
|
1677
1728
|
{
|
|
1678
1729
|
"disabled": false,
|
|
1679
1730
|
"document": "用户多久没说话提示时长,最小10秒,默认10秒",
|
|
@@ -1704,11 +1755,20 @@
|
|
|
1704
1755
|
{
|
|
1705
1756
|
"disabled": false,
|
|
1706
1757
|
"document": "<p>和VoiceType字段需要选填一个，这里是使用自己自定义的TTS，VoiceType是系统内置的一些音色</p>\n<ul>\n<li>Tencent TTS<br>\n配置请参考<a href=\"https://cloud.tencent.com/document/product/1073/92668#55924b56-1a73-4663-a7a1-a8dd82d6e823\" target=\"_blank\">腾讯云TTS文档链接</a></li>\n</ul>\n<div><div class=\"v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class\"><pre class=\"v-md-prism-\"><code>{ \n "TTSType": "tencent", // String TTS类型, 目前支持"tencent" 和 “minixmax”， 其他的厂商支持中\n "AppId": "您的应用ID", // String 必填\n "SecretId": "您的密钥ID", // String 必填\n "SecretKey": "您的密钥Key", // String 必填\n "VoiceType": 101001, // Integer 必填，音色 ID，包括标准音色与精品音色，精品音色拟真度更高，价格不同于标准音色，请参见语音合成计费概述。完整的音色 ID 列表请参见语音合成音色列表。\n "Speed": 1.25, // Integer 非必填，语速，范围：[-2，6]，分别对应不同语速： -2: 代表0.6倍 -1: 代表0.8倍 0: 代表1.0倍（默认） 1: 代表1.2倍 2: 代表1.5倍 6: 代表2.5倍 如果需要更细化的语速，可以保留小数点后 2 位，例如0.5/1.25/2.81等。 参数值与实际语速转换，可参考 语速转换\n "Volume": 5, // Integer 非必填，音量大小，范围：[0，10]，分别对应11个等级的音量，默认值为0，代表正常音量。\n "PrimaryLanguage": 1, // Integer 可选 主要语言 1-中文（默认） 2-英文 3-日文\n "FastVoiceType": "xxxx" // 可选参数， 快速声音复刻的参数 \n }\n</code></pre>\n\n </div></div><ul>\n<li>Minimax TTS<br>\n配置请参考<a href=\"https://platform.minimaxi.com/document/T2A%20V2?key=66719005a427f0c8a5701643\" target=\"_blank\">Minimax TTS文档链接</a>。注意Minimax TTS存在频率限制，超频可能会导致回答卡顿，<a href=\"https://platform.minimaxi.com/document/Rate%20limits?key=66b19417290299a26b234572\" target=\"_blank\">Minimax TTS频率限制相关文档链接</a>。</li>\n</ul>\n<div><div class=\"v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class\"><pre class=\"v-md-prism-\"><code>{\n "TTSType": "minimax", // String TTS类型, \n "Model": "speech-01-turbo",\n "APIUrl": "https://api.minimax.chat/v1/t2a_v2",\n "APIKey": "eyxxxx",\n "GroupId": "181000000000000",\n "VoiceType":"female-tianmei-jingpin",\n "Speed": 1.2\n}\n</code></pre>\n</div></div><ul>\n<li>火山 TTS</li>\n</ul>\n<p>配置音色类型参考<a href=\"https://www.volcengine.com/docs/6561/162929\" target=\"_blank\">火山TTS文档链接</a><br>\n语音合成音色列表–语音技术-火山引擎<br>\n大模型语音合成音色列表–语音技术-火山引擎</p>\n<div><div class=\"v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class\"><pre class=\"v-md-prism-\"><code>{\n "TTSType": "volcengine", // 必填：String TTS类型\n "AppId" : "xxxxxxxx", // 必填：String 火山引擎分配的Appid\n "Token" : "TY9d4sQXHxxxxxxx", // 必填： String类型 火山引擎的访问token\n "Speed" : 1.0, // 可选参数 语速，默认为1.0\n "Volume": 1.0, // 可选参数， 音量大小， 默认为1.0\n "Cluster" : "volcano_tts", // 可选参数，业务集群, 默认是 volcano_tts\n "VoiceType" : "zh_male_aojiaobazong_moon_bigtts" // 音色类型， 默认为大模型语音合成的音色。 如果使用普通语音合成，则需要填写对应的音色类型。 音色类型填写错误会导致没有声音。\n}\n</code></pre>\n\n</div></div><ul>\n<li>Azure TTS<br>\n配置请参考<a href=\"https://docs.azure.cn/zh-cn/ai-services/speech-service/speech-synthesis-markup-voice\" target=\"_blank\">AzureTTS文档链接</a></li>\n</ul>\n<div><div class=\"v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class\"><pre class=\"v-md-prism-\"><code>{\n "TTSType": "azure", // 必填：String TTS类型\n "SubscriptionKey": "xxxxxxxx", // 必填：String 订阅的Key\n "Region": "chinanorth3", // 必填：String 订阅的地区\n "VoiceName": "zh-CN-XiaoxiaoNeural", // 必填：String 音色名必填\n "Language": "zh-CN", // 必填：String 合成的语言 \n "Rate": 1 // 选填：float 语速 0.5～2 默认为 1\n}\n</code></pre>\n\n</div></div><ul>\n<li>自定义</li>\n</ul>\n<p>TTS<br>\n具体协议规范请参考<a href=\"https://doc.weixin.qq.com/doc/w3_ANQAiAbdAFwHILbJBmtSqSbV1WZ3L?scode=AJEAIQdfAAo5a1xajYANQAiAbdAFw\" target=\"_blank\">腾讯文档</a></p>\n<div><div class=\"v-md-pre-wrapper copy-code-mode v-md-pre-wrapper- extra-class\"><pre class=\"v-md-prism-\"><code>{\n "TTSType": "custom", // String 必填\n "APIKey": "ApiKey", // String 必填 用来鉴权\n "APIUrl": "http://0.0.0.0:8080/stream-audio" // String，必填，TTS API URL\n "AudioFormat": "wav", // String, 非必填，期望输出的音频格式，如mp3， ogg_opus，pcm，wav，默认为 wav，目前只支持pcm和wav，\n "SampleRate": 16000, // Integer，非必填，音频采样率，默认为16000(16k)，推荐值为16000\n "AudioChannel": 1, // Integer，非必填，音频通道数，取值：1 或 2 默认为1 \n}\n</code></pre>\n\n</div></div>",
|
|
1707
|
-
"example": "{ \
|
|
1758
|
+
"example": "{ \"TTSType\": \"azure\", \"SubscriptionKey\": \"xx\", \"Region\": \"chinanorth3\", \"VoiceName\": \"zh-CN-\", \"Language\": \"zh-CN\", \"Rate\": 1 }",
|
|
1708
1759
|
"member": "string",
|
|
1709
1760
|
"name": "CustomTTSConfig",
|
|
1710
1761
|
"required": false,
|
|
1711
1762
|
"type": "string"
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"disabled": false,
|
|
1766
|
+
"document": "提示词变量",
|
|
1767
|
+
"example": "[{\"Key\":\"foo\",\"Value\":\"bar\"}]",
|
|
1768
|
+
"member": "Variable",
|
|
1769
|
+
"name": "PromptVariables",
|
|
1770
|
+
"required": false,
|
|
1771
|
+
"type": "list"
|
|
1712
1772
|
}
|
|
1713
1773
|
],
|
|
1714
1774
|
"type": "object"
|
|
@@ -2735,7 +2735,7 @@
|
|
|
2735
2735
|
{
|
|
2736
2736
|
"disabled": false,
|
|
2737
2737
|
"document": "允许访问的资源列表，目前仅支持一个Resource",
|
|
2738
|
-
"example": "当Type为1时:['qcs::cls::uin/
|
|
2738
|
+
"example": "当Type为1时:['qcs::cls::uin/1000:dashboard/dashboard-xx']; 当Type为2时:['qcs::cls:ap-guangzhou:uin/10000:topic/cxxx']",
|
|
2739
2739
|
"member": "string",
|
|
2740
2740
|
"name": "Resources",
|
|
2741
2741
|
"output_required": true,
|
|
@@ -2756,7 +2756,7 @@
|
|
|
2756
2756
|
},
|
|
2757
2757
|
{
|
|
2758
2758
|
"disabled": false,
|
|
2759
|
-
"document": "
|
|
2759
|
+
"document": "分享链接加密访问验证码。支持0-9和a-z(不区分大小写)在内的6个字符，可为空，代表免验证码访问\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2760
2760
|
"example": "lEC0V0",
|
|
2761
2761
|
"member": "string",
|
|
2762
2762
|
"name": "VerifyCode",
|
|
@@ -2862,7 +2862,7 @@
|
|
|
2862
2862
|
{
|
|
2863
2863
|
"disabled": false,
|
|
2864
2864
|
"document": "值\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2865
|
-
"example": "
|
|
2865
|
+
"example": "* | select *",
|
|
2866
2866
|
"member": "string",
|
|
2867
2867
|
"name": "Value",
|
|
2868
2868
|
"output_required": false,
|
|
@@ -4363,7 +4363,7 @@
|
|
|
4363
4363
|
{
|
|
4364
4364
|
"disabled": false,
|
|
4365
4365
|
"document": "实例ID。",
|
|
4366
|
-
"example": "
|
|
4366
|
+
"example": "crs-c1nl9rpv",
|
|
4367
4367
|
"member": "string",
|
|
4368
4368
|
"name": "InstanceId",
|
|
4369
4369
|
"required": true,
|
|
@@ -4381,7 +4381,7 @@
|
|
|
4381
4381
|
{
|
|
4382
4382
|
"disabled": false,
|
|
4383
4383
|
"document": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。",
|
|
4384
|
-
"example": "
|
|
4384
|
+
"example": "redis",
|
|
4385
4385
|
"member": "string",
|
|
4386
4386
|
"name": "Product",
|
|
4387
4387
|
"required": true,
|
|
@@ -4389,12 +4389,21 @@
|
|
|
4389
4389
|
},
|
|
4390
4390
|
{
|
|
4391
4391
|
"disabled": false,
|
|
4392
|
-
"document": "查询数目，默认为20，最大值为
|
|
4392
|
+
"document": "查询数目，默认为20，最大值为500。",
|
|
4393
4393
|
"example": "20",
|
|
4394
4394
|
"member": "int64",
|
|
4395
4395
|
"name": "Limit",
|
|
4396
4396
|
"required": false,
|
|
4397
4397
|
"type": "int"
|
|
4398
|
+
},
|
|
4399
|
+
{
|
|
4400
|
+
"disabled": false,
|
|
4401
|
+
"document": "分片ID数组。",
|
|
4402
|
+
"example": "[1]",
|
|
4403
|
+
"member": "int64",
|
|
4404
|
+
"name": "ShardIds",
|
|
4405
|
+
"required": false,
|
|
4406
|
+
"type": "list"
|
|
4398
4407
|
}
|
|
4399
4408
|
],
|
|
4400
4409
|
"type": "object"
|
|
@@ -4408,7 +4417,7 @@
|
|
|
4408
4417
|
"example": "无",
|
|
4409
4418
|
"member": "RedisPreKeySpaceData",
|
|
4410
4419
|
"name": "Items",
|
|
4411
|
-
"
|
|
4420
|
+
"output_required": true,
|
|
4412
4421
|
"type": "list",
|
|
4413
4422
|
"value_allowed_null": false
|
|
4414
4423
|
},
|
|
@@ -4418,7 +4427,7 @@
|
|
|
4418
4427
|
"example": "1618890295",
|
|
4419
4428
|
"member": "int64",
|
|
4420
4429
|
"name": "Timestamp",
|
|
4421
|
-
"
|
|
4430
|
+
"output_required": true,
|
|
4422
4431
|
"type": "int",
|
|
4423
4432
|
"value_allowed_null": false
|
|
4424
4433
|
},
|
|
@@ -1336,7 +1336,7 @@
|
|
|
1336
1336
|
{
|
|
1337
1337
|
"disabled": false,
|
|
1338
1338
|
"document": "需要开通公网访问能力的IPV6地址。",
|
|
1339
|
-
"example": "
|
|
1339
|
+
"example": "[\"2402:4e00:1200:1809:0:8ef6:b82b:513b\"]",
|
|
1340
1340
|
"member": "string",
|
|
1341
1341
|
"name": "Ipv6Addresses",
|
|
1342
1342
|
"required": true,
|
|
@@ -1369,20 +1369,20 @@
|
|
|
1369
1369
|
{
|
|
1370
1370
|
"disabled": false,
|
|
1371
1371
|
"document": "弹性公网 IPV6 的唯一 ID 列表。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
1372
|
-
"example": "
|
|
1372
|
+
"example": "[\"eip-3l4nwzvo\"]",
|
|
1373
1373
|
"member": "string",
|
|
1374
1374
|
"name": "AddressSet",
|
|
1375
|
-
"
|
|
1375
|
+
"output_required": true,
|
|
1376
1376
|
"type": "list",
|
|
1377
1377
|
"value_allowed_null": true
|
|
1378
1378
|
},
|
|
1379
1379
|
{
|
|
1380
1380
|
"disabled": false,
|
|
1381
1381
|
"document": "异步任务TaskId。",
|
|
1382
|
-
"example": "
|
|
1382
|
+
"example": "202869021",
|
|
1383
1383
|
"member": "string",
|
|
1384
1384
|
"name": "TaskId",
|
|
1385
|
-
"
|
|
1385
|
+
"output_required": true,
|
|
1386
1386
|
"type": "string",
|
|
1387
1387
|
"value_allowed_null": false
|
|
1388
1388
|
},
|
|
@@ -8803,9 +8803,10 @@
|
|
|
8803
8803
|
{
|
|
8804
8804
|
"disabled": false,
|
|
8805
8805
|
"document": "IPv6地址，形如：3402:4e00:20:100:0:8cd9:2a67:71f3",
|
|
8806
|
-
"example": "",
|
|
8806
|
+
"example": "3402:4e00:20:100:0:8cd9:2a67:71f3",
|
|
8807
8807
|
"member": "string",
|
|
8808
8808
|
"name": "Address",
|
|
8809
|
+
"output_required": true,
|
|
8809
8810
|
"required": true,
|
|
8810
8811
|
"type": "string",
|
|
8811
8812
|
"value_allowed_null": false
|
|
@@ -8813,9 +8814,10 @@
|
|
|
8813
8814
|
{
|
|
8814
8815
|
"disabled": false,
|
|
8815
8816
|
"document": "是否是主IP。",
|
|
8816
|
-
"example": "",
|
|
8817
|
+
"example": "true",
|
|
8817
8818
|
"member": "bool",
|
|
8818
8819
|
"name": "Primary",
|
|
8820
|
+
"output_required": true,
|
|
8819
8821
|
"required": false,
|
|
8820
8822
|
"type": "bool",
|
|
8821
8823
|
"value_allowed_null": false
|
|
@@ -8823,9 +8825,10 @@
|
|
|
8823
8825
|
{
|
|
8824
8826
|
"disabled": false,
|
|
8825
8827
|
"document": "EIP实例ID，形如：eip-hxlqja90。",
|
|
8826
|
-
"example": "",
|
|
8828
|
+
"example": "eip-hxlqja90",
|
|
8827
8829
|
"member": "string",
|
|
8828
8830
|
"name": "AddressId",
|
|
8831
|
+
"output_required": true,
|
|
8829
8832
|
"required": false,
|
|
8830
8833
|
"type": "string",
|
|
8831
8834
|
"value_allowed_null": false
|
|
@@ -8833,9 +8836,10 @@
|
|
|
8833
8836
|
{
|
|
8834
8837
|
"disabled": false,
|
|
8835
8838
|
"document": "描述信息。",
|
|
8836
|
-
"example": "",
|
|
8839
|
+
"example": "demo",
|
|
8837
8840
|
"member": "string",
|
|
8838
8841
|
"name": "Description",
|
|
8842
|
+
"output_required": true,
|
|
8839
8843
|
"required": false,
|
|
8840
8844
|
"type": "string",
|
|
8841
8845
|
"value_allowed_null": false
|
|
@@ -8843,9 +8847,10 @@
|
|
|
8843
8847
|
{
|
|
8844
8848
|
"disabled": false,
|
|
8845
8849
|
"document": "公网IP是否被封堵。",
|
|
8846
|
-
"example": "",
|
|
8850
|
+
"example": "true",
|
|
8847
8851
|
"member": "bool",
|
|
8848
8852
|
"name": "IsWanIpBlocked",
|
|
8853
|
+
"output_required": true,
|
|
8849
8854
|
"required": false,
|
|
8850
8855
|
"type": "bool",
|
|
8851
8856
|
"value_allowed_null": false
|
|
@@ -8853,9 +8858,10 @@
|
|
|
8853
8858
|
{
|
|
8854
8859
|
"disabled": false,
|
|
8855
8860
|
"document": "IPv6地址状态：\nPENDING：生产中\nMIGRATING：迁移中\nDELETING：删除中\nAVAILABLE：可用的",
|
|
8856
|
-
"example": "",
|
|
8861
|
+
"example": "AVAILABLE",
|
|
8857
8862
|
"member": "string",
|
|
8858
8863
|
"name": "State",
|
|
8864
|
+
"output_required": true,
|
|
8859
8865
|
"required": false,
|
|
8860
8866
|
"type": "string",
|
|
8861
8867
|
"value_allowed_null": false
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
{
|
|
13
13
|
"document": "",
|
|
14
14
|
"input": "https://ecm.tencentcloudapi.com/?Action=AllocateIpv6AddressesBandwidth\n&EcmRegion=ap-xian-ecm\n&Ipv6Addresses.0=2402:4e00:1000:200:0:8d8a:60b7:87f8\n&<公共请求参数>",
|
|
15
|
-
"output": "{\n \"Response\": {\n \"AddressSet\": [\n \"eip-3l4nwzvo\"\n ],\n \"TaskId\": 202869021,\n \"RequestId\": \"aac03e7b-3c91-4970-b2bc-c20f0c6bdd38\"\n }\n}",
|
|
15
|
+
"output": "{\n \"Response\": {\n \"AddressSet\": [\n \"eip-3l4nwzvo\"\n ],\n \"TaskId\": \"202869021\",\n \"RequestId\": \"aac03e7b-3c91-4970-b2bc-c20f0c6bdd38\"\n }\n}",
|
|
16
16
|
"title": "指定ipv6地址开通公网访问能力"
|
|
17
17
|
}
|
|
18
18
|
],
|
|
@@ -2078,7 +2078,7 @@
|
|
|
2078
2078
|
},
|
|
2079
2079
|
{
|
|
2080
2080
|
"disabled": false,
|
|
2081
|
-
"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<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\"
|
|
2081
|
+
"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<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",
|
|
2082
2082
|
"example": "无",
|
|
2083
2083
|
"member": "string",
|
|
2084
2084
|
"name": "ComponentExtra",
|
|
@@ -6076,7 +6076,7 @@
|
|
|
6076
6076
|
},
|
|
6077
6077
|
{
|
|
6078
6078
|
"disabled": false,
|
|
6079
|
-
"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<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<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\"
|
|
6079
|
+
"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<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<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",
|
|
6080
6080
|
"example": "ComponentExtra",
|
|
6081
6081
|
"member": "string",
|
|
6082
6082
|
"name": "ComponentExtra",
|