tccli 3.0.1047.1__py2.py3-none-any.whl → 3.0.1049.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/examples/antiddos/v20200309/DescribeBGPIPL7Rules.md +87 -0
- tccli/examples/billing/v20180709/DescribeSavingPlanResourceInfo.md +24 -0
- tccli/examples/ckafka/v20190819/DescribeGroup.md +6 -5
- tccli/examples/csip/v20221121/ModifyOrganizationAccountStatus.md +21 -0
- tccli/examples/cynosdb/v20190107/AddInstances.md +2 -2
- tccli/examples/cynosdb/v20190107/DescribeClusterInstanceGrps.md +235 -79
- tccli/examples/cynosdb/v20190107/DescribeClusterParams.md +3 -1
- tccli/examples/cynosdb/v20190107/DescribeClusterPasswordComplexity.md +18 -6
- tccli/examples/cynosdb/v20190107/DescribeInstances.md +63 -55
- tccli/examples/cynosdb/v20190107/DescribeParamTemplateDetail.md +3 -1
- tccli/examples/cynosdb/v20190107/ModifyVipVport.md +3 -3
- tccli/examples/emr/v20190103/DescribeInsightList.md +41 -0
- tccli/examples/ess/v20201111/CreateFlowByFiles.md +155 -0
- tccli/examples/ess/v20201111/CreateOrganizationBatchSignUrl.md +9 -9
- tccli/examples/essbasic/v20210526/ChannelCreatePrepareFlow.md +44 -2
- tccli/examples/iotvideo/v20211125/DeleteCloudStorageEvent.md +2 -1
- tccli/examples/iotvideo/v20211125/DescribeCloudStorageOrder.md +2 -1
- tccli/examples/oceanus/v20190422/CopyJobs.md +11 -20
- tccli/examples/teo/v20220901/DescribeDefaultCertificates.md +2 -1
- tccli/examples/trocket/v20230308/CreateMQTTInstance.md +31 -0
- tccli/examples/trocket/v20230308/DescribeMQTTInstanceList.md +176 -0
- tccli/examples/trocket/v20230308/DescribeMQTTProductSKUList.md +94 -0
- tccli/examples/wedata/v20210820/DeleteCustomFunction.md +11 -8
- tccli/services/antiddos/antiddos_client.py +53 -0
- tccli/services/antiddos/v20200309/api.json +439 -0
- tccli/services/antiddos/v20200309/examples.json +8 -0
- tccli/services/billing/billing_client.py +53 -0
- tccli/services/billing/v20180709/api.json +71 -0
- tccli/services/billing/v20180709/examples.json +8 -0
- tccli/services/cfg/v20210820/api.json +21 -10
- tccli/services/ckafka/v20190819/api.json +6 -5
- tccli/services/ckafka/v20190819/examples.json +1 -1
- tccli/services/cls/v20201016/api.json +52 -23
- tccli/services/csip/csip_client.py +53 -0
- tccli/services/csip/v20221121/api.json +43 -0
- tccli/services/csip/v20221121/examples.json +8 -0
- tccli/services/cvm/v20170312/api.json +20 -20
- tccli/services/cynosdb/v20190107/api.json +415 -87
- tccli/services/cynosdb/v20190107/examples.json +12 -12
- tccli/services/emr/emr_client.py +53 -0
- tccli/services/emr/v20190103/api.json +228 -0
- tccli/services/emr/v20190103/examples.json +8 -0
- tccli/services/ess/v20201111/api.json +10 -10
- tccli/services/ess/v20201111/examples.json +15 -3
- tccli/services/essbasic/v20210526/api.json +5 -5
- tccli/services/essbasic/v20210526/examples.json +8 -2
- tccli/services/iotvideo/v20211125/api.json +28 -0
- tccli/services/iotvideo/v20211125/examples.json +2 -2
- tccli/services/live/v20180801/api.json +3 -3
- tccli/services/monitor/v20180724/api.json +1 -1
- tccli/services/oceanus/v20190422/api.json +32 -3
- tccli/services/oceanus/v20190422/examples.json +1 -1
- tccli/services/privatedns/v20201028/api.json +29 -19
- tccli/services/ssl/ssl_client.py +0 -53
- tccli/services/ssl/v20191205/api.json +0 -99
- tccli/services/ssl/v20191205/examples.json +0 -8
- tccli/services/teo/v20220901/api.json +14 -3
- tccli/services/teo/v20220901/examples.json +1 -1
- tccli/services/trocket/trocket_client.py +171 -12
- tccli/services/trocket/v20230308/api.json +492 -0
- tccli/services/trocket/v20230308/examples.json +30 -0
- tccli/services/wedata/v20210820/api.json +403 -49
- tccli/services/wedata/v20210820/examples.json +4 -4
- {tccli-3.0.1047.1.dist-info → tccli-3.0.1049.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1047.1.dist-info → tccli-3.0.1049.1.dist-info}/RECORD +69 -62
- {tccli-3.0.1047.1.dist-info → tccli-3.0.1049.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1047.1.dist-info → tccli-3.0.1049.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1047.1.dist-info → tccli-3.0.1049.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -18,10 +18,10 @@
|
|
|
18
18
|
],
|
|
19
19
|
"AddInstances": [
|
|
20
20
|
{
|
|
21
|
-
"document": "
|
|
21
|
+
"document": "新增只读实例",
|
|
22
22
|
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddInstances\n<公共请求参数>\n\n{\n \"ReadOnlyCount\": \"1\",\n \"VpcId\": \"vpc-1ptuei0b\",\n \"ClusterId\": \"cynosdbmysql-6gtlgm5l\",\n \"Memory\": \"4\",\n \"SubnetId\": \"subnet-1tmw9t4o\",\n \"Cpu\": \"2\"\n}",
|
|
23
23
|
"output": "{\n \"Response\": {\n \"TranId\": \"abc\",\n \"DealNames\": [\n \"abc\"\n ],\n \"ResourceIds\": [\n \"abc\"\n ],\n \"BigDealIds\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
24
|
-
"title": "
|
|
24
|
+
"title": "新增实例"
|
|
25
25
|
}
|
|
26
26
|
],
|
|
27
27
|
"AssociateSecurityGroups": [
|
|
@@ -356,10 +356,10 @@
|
|
|
356
356
|
],
|
|
357
357
|
"DescribeClusterInstanceGrps": [
|
|
358
358
|
{
|
|
359
|
-
"document": "",
|
|
359
|
+
"document": "查询实例组网络信息. 该接口已废弃，推荐使用DescribeClusterInstanceGroups",
|
|
360
360
|
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterInstanceGrps\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-oib3wx0i\"\n}",
|
|
361
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"InstanceGrpInfoList\": [\n {\n \"Status\": \"xx\",\n \"UpdatedTime\": \"2020-09-22 00:00:00\",\n \"Tasks\": [\n {\n \"ObjectType\": \"xx\",\n \"TaskStatus\": \"xx\",\n \"ObjectId\": \"xx\",\n \"TaskId\": 0,\n \"TaskType\": \"xx\"\n }\n ],\n \"OldAddrInfo\": {\n \"Vip\": \"xx\",\n \"Vport\": 0,\n \"ReturnTime\": \"xx\"\n },\n \"UniqVpcId\": \"xx\",\n \"WanDomain\": \"xx\",\n \"InstanceSet\": [\n {\n \"ServerlessStatus\": \"xx\",\n \"WanStatus\": \"xx\",\n \"RenewFlag\": 0,\n \"Zone\": \"xx\",\n \"DbVersion\": \"xx\",\n \"Storage\": 0,\n \"StorageId\": \"xx\",\n \"Memory\": 0,\n \"ProcessingTask\": \"xx\",\n \"Status\": \"xx\",\n \"PhysicalZone\": \"xx\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"xx\",\n \"MinCpu\": 0.0,\n \"MaxCpu\": 0.0,\n \"InstanceId\": \"xx\",\n \"ClusterId\": \"xx\",\n \"NetType\": 0,\n \"IsFreeze\": \"xx\",\n \"SubnetId\": \"xx\",\n \"InstanceType\": \"xx\",\n \"DestroyTime\": \"xx\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"xx\",\n \"ProjectId\": 0,\n \"Region\": \"xx\",\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ],\n \"CynosVersion\": \"xx\",\n \"StatusDesc\": \"xx\",\n \"InstanceName\": \"xx\",\n \"Cpu\": 0,\n \"StoragePayMode\": 0,\n \"BusinessType\": \"xx\",\n \"Tasks\": [\n {\n \"ObjectType\": \"xx\",\n \"TaskStatus\": \"xx\",\n \"ObjectId\": \"xx\",\n \"TaskId\": 0,\n \"TaskType\": \"xx\"\n }\n ],\n \"WanDomain\": \"xx\",\n \"ClusterName\": \"xx\",\n \"InstanceRole\": \"xx\",\n \"WanPort\": 0,\n \"Uin\": \"xx\",\n \"DbType\": \"xx\",\n \"Vip\": \"xx\",\n \"AppId\": 0,\n \"WanIP\": \"xx\",\n \"Vport\": 0,\n \"CreateTime\": \"2020-09-22 00:00:00\"\n }\n ],\n \"WanPort\": 0,\n \"ClusterId\": \"xx\",\n \"DeletedTime\": \"2020-09-22 00:00:00\",\n \"WanStatus\": \"xx\",\n \"CreatedTime\": \"2020-09-22 00:00:00\",\n \"Vip\": \"xx\",\n \"UniqSubnetId\": \"xx\",\n \"InstanceGrpId\": \"xx\",\n \"AppId\": 0,\n \"WanIP\": \"xx\",\n \"Vport\": 0,\n \"Type\": \"xx\",\n \"NetServiceId\": 0,\n \"ProcessingTasks\": [\n \"xx\"\n ]\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
|
|
362
|
-
"title": "
|
|
361
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceGrpInfoList\": [\n {\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"CreatedTime\": \"2020-09-22 00:00:00\",\n \"DeletedTime\": \"2020-09-22 00:00:00\",\n \"InstanceGrpId\": \"abc\",\n \"Status\": \"abc\",\n \"Type\": \"abc\",\n \"UpdatedTime\": \"2020-09-22 00:00:00\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"InstanceSet\": [\n {\n \"Uin\": \"abc\",\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"Status\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"DbMode\": \"abc\",\n \"DbType\": \"abc\",\n \"DbVersion\": \"abc\",\n \"Cpu\": 0,\n \"Memory\": 0,\n \"Storage\": 0,\n \"InstanceType\": \"abc\",\n \"InstanceRole\": \"abc\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"DestroyTime\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"ProcessingTask\": \"abc\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"abc\",\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"abc\",\n \"BusinessType\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"IsFreeze\": \"abc\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"NetType\": 0,\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"PackageId\": \"abc\",\n \"PackageType\": \"abc\"\n }\n ],\n \"InstanceIndexMode\": \"abc\"\n }\n ],\n \"UniqVpcId\": \"abc\",\n \"UniqSubnetId\": \"abc\",\n \"OldAddrInfo\": {\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"ReturnTime\": \"abc\"\n },\n \"ProcessingTasks\": [\n \"abc\"\n ],\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"NetServiceId\": 0\n }\n ],\n \"InstanceGroupInfoList\": [\n {\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"CreatedTime\": \"abc\",\n \"DeletedTime\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"Status\": \"abc\",\n \"Type\": \"abc\",\n \"UpdatedTime\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"InstanceSet\": [\n {\n \"Uin\": \"abc\",\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"Status\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"DbMode\": \"abc\",\n \"DbType\": \"abc\",\n \"DbVersion\": \"abc\",\n \"Cpu\": 0,\n \"Memory\": 0,\n \"Storage\": 0,\n \"InstanceType\": \"abc\",\n \"InstanceRole\": \"abc\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"DestroyTime\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"ProcessingTask\": \"abc\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"abc\",\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"abc\",\n \"BusinessType\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"IsFreeze\": \"abc\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"NetType\": 0,\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"PackageId\": \"abc\",\n \"PackageType\": \"abc\"\n }\n ],\n \"InstanceIndexMode\": \"abc\"\n }\n ],\n \"UniqVpcId\": \"abc\",\n \"UniqSubnetId\": \"abc\",\n \"OldAddrInfo\": {\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"ReturnTime\": \"abc\"\n },\n \"ProcessingTasks\": [\n \"abc\"\n ],\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"NetServiceId\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
362
|
+
"title": "查询实例组（废弃）"
|
|
363
363
|
}
|
|
364
364
|
],
|
|
365
365
|
"DescribeClusterParamLogs": [
|
|
@@ -374,7 +374,7 @@
|
|
|
374
374
|
{
|
|
375
375
|
"document": "查询集群参数",
|
|
376
376
|
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterParams\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbpg-1xcycbu8\"\n}",
|
|
377
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"Items\": [\n {\n \"CurrentValue\": \"abc\",\n \"Default\": \"abc\",\n \"EnumValue\": [\n \"abc\"\n ],\n \"Max\": \"abc\",\n \"Min\": \"abc\",\n \"ParamName\": \"abc\",\n \"NeedReboot\": 0,\n \"ParamType\": \"abc\",\n \"MatchType\": \"abc\",\n \"MatchValue\": \"abc\",\n \"Description\": \"abc\",\n \"IsGlobal\": 0,\n \"ModifiableInfo\": {},\n \"IsFunc\": true,\n \"Func\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
377
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"Items\": [\n {\n \"CurrentValue\": \"abc\",\n \"Default\": \"abc\",\n \"EnumValue\": [\n \"abc\"\n ],\n \"Max\": \"abc\",\n \"Min\": \"abc\",\n \"ParamName\": \"abc\",\n \"NeedReboot\": 0,\n \"ParamType\": \"abc\",\n \"MatchType\": \"abc\",\n \"MatchValue\": \"abc\",\n \"Description\": \"abc\",\n \"IsGlobal\": 0,\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"IsFunc\": true,\n \"Func\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
378
378
|
"title": "查询集群参数"
|
|
379
379
|
}
|
|
380
380
|
],
|
|
@@ -382,7 +382,7 @@
|
|
|
382
382
|
{
|
|
383
383
|
"document": "",
|
|
384
384
|
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterPasswordComplexity\n<公共请求参数>\n\n{\n \"ClusterId\": \"cynosdbmysql-bzxxrmtq\"\n}",
|
|
385
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"7613eed6-5eb5-4d17-ae69-dd93c44d7ad4\",\n \"ValidatePasswordDictionary\": {\n \"CurrentValue\": \"\",\n \"Default\": \"\",\n \"Description\": \"The dictionary words that validate_password uses for checking passwords.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"0\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_txsql_dictionary\",\n \"ParamType\": \"string\"\n },\n \"ValidatePasswordLength\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"8\",\n \"Description\": \"The minimum number of characters that validate_password requires passwords to have.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"256\",\n \"Min\": \"8\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_length\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordMixedCaseCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_mixed_case_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordNumberCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_number_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordPolicy\": {\n \"CurrentValue\": \"LOW\",\n \"Default\": \"MEDIUM\",\n \"Description\": \"The password policy enforced by validate_password.\",\n \"EnumValue\": [\n \"MEDIUM\",\n \"STRONG\"\n ],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"2\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_policy\",\n \"ParamType\": \"enum\"\n },\n \"ValidatePasswordSpecialCharCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_special_char_count\",\n \"ParamType\": \"integer\"\n }\n }\n}",
|
|
385
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"7613eed6-5eb5-4d17-ae69-dd93c44d7ad4\",\n \"ValidatePasswordDictionary\": {\n \"CurrentValue\": \"\",\n \"Default\": \"\",\n \"Description\": \"The dictionary words that validate_password uses for checking passwords.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"0\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_txsql_dictionary\",\n \"ParamType\": \"string\"\n },\n \"ValidatePasswordLength\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"8\",\n \"Description\": \"The minimum number of characters that validate_password requires passwords to have.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"256\",\n \"Min\": \"8\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_length\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordMixedCaseCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.\",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_mixed_case_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordNumberCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_number_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordPolicy\": {\n \"CurrentValue\": \"LOW\",\n \"Default\": \"MEDIUM\",\n \"Description\": \"The password policy enforced by validate_password.\",\n \"EnumValue\": [\n \"MEDIUM\",\n \"STRONG\"\n ],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"2\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_policy\",\n \"ParamType\": \"enum\"\n },\n \"ValidatePasswordSpecialCharCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_special_char_count\",\n \"ParamType\": \"integer\"\n }\n }\n}",
|
|
386
386
|
"title": "查看集群密码复杂度详情"
|
|
387
387
|
}
|
|
388
388
|
],
|
|
@@ -453,8 +453,8 @@
|
|
|
453
453
|
"DescribeInstances": [
|
|
454
454
|
{
|
|
455
455
|
"document": "查询实例列表",
|
|
456
|
-
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<公共请求参数>\n\n{\n \"Limit\": 0,\n \"Offset\": 0,\n \"OrderBy\": \"
|
|
457
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceSet\": [\n {\n \"Uin\": \"
|
|
456
|
+
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<公共请求参数>\n\n{\n \"Limit\": 0,\n \"Offset\": 0,\n \"OrderBy\": \"CREATETIME\",\n \"OrderByType\": \"ASC\",\n \"Filters\": [\n {\n \"Names\": [\n \"status\"\n ],\n \"Values\": [\n \"running\"\n ],\n \"ExactMatch\": true,\n \"Name\": \"\",\n \"Operator\": \"\"\n }\n ],\n \"DbType\": \"MYSQL\",\n \"Status\": \"running\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-1asd45qwe\"\n ]\n}",
|
|
457
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceSet\": [\n {\n \"Uin\": \"1111111\",\n \"AppId\": 0,\n \"ClusterId\": \"cynosdbmysql-asd45qwe\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"cynosdbmysql-ins-asd45qwe\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-3\",\n \"Status\": \"running\",\n \"StatusDesc\": \"运行中\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"Cpu\": 1,\n \"Memory\": 1,\n \"Storage\": 10,\n \"InstanceType\": \"rw\",\n \"InstanceRole\": \"master\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"vpc-12as56\",\n \"SubnetId\": \"subnet-123asd\",\n \"Vip\": \"192.0.0.0\",\n \"Vport\": 3306,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"\",\n \"DestroyTime\": \"\",\n \"CynosVersion\": \"2.0.10\",\n \"ProcessingTask\": \"\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"\",\n \"StorageId\": \"\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"ap-guangzhou-3\",\n \"BusinessType\": \"\",\n \"Tasks\": [\n {\n \"TaskId\": 111110,\n \"TaskType\": \"taskCreateClusters\",\n \"TaskStatus\": \"running\",\n \"ObjectId\": \"cynosdbmysql-asd45qwe\",\n \"ObjectType\": \"cluster\"\n }\n ],\n \"IsFreeze\": \"no\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"ap-guangzhou-3\",\n \"SlaveZones\": [\n \"ap-guangzhou-4\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"ha\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-asd45qwe\",\n \"VpcId\": \"vpc-12as45\",\n \"SubnetId\": \"subnet-12as45\",\n \"NetType\": 0,\n \"Vip\": \"192.0.0.0\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"PackageId\": \"\",\n \"PackageType\": \"\"\n }\n ],\n \"InstanceIndexMode\": \"\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
458
458
|
"title": "查询实例列表"
|
|
459
459
|
}
|
|
460
460
|
],
|
|
@@ -470,7 +470,7 @@
|
|
|
470
470
|
{
|
|
471
471
|
"document": "查询参数模板详情",
|
|
472
472
|
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeParamTemplateDetail\n<公共请求参数>\n\n{\n \"TemplateId\": \"4837003\"\n}",
|
|
473
|
-
"output": "{\n \"Response\": {\n \"DbMode\": \"NORMAL\",\n \"EngineVersion\": \"5.7\",\n \"Items\": [\n {\n \"CurrentValue\": \"1000\",\n \"Default\": \"0\",\n \"Description\": \"The maximum permitted number of simultaneous client connections per user.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"10240\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"max_user_connections\",\n \"ParamType\": \"integer\",\n \"SupportFunc\": false\n }\n ],\n \"RequestId\": \"ca8481bf-ba79-42ba-b90b-bd47df104add\",\n \"TemplateDescription\": \"测试模板\",\n \"TemplateId\": 4837003,\n \"TemplateName\": \"测试模板\",\n \"TotalCount\": 1\n }\n}",
|
|
473
|
+
"output": "{\n \"Response\": {\n \"DbMode\": \"NORMAL\",\n \"EngineVersion\": \"5.7\",\n \"Items\": [\n {\n \"CurrentValue\": \"1000\",\n \"Default\": \"0\",\n \"Description\": \"The maximum permitted number of simultaneous client connections per user.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"10240\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 1\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"max_user_connections\",\n \"ParamType\": \"integer\",\n \"SupportFunc\": false\n }\n ],\n \"RequestId\": \"ca8481bf-ba79-42ba-b90b-bd47df104add\",\n \"TemplateDescription\": \"测试模板\",\n \"TemplateId\": 4837003,\n \"TemplateName\": \"测试模板\",\n \"TotalCount\": 1\n }\n}",
|
|
474
474
|
"title": "查询参数模板详情"
|
|
475
475
|
}
|
|
476
476
|
],
|
|
@@ -843,8 +843,8 @@
|
|
|
843
843
|
"ModifyVipVport": [
|
|
844
844
|
{
|
|
845
845
|
"document": "",
|
|
846
|
-
"input": "https://cynosdb.tencentcloudapi.com/?Action=ModifyVipVport\n&ClusterId=
|
|
847
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": 123\n }\n}",
|
|
846
|
+
"input": "https://cynosdb.tencentcloudapi.com/?Action=ModifyVipVport\n&ClusterId=xxx\n&InstanceGrpId=xxx\n&Vip=xx.xx.xx.xx\n&<公共请求参数>",
|
|
847
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
|
|
848
848
|
"title": "修改ip端口"
|
|
849
849
|
}
|
|
850
850
|
],
|
tccli/services/emr/emr_client.py
CHANGED
|
@@ -1785,6 +1785,58 @@ def doModifyResourcePools(args, parsed_globals):
|
|
|
1785
1785
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
1786
1786
|
|
|
1787
1787
|
|
|
1788
|
+
def doDescribeInsightList(args, parsed_globals):
|
|
1789
|
+
g_param = parse_global_arg(parsed_globals)
|
|
1790
|
+
|
|
1791
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
|
1792
|
+
cred = credential.CVMRoleCredential()
|
|
1793
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
|
1794
|
+
cred = credential.STSAssumeRoleCredential(
|
|
1795
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
|
1796
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
|
1797
|
+
)
|
|
1798
|
+
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):
|
|
1799
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
|
1800
|
+
else:
|
|
1801
|
+
cred = credential.Credential(
|
|
1802
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
|
1803
|
+
)
|
|
1804
|
+
http_profile = HttpProfile(
|
|
1805
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
|
1806
|
+
reqMethod="POST",
|
|
1807
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
|
1808
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
|
1809
|
+
)
|
|
1810
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
|
1811
|
+
if g_param[OptionsDefine.Language]:
|
|
1812
|
+
profile.language = g_param[OptionsDefine.Language]
|
|
1813
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
|
1814
|
+
client = mod.EmrClient(cred, g_param[OptionsDefine.Region], profile)
|
|
1815
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
|
1816
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
|
1817
|
+
model = models.DescribeInsightListRequest()
|
|
1818
|
+
model.from_json_string(json.dumps(args))
|
|
1819
|
+
start_time = time.time()
|
|
1820
|
+
while True:
|
|
1821
|
+
rsp = client.DescribeInsightList(model)
|
|
1822
|
+
result = rsp.to_json_string()
|
|
1823
|
+
try:
|
|
1824
|
+
json_obj = json.loads(result)
|
|
1825
|
+
except TypeError as e:
|
|
1826
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
|
1827
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
|
1828
|
+
break
|
|
1829
|
+
cur_time = time.time()
|
|
1830
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
|
1831
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
|
1832
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
|
1833
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
|
1834
|
+
else:
|
|
1835
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
|
1836
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
|
1837
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
|
1838
|
+
|
|
1839
|
+
|
|
1788
1840
|
def doScaleOutCluster(args, parsed_globals):
|
|
1789
1841
|
g_param = parse_global_arg(parsed_globals)
|
|
1790
1842
|
|
|
@@ -1882,6 +1934,7 @@ ACTION_MAP = {
|
|
|
1882
1934
|
"DescribeClusterNodes": doDescribeClusterNodes,
|
|
1883
1935
|
"DescribeInstancesList": doDescribeInstancesList,
|
|
1884
1936
|
"ModifyResourcePools": doModifyResourcePools,
|
|
1937
|
+
"DescribeInsightList": doDescribeInsightList,
|
|
1885
1938
|
"ScaleOutCluster": doScaleOutCluster,
|
|
1886
1939
|
|
|
1887
1940
|
}
|
|
@@ -70,6 +70,13 @@
|
|
|
70
70
|
"output": "DescribeImpalaQueriesResponse",
|
|
71
71
|
"status": "online"
|
|
72
72
|
},
|
|
73
|
+
"DescribeInsightList": {
|
|
74
|
+
"document": "获取洞察结果信息",
|
|
75
|
+
"input": "DescribeInsightListRequest",
|
|
76
|
+
"name": "获取洞察结果",
|
|
77
|
+
"output": "DescribeInsightListResponse",
|
|
78
|
+
"status": "online"
|
|
79
|
+
},
|
|
73
80
|
"DescribeInstanceRenewNodes": {
|
|
74
81
|
"document": "查询待续费节点信息",
|
|
75
82
|
"input": "DescribeInstanceRenewNodesRequest",
|
|
@@ -2904,6 +2911,89 @@
|
|
|
2904
2911
|
],
|
|
2905
2912
|
"type": "object"
|
|
2906
2913
|
},
|
|
2914
|
+
"DescribeInsightListRequest": {
|
|
2915
|
+
"document": "DescribeInsightList请求参数结构体",
|
|
2916
|
+
"members": [
|
|
2917
|
+
{
|
|
2918
|
+
"disabled": false,
|
|
2919
|
+
"document": "集群ID",
|
|
2920
|
+
"example": "emr-xfaf11ab",
|
|
2921
|
+
"member": "string",
|
|
2922
|
+
"name": "InstanceId",
|
|
2923
|
+
"required": true,
|
|
2924
|
+
"type": "string"
|
|
2925
|
+
},
|
|
2926
|
+
{
|
|
2927
|
+
"disabled": false,
|
|
2928
|
+
"document": "获取的洞察结果开始时间，此时间针对对App或者Hive查询的开始时间的过滤",
|
|
2929
|
+
"example": "161222341",
|
|
2930
|
+
"member": "int64",
|
|
2931
|
+
"name": "StartTime",
|
|
2932
|
+
"required": true,
|
|
2933
|
+
"type": "int"
|
|
2934
|
+
},
|
|
2935
|
+
{
|
|
2936
|
+
"disabled": false,
|
|
2937
|
+
"document": "获取的洞察结果结束时间，此时间针对对App或者Hive查询的开始时间的过滤",
|
|
2938
|
+
"example": "171213123",
|
|
2939
|
+
"member": "int64",
|
|
2940
|
+
"name": "EndTime",
|
|
2941
|
+
"required": true,
|
|
2942
|
+
"type": "int"
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
"disabled": false,
|
|
2946
|
+
"document": "分页查询时的分页大小，最小1，最大100",
|
|
2947
|
+
"example": "100",
|
|
2948
|
+
"member": "int64",
|
|
2949
|
+
"name": "PageSize",
|
|
2950
|
+
"required": true,
|
|
2951
|
+
"type": "int"
|
|
2952
|
+
},
|
|
2953
|
+
{
|
|
2954
|
+
"disabled": false,
|
|
2955
|
+
"document": "分页查询时的页号，从1开始",
|
|
2956
|
+
"example": "1",
|
|
2957
|
+
"member": "int64",
|
|
2958
|
+
"name": "Page",
|
|
2959
|
+
"required": true,
|
|
2960
|
+
"type": "int"
|
|
2961
|
+
}
|
|
2962
|
+
],
|
|
2963
|
+
"type": "object"
|
|
2964
|
+
},
|
|
2965
|
+
"DescribeInsightListResponse": {
|
|
2966
|
+
"document": "DescribeInsightList返回参数结构体",
|
|
2967
|
+
"members": [
|
|
2968
|
+
{
|
|
2969
|
+
"disabled": false,
|
|
2970
|
+
"document": "总数，分页查询时使用",
|
|
2971
|
+
"example": "1231",
|
|
2972
|
+
"member": "int64",
|
|
2973
|
+
"name": "TotalCount",
|
|
2974
|
+
"output_required": true,
|
|
2975
|
+
"type": "int",
|
|
2976
|
+
"value_allowed_null": false
|
|
2977
|
+
},
|
|
2978
|
+
{
|
|
2979
|
+
"disabled": false,
|
|
2980
|
+
"document": "洞察结果数组\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2981
|
+
"example": "无",
|
|
2982
|
+
"member": "InsightResult",
|
|
2983
|
+
"name": "ResultList",
|
|
2984
|
+
"output_required": false,
|
|
2985
|
+
"type": "list",
|
|
2986
|
+
"value_allowed_null": true
|
|
2987
|
+
},
|
|
2988
|
+
{
|
|
2989
|
+
"document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
|
|
2990
|
+
"member": "string",
|
|
2991
|
+
"name": "RequestId",
|
|
2992
|
+
"type": "string"
|
|
2993
|
+
}
|
|
2994
|
+
],
|
|
2995
|
+
"type": "object"
|
|
2996
|
+
},
|
|
2907
2997
|
"DescribeInstanceRenewNodesRequest": {
|
|
2908
2998
|
"document": "DescribeInstanceRenewNodes请求参数结构体",
|
|
2909
2999
|
"members": [
|
|
@@ -5511,6 +5601,144 @@
|
|
|
5511
5601
|
],
|
|
5512
5602
|
"type": "object"
|
|
5513
5603
|
},
|
|
5604
|
+
"InsightResult": {
|
|
5605
|
+
"document": "洞察结果项",
|
|
5606
|
+
"members": [
|
|
5607
|
+
{
|
|
5608
|
+
"disabled": false,
|
|
5609
|
+
"document": "当Type为HIVE时，是Hive查询ID，当Type为MAPREDUCE，SPARK，TEZ时则是YarnAppID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5610
|
+
"example": "application_162444222_00001",
|
|
5611
|
+
"member": "string",
|
|
5612
|
+
"name": "ID",
|
|
5613
|
+
"output_required": false,
|
|
5614
|
+
"required": false,
|
|
5615
|
+
"type": "string",
|
|
5616
|
+
"value_allowed_null": true
|
|
5617
|
+
},
|
|
5618
|
+
{
|
|
5619
|
+
"disabled": false,
|
|
5620
|
+
"document": "洞察应用的类型，HIVE,SPARK,MAPREDUCE,TEZ\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5621
|
+
"example": "HIVE,SPARK,MAPREDUCE,TEZ",
|
|
5622
|
+
"member": "string",
|
|
5623
|
+
"name": "Type",
|
|
5624
|
+
"output_required": false,
|
|
5625
|
+
"required": false,
|
|
5626
|
+
"type": "string",
|
|
5627
|
+
"value_allowed_null": true
|
|
5628
|
+
},
|
|
5629
|
+
{
|
|
5630
|
+
"disabled": false,
|
|
5631
|
+
"document": "洞察规则ID\nHIVE-ScanManyMeta:元数据扫描过多\nHIVE-ScanManyPartition:大表扫描\nHIVE-SlowCompile:编译耗时过长\nHIVE-UnSuitableConfig:不合理参数\nMAPREDUCE-MapperDataSkew:Map数据倾斜\nMAPREDUCE-MapperMemWaste:MapMemory资源浪费\nMAPREDUCE-MapperSlowTask:Map慢Task\nMAPREDUCE-MapperTaskGC:MapperTaskGC\nMAPREDUCE-MemExceeded:峰值内存超限\nMAPREDUCE-ReducerDataSkew:Reduce数据倾斜\nMAPREDUCE-ReducerMemWaste:ReduceMemory资源浪费\nMAPREDUCE-ReducerSlowTask:Reduce慢Task\nMAPREDUCE-ReducerTaskGC:ReducerTaskGC\nMAPREDUCE-SchedulingDelay:调度延迟\nSPARK-CpuWaste:CPU资源浪费\nSPARK-DataSkew:数据倾斜\nSPARK-ExecutorGC:ExecutorGC\nSPARK-MemExceeded:峰值内存超限\nSPARK-MemWaste:Memory资源浪费\nSPARK-ScheduleOverhead:ScheduleOverhead\nSPARK-ScheduleSkew:调度倾斜\nSPARK-SlowTask:慢Task\nTEZ-DataSkew:数据倾斜\nTEZ-MapperDataSkew:Map数据倾斜\nTEZ-ReducerDataSkew:Reduce数据倾斜\nTEZ-TezMemWaste:Memory资源浪费\nTEZ-TezSlowTask:慢Task\nTEZ-TezTaskGC:TasksGC\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5632
|
+
"example": "MAPREDUCE-MemExceeded",
|
|
5633
|
+
"member": "string",
|
|
5634
|
+
"name": "RuleID",
|
|
5635
|
+
"output_required": false,
|
|
5636
|
+
"required": false,
|
|
5637
|
+
"type": "string",
|
|
5638
|
+
"value_allowed_null": true
|
|
5639
|
+
},
|
|
5640
|
+
{
|
|
5641
|
+
"disabled": false,
|
|
5642
|
+
"document": "洞察规则名字，可参考RuleID的说明\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5643
|
+
"example": "峰值内存超限",
|
|
5644
|
+
"member": "string",
|
|
5645
|
+
"name": "RuleName",
|
|
5646
|
+
"output_required": false,
|
|
5647
|
+
"required": false,
|
|
5648
|
+
"type": "string",
|
|
5649
|
+
"value_allowed_null": true
|
|
5650
|
+
},
|
|
5651
|
+
{
|
|
5652
|
+
"disabled": false,
|
|
5653
|
+
"document": "洞察规则解释\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5654
|
+
"example": "Map/Reduce实际峰值内存超过了申请的内存",
|
|
5655
|
+
"member": "string",
|
|
5656
|
+
"name": "RuleExplain",
|
|
5657
|
+
"output_required": false,
|
|
5658
|
+
"required": false,
|
|
5659
|
+
"type": "string",
|
|
5660
|
+
"value_allowed_null": true
|
|
5661
|
+
},
|
|
5662
|
+
{
|
|
5663
|
+
"disabled": false,
|
|
5664
|
+
"document": "详情\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5665
|
+
"example": "MAP task_1701325375205_0001_m_000000 峰值内存 724.69MB",
|
|
5666
|
+
"member": "string",
|
|
5667
|
+
"name": "Detail",
|
|
5668
|
+
"output_required": false,
|
|
5669
|
+
"required": false,
|
|
5670
|
+
"type": "string",
|
|
5671
|
+
"value_allowed_null": true
|
|
5672
|
+
},
|
|
5673
|
+
{
|
|
5674
|
+
"disabled": false,
|
|
5675
|
+
"document": "建议信息\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5676
|
+
"example": "调大申请的内存或者排查是否有数据倾斜",
|
|
5677
|
+
"member": "string",
|
|
5678
|
+
"name": "Suggestion",
|
|
5679
|
+
"output_required": false,
|
|
5680
|
+
"required": false,
|
|
5681
|
+
"type": "string",
|
|
5682
|
+
"value_allowed_null": true
|
|
5683
|
+
},
|
|
5684
|
+
{
|
|
5685
|
+
"disabled": false,
|
|
5686
|
+
"document": "洞察异常衡量值，同类型的洞察项越大越严重，不同类型的洞察项无对比意义\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5687
|
+
"example": "1231241",
|
|
5688
|
+
"member": "int64",
|
|
5689
|
+
"name": "Value",
|
|
5690
|
+
"output_required": false,
|
|
5691
|
+
"required": false,
|
|
5692
|
+
"type": "int",
|
|
5693
|
+
"value_allowed_null": true
|
|
5694
|
+
},
|
|
5695
|
+
{
|
|
5696
|
+
"disabled": false,
|
|
5697
|
+
"document": "调度任务执行ID\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5698
|
+
"example": "flow1_task1_exec_123",
|
|
5699
|
+
"member": "string",
|
|
5700
|
+
"name": "ScheduleTaskExecID",
|
|
5701
|
+
"output_required": false,
|
|
5702
|
+
"required": false,
|
|
5703
|
+
"type": "string",
|
|
5704
|
+
"value_allowed_null": true
|
|
5705
|
+
},
|
|
5706
|
+
{
|
|
5707
|
+
"disabled": false,
|
|
5708
|
+
"document": "调度流，DAG\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5709
|
+
"example": "flow1",
|
|
5710
|
+
"member": "string",
|
|
5711
|
+
"name": "ScheduleFlowName",
|
|
5712
|
+
"output_required": false,
|
|
5713
|
+
"required": false,
|
|
5714
|
+
"type": "string",
|
|
5715
|
+
"value_allowed_null": true
|
|
5716
|
+
},
|
|
5717
|
+
{
|
|
5718
|
+
"disabled": false,
|
|
5719
|
+
"document": "调度flow中的某个task节点\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5720
|
+
"example": "task1",
|
|
5721
|
+
"member": "string",
|
|
5722
|
+
"name": "ScheduleTaskName",
|
|
5723
|
+
"output_required": false,
|
|
5724
|
+
"required": false,
|
|
5725
|
+
"type": "string",
|
|
5726
|
+
"value_allowed_null": true
|
|
5727
|
+
},
|
|
5728
|
+
{
|
|
5729
|
+
"disabled": false,
|
|
5730
|
+
"document": "Yarn任务的部分核心配置\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
5731
|
+
"example": "{ \"mapreduce.job.queuename\":, \"default\", \"mapreduce.job.user.name\": \"hadoop\", \"mapreduce.job.name\": \"test_name\", \"mapreduce.map.memory.mb\": 4096, \"mapreduce.reduce.memory.mb\": 4096, \"mapreduce.map.java.opts\": \"-Xmx3500g\", \"mapreduce.reduce.java.opts\": \"-Xmx3500g\", \"airflow.ctx.task.task_id\": \"123\", \"oozie.action.id\": \"abc\", \"azkaban.job.id\": \"123\" }",
|
|
5732
|
+
"member": "string",
|
|
5733
|
+
"name": "JobConf",
|
|
5734
|
+
"output_required": false,
|
|
5735
|
+
"required": false,
|
|
5736
|
+
"type": "string",
|
|
5737
|
+
"value_allowed_null": true
|
|
5738
|
+
}
|
|
5739
|
+
],
|
|
5740
|
+
"usage": "both"
|
|
5741
|
+
},
|
|
5514
5742
|
"InstanceChargePrepaid": {
|
|
5515
5743
|
"document": "实例预付费参数，只有在付费类型为PREPAID时生效。\n",
|
|
5516
5744
|
"members": [
|
|
@@ -80,6 +80,14 @@
|
|
|
80
80
|
"title": "获取Impala查询信息列表"
|
|
81
81
|
}
|
|
82
82
|
],
|
|
83
|
+
"DescribeInsightList": [
|
|
84
|
+
{
|
|
85
|
+
"document": "",
|
|
86
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInsightList\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-d82w3t9p\",\n \"PageSize\": 10,\n \"StartTime\": 1701792000,\n \"EndTime\": 1701878399,\n \"Page\": 1\n}",
|
|
87
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 9,\n \"RequestId\": \"12345678999\",\n \"ResultList\": [\n {\n \"ScheduleTaskName\": \"\",\n \"RuleID\": \"HIVE-ScanManyPartition\",\n \"ScheduleTaskExecID\": \"\",\n \"ScheduleFlowName\": \"\",\n \"Detail\": \"easechen_dw.test_orc big scan\",\n \"Value\": 0,\n \"RuleExplain\": \"扫描分区数超过表总分区80%\",\n \"Suggestion\": \"添加分区扫描条件\",\n \"RuleName\": \"HIVE-大表扫描\",\n \"JobConf\": \"\",\n \"Type\": \"HIVE\",\n \"ID\": \"hadoop_20231206140857_1bbd81e2-b752-424b-aa61-a811a40c3099\"\n }\n ]\n }\n}",
|
|
88
|
+
"title": "获取洞察信息"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
83
91
|
"DescribeInstanceRenewNodes": [
|
|
84
92
|
{
|
|
85
93
|
"document": "预付费集群隔离后续费资源查询",
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
"status": "online"
|
|
79
79
|
},
|
|
80
80
|
"CreateFlow": {
|
|
81
|
-
"document": "通过模板创建签署流程<br/>\n适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（未认证加入或已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人（自然人）签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n注：配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument\" target=\"_blank\">创建电子文档</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。整体的逻辑如下图\n\n\n\n
|
|
81
|
+
"document": "通过模板创建签署流程<br/>\n适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（未认证加入或已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人（自然人）签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n注：配合<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument\" target=\"_blank\">创建电子文档</a>和<a href=\"https://qian.tencent.com/developers/companyApis/startFlows/StartFlow\" target=\"_blank\">发起签署流程</a>接口使用。整体的逻辑如下图\n\n\n\n注：**静默（自动）签署不支持合同签署方存在填写**功能\n<br>\n**相关视频指引**\n<a href=\"https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4\" target=\"_blank\">创建静默（自动）签署模板和开通自动签署</a>",
|
|
82
82
|
"input": "CreateFlowRequest",
|
|
83
83
|
"name": "模板发起合同-创建签署流程",
|
|
84
84
|
"output": "CreateFlowResponse",
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
"status": "online"
|
|
93
93
|
},
|
|
94
94
|
"CreateFlowByFiles": {
|
|
95
|
-
"document": "此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>\n适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>\n\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（未认证加入或已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人（自然人）签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n\n该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>\n\n\n\n\n注：\n-
|
|
95
|
+
"document": "此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>\n适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>\n\n<table>\n\t<thead>\n\t\t<tr>\n\t\t\t<th>签署人类别</th>\n\t\t\t<th>需要提前准备的信息</th>\n\t\t</tr>\n\t</thead>\n\t<tbody>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（未认证加入或已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>自己企业的员工签署（已认证加入）</td>\n\t\t\t<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>其他企业的员工签署</td>\n\t\t\t<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>个人（自然人）签署</td>\n\t\t\t<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>\n\t\t</tr>\n\t</tbody>\n</table>\n\n\n\n该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>\n\n\n\n\n注：\n- 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）\n- **静默（自动）签署不支持合同签署方存在填写**功能",
|
|
96
96
|
"input": "CreateFlowByFilesRequest",
|
|
97
97
|
"name": "用PDF文件创建签署流程",
|
|
98
98
|
"output": "CreateFlowByFilesResponse",
|
|
@@ -183,7 +183,7 @@
|
|
|
183
183
|
"status": "online"
|
|
184
184
|
},
|
|
185
185
|
"CreateOrganizationBatchSignUrl": {
|
|
186
|
-
"document": "使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n附注：\n- 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。\n- 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile
|
|
186
|
+
"document": "使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n附注：\n- 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。\n- 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。\n- 仅支持待签署状态的合同生成签署链接。",
|
|
187
187
|
"input": "CreateOrganizationBatchSignUrlRequest",
|
|
188
188
|
"name": "获取企业签署合同web页面",
|
|
189
189
|
"output": "CreateOrganizationBatchSignUrlResponse",
|
|
@@ -463,7 +463,7 @@
|
|
|
463
463
|
"status": "online"
|
|
464
464
|
},
|
|
465
465
|
"StartFlow": {
|
|
466
|
-
"document": "此接口用于启动流程。它是模板发起合同的最后一步。\n在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。\n\n\n\n注：\
|
|
466
|
+
"document": "此接口用于启动流程。它是模板发起合同的最后一步。\n在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。\n\n\n\n注：\n1.<font color=\"red\">合同发起后就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）\n\n2.<font color=\"red\">静默（自动）签署不支持合同签署方存在填写</font>功能\n\n3.<font color=\"red\">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。",
|
|
467
467
|
"input": "StartFlowRequest",
|
|
468
468
|
"name": "模板发起合同-发起签署流程",
|
|
469
469
|
"output": "StartFlowResponse",
|
|
@@ -1638,7 +1638,7 @@
|
|
|
1638
1638
|
},
|
|
1639
1639
|
{
|
|
1640
1640
|
"disabled": false,
|
|
1641
|
-
"document": "控件唯一ID。\n\n**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例：\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >，则会在PDF文件中有且仅有\"甲方签署\"关键字的地方（<font color=\"red\">前后不能有其他字符</font >）进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前后可以有其他字符</font >）都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"^甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前面不能有其他字符</font >）都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署^</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">后面不能有其他字符</font >）都会执行相应操作。\n\n\n注：`控件ID可以在一个PDF中不可重复`\n",
|
|
1641
|
+
"document": "控件唯一ID。\n\n**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。\n\n**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过\"^\"来决定是否使用关键字整词匹配能力。\n\n例：\n\n- 如传入的关键字<font color=\"red\">\"^甲方签署^\"</font >，则会在PDF文件中有且仅有\"甲方签署\"关键字的地方（<font color=\"red\">前后不能有其他字符</font >）进行对应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前后可以有其他字符</font >）都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"^甲方签署</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">前面不能有其他字符</font >）都会执行相应操作。\n- 如传入的关键字为<font color=\"red\">\"甲方签署^</font >\"，则PDF文件中每个出现关键字的位置（<font color=\"red\">后面不能有其他字符</font >）都会执行相应操作。\n\n\n注：`控件ID可以在一个PDF中不可重复`\n\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentId在模板编辑页面的位置</a>\n",
|
|
1642
1642
|
"example": "无",
|
|
1643
1643
|
"member": "string",
|
|
1644
1644
|
"name": "ComponentId",
|
|
@@ -1649,7 +1649,7 @@
|
|
|
1649
1649
|
},
|
|
1650
1650
|
{
|
|
1651
1651
|
"disabled": false,
|
|
1652
|
-
"document": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。\n\n**在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。\n\n注：`控件名可以在一个PDF中可以重复`\n",
|
|
1652
|
+
"document": "**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。\n\n**在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。\n\n注：`控件名可以在一个PDF中可以重复`\n\n<a href=\"https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png\" target=\"_blank\">点击查看ComponentName在模板页面的位置</a>",
|
|
1653
1653
|
"example": "price",
|
|
1654
1654
|
"member": "string",
|
|
1655
1655
|
"name": "ComponentName",
|
|
@@ -2779,8 +2779,8 @@
|
|
|
2779
2779
|
},
|
|
2780
2780
|
{
|
|
2781
2781
|
"disabled": false,
|
|
2782
|
-
"document": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：\n<ul><li>{合同名称} </li>\n<li>{发起方企业} </li>\n<li>{发起方姓名} </li>\n<li>{签署方N企业}</li>\n<li>{签署方N姓名}</li></ul>\n其中，N表示签署方的编号，从1开始，不能超过签署人的数量。\n\n例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子\n\n合同名称：租房合同 \n发起方：腾讯公司(张三) \n签署方：李四\n\n",
|
|
2783
|
-
"example": "合同名称:{合同名称} {发起方企业}
|
|
2782
|
+
"document": "您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：\n<ul><li>{合同名称} </li>\n<li>{发起方企业} </li>\n<li>{发起方姓名} </li>\n<li>{签署方N企业}</li>\n<li>{签署方N姓名}</li></ul>\n其中，N表示签署方的编号，从1开始，不能超过签署人的数量。\n\n例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子\n\n合同名称：租房合同 \n发起方：腾讯公司(张三) \n签署方：李四\n\n\n\n\n",
|
|
2783
|
+
"example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石",
|
|
2784
2784
|
"member": "string",
|
|
2785
2785
|
"name": "CustomShowMap",
|
|
2786
2786
|
"required": false,
|
|
@@ -3408,8 +3408,8 @@
|
|
|
3408
3408
|
},
|
|
3409
3409
|
{
|
|
3410
3410
|
"disabled": false,
|
|
3411
|
-
"document": "
|
|
3412
|
-
"example": "合同名称:{合同名称} {发起方企业}
|
|
3411
|
+
"document": "您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：\n<ul><li>{合同名称} </li>\n<li>{发起方企业} </li>\n<li>{发起方姓名} </li>\n<li>{签署方N企业}</li>\n<li>{签署方N姓名}</li></ul>\n其中，N表示签署方的编号，从1开始，不能超过签署人的数量。\n\n例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子\n\n合同名称：租房合同 \n发起方：腾讯公司(张三) \n签署方：李四\n\n\n\n",
|
|
3412
|
+
"example": "合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石",
|
|
3413
3413
|
"member": "string",
|
|
3414
3414
|
"name": "CustomShowMap",
|
|
3415
3415
|
"required": false,
|