tccli 3.0.1188.1__py2.py3-none-any.whl → 3.0.1190.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +2 -1
- tccli/services/aiart/aiart_client.py +53 -0
- tccli/services/aiart/v20221229/api.json +107 -0
- tccli/services/aiart/v20221229/examples.json +8 -0
- tccli/services/apm/v20210622/api.json +3 -1
- tccli/services/billing/v20180709/api.json +3 -0
- tccli/services/billing/v20180709/examples.json +1 -1
- tccli/services/cfg/v20210820/api.json +20 -5
- tccli/services/cfw/v20190904/api.json +82 -2
- tccli/services/ckafka/v20190819/api.json +5 -5
- tccli/services/dcdb/dcdb_client.py +106 -0
- tccli/services/dcdb/v20180411/api.json +318 -0
- tccli/services/dcdb/v20180411/examples.json +28 -0
- tccli/services/dnspod/dnspod_client.py +53 -0
- tccli/services/dnspod/v20210323/api.json +118 -0
- tccli/services/dnspod/v20210323/examples.json +8 -0
- tccli/services/emr/emr_client.py +269 -4
- tccli/services/emr/v20190103/api.json +591 -0
- tccli/services/emr/v20190103/examples.json +46 -0
- tccli/services/es/es_client.py +53 -0
- tccli/services/es/v20180416/api.json +54 -0
- tccli/services/es/v20180416/examples.json +14 -0
- tccli/services/ess/v20201111/api.json +9 -9
- tccli/services/ess/v20201111/examples.json +7 -1
- tccli/services/essbasic/essbasic_client.py +53 -0
- tccli/services/essbasic/v20210526/api.json +120 -0
- tccli/services/essbasic/v20210526/examples.json +14 -0
- tccli/services/iotexplorer/v20190423/api.json +2 -2
- tccli/services/iss/iss_client.py +118 -65
- tccli/services/iss/v20230517/api.json +78 -0
- tccli/services/iss/v20230517/examples.json +8 -0
- tccli/services/mariadb/mariadb_client.py +110 -4
- tccli/services/mariadb/v20170312/api.json +318 -0
- tccli/services/mariadb/v20170312/examples.json +16 -0
- tccli/services/mps/v20190612/api.json +131 -3
- tccli/services/ocr/v20181119/api.json +22 -2
- tccli/services/redis/redis_client.py +110 -4
- tccli/services/redis/v20180412/api.json +209 -0
- tccli/services/redis/v20180412/examples.json +16 -0
- tccli/services/sms/v20210111/api.json +9 -9
- tccli/services/ssl/v20191205/api.json +3 -3
- tccli/services/ssl/v20191205/examples.json +2 -2
- tccli/services/teo/v20220901/api.json +14 -14
- tccli/services/tke/tke_client.py +364 -46
- tccli/services/tke/v20180525/api.json +9 -0
- tccli/services/tke/v20220501/api.json +525 -0
- tccli/services/tke/v20220501/examples.json +54 -0
- tccli/services/tsf/v20180326/api.json +74 -29
- tccli/services/vdb/v20230616/api.json +491 -0
- tccli/services/vdb/v20230616/examples.json +46 -0
- tccli/services/vdb/vdb_client.py +265 -0
- tccli/services/vod/v20240718/api.json +121 -0
- tccli/services/vod/v20240718/examples.json +31 -0
- tccli/services/vod/vod_client.py +58 -0
- tccli/services/vpc/v20170312/api.json +13 -4
- {tccli-3.0.1188.1.dist-info → tccli-3.0.1190.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1188.1.dist-info → tccli-3.0.1190.1.dist-info}/RECORD +61 -59
- {tccli-3.0.1188.1.dist-info → tccli-3.0.1190.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1188.1.dist-info → tccli-3.0.1190.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1188.1.dist-info → tccli-3.0.1190.1.dist-info}/license_files/LICENSE +0 -0
@@ -32,6 +32,14 @@
|
|
32
32
|
"title": "创建实例"
|
33
33
|
}
|
34
34
|
],
|
35
|
+
"CreateSLInstance": [
|
36
|
+
{
|
37
|
+
"document": "Lite Hbase 创建实例",
|
38
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSLInstance\n<公共请求参数>\n\n{\n \"InstanceName\": \"sl-haoyuhua-test-create\",\n \"PayMode\": 0,\n \"DiskType\": \"CLOUD_PREMIUM\",\n \"DiskSize\": 100,\n \"NodeType\": \"4C16G\",\n \"ZoneSettings\": [\n {\n \"Zone\": \"ap-guangzhou-2\",\n \"VPCSettings\": {\n \"VpcId\": \"vpc-dcfhrh73\",\n \"SubnetId\": \"subnet-5bhc4kly\"\n },\n \"NodeNum\": 1\n },\n {\n \"Zone\": \"ap-guangzhou-2\",\n \"VPCSettings\": {\n \"VpcId\": \"vpc-dcfhrh73\",\n \"SubnetId\": \"subnet-5bhc4kly\"\n },\n \"NodeNum\": 1\n },\n {\n \"Zone\": \"ap-guangzhou-2\",\n \"VPCSettings\": {\n \"VpcId\": \"vpc-dcfhrh73\",\n \"SubnetId\": \"subnet-5bhc4kly\"\n },\n \"NodeNum\": 1\n }\n ],\n \"Tags\": []\n}",
|
39
|
+
"output": "{\n \"Response\": {\n \"InstanceId\": \"emr-8qrmc34c\",\n \"RequestId\": \"983e4dae-1cb4-40cb-8476-3231a6849696\"\n }\n}",
|
40
|
+
"title": "Lite Hbase 创建实例"
|
41
|
+
}
|
42
|
+
],
|
35
43
|
"DeleteAutoScaleStrategy": [
|
36
44
|
{
|
37
45
|
"document": "",
|
@@ -200,6 +208,22 @@
|
|
200
208
|
"title": "YARN资源调度-变更详情"
|
201
209
|
}
|
202
210
|
],
|
211
|
+
"DescribeSLInstance": [
|
212
|
+
{
|
213
|
+
"document": "Lite HBase 查询实例信息",
|
214
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSLInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-3o9tms4i\"\n}",
|
215
|
+
"output": "{\n \"Response\": {\n \"DiskSize\": 100,\n \"DiskType\": \"性能云存储\",\n \"InstanceName\": \"sl-haoyuhua-test-create\",\n \"NodeType\": \"4C16G\",\n \"PayMode\": 0,\n \"RequestId\": \"a316989f-9316-4205-a2a3-64ab841aee14\",\n \"ZoneSettings\": [\n {\n \"NodeNum\": 1,\n \"VPCSettings\": {\n \"SubnetId\": \"subnet-5bhc4kly\",\n \"VpcId\": \"vpc-dcfhrh73\"\n },\n \"Zone\": \"ap-guangzhou-2\"\n },\n {\n \"NodeNum\": 1,\n \"VPCSettings\": {\n \"SubnetId\": \"subnet-5bhc4kly\",\n \"VpcId\": \"vpc-dcfhrh73\"\n },\n \"Zone\": \"ap-guangzhou-2\"\n },\n {\n \"NodeNum\": 1,\n \"VPCSettings\": {\n \"SubnetId\": \"subnet-5bhc4kly\",\n \"VpcId\": \"vpc-dcfhrh73\"\n },\n \"Zone\": \"ap-guangzhou-2\"\n }\n ]\n }\n}",
|
216
|
+
"title": "Lite HBase 查询实例信息"
|
217
|
+
}
|
218
|
+
],
|
219
|
+
"DescribeSLInstanceList": [
|
220
|
+
{
|
221
|
+
"document": "Lite HBase 查询实例列表",
|
222
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSLInstanceList\n<公共请求参数>\n\n{\n \"Offset\": 0,\n \"Limit\": 10,\n \"OrderField\": \"AddTime\",\n \"Asc\": 1,\n \"DisplayStrategy\": \"clusterList\",\n \"Filters\": []\n}",
|
223
|
+
"output": "{\n \"Response\": {\n \"InstancesList\": [\n {\n \"AddTime\": \"2024-03-14 17:40:19\",\n \"AppId\": 251233704,\n \"ClusterId\": \"emr-2ecolb9q\",\n \"ClusterName\": \"EMR-haosen\",\n \"Id\": 126358006,\n \"PayMode\": 0,\n \"RegionId\": 1,\n \"Status\": 3,\n \"StatusDesc\": \"集群生产中\",\n \"SubnetId\": 2666622,\n \"Tags\": [],\n \"VpcId\": 11406751,\n \"Zone\": \"ap-guangzhou-2\",\n \"ZoneId\": 100002\n }\n ],\n \"RequestId\": \"fde6361c-205a-45e5-8bec-34b9100fc5b0\",\n \"TotalCnt\": 1\n }\n}",
|
224
|
+
"title": "Lite HBase 查询实例列表"
|
225
|
+
}
|
226
|
+
],
|
203
227
|
"DescribeServiceNodeInfos": [
|
204
228
|
{
|
205
229
|
"document": "查询服务进程信息",
|
@@ -348,6 +372,14 @@
|
|
348
372
|
"title": "test"
|
349
373
|
}
|
350
374
|
],
|
375
|
+
"ModifySLInstance": [
|
376
|
+
{
|
377
|
+
"document": "Lite HBase 修改实例节点数",
|
378
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifySLInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-3o9tms4i\",\n \"Zone\": \"ap-guangzhou-2\",\n \"NodeNum\": 2\n}",
|
379
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"7837b979-fcc2-4bfb-b81b-88a532345b82\"\n }\n}",
|
380
|
+
"title": "Lite HBase 修改实例节点数"
|
381
|
+
}
|
382
|
+
],
|
351
383
|
"ModifyUserManagerPwd": [
|
352
384
|
{
|
353
385
|
"document": "test",
|
@@ -436,6 +468,20 @@
|
|
436
468
|
"title": "销毁实例"
|
437
469
|
}
|
438
470
|
],
|
471
|
+
"TerminateSLInstance": [
|
472
|
+
{
|
473
|
+
"document": "",
|
474
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TerminateSLInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-6vexh3oi\"\n}",
|
475
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"f4163a60-4801-449b-83d0-6f9ec2c7a07f\"\n }\n}",
|
476
|
+
"title": "销毁EMR Serverless实例"
|
477
|
+
},
|
478
|
+
{
|
479
|
+
"document": "Lite HBase 销毁实例",
|
480
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TerminateSLInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-8qrmc34c\"\n}",
|
481
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a0b8ffca-02eb-47ea-9c93-a4c8db4e4585\"\n }\n}",
|
482
|
+
"title": "Lite HBase 销毁实例"
|
483
|
+
}
|
484
|
+
],
|
439
485
|
"TerminateTasks": [
|
440
486
|
{
|
441
487
|
"document": "销毁TASK节点",
|
tccli/services/es/es_client.py
CHANGED
@@ -1577,6 +1577,58 @@ def doDescribeInstanceOperations(args, parsed_globals):
|
|
1577
1577
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1578
1578
|
|
1579
1579
|
|
1580
|
+
def doDescribeSpaceKibanaTools(args, parsed_globals):
|
1581
|
+
g_param = parse_global_arg(parsed_globals)
|
1582
|
+
|
1583
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
1584
|
+
cred = credential.CVMRoleCredential()
|
1585
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
1586
|
+
cred = credential.STSAssumeRoleCredential(
|
1587
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
1588
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
1589
|
+
)
|
1590
|
+
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):
|
1591
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
1592
|
+
else:
|
1593
|
+
cred = credential.Credential(
|
1594
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
1595
|
+
)
|
1596
|
+
http_profile = HttpProfile(
|
1597
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
1598
|
+
reqMethod="POST",
|
1599
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
1600
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
1601
|
+
)
|
1602
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
1603
|
+
if g_param[OptionsDefine.Language]:
|
1604
|
+
profile.language = g_param[OptionsDefine.Language]
|
1605
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
1606
|
+
client = mod.EsClient(cred, g_param[OptionsDefine.Region], profile)
|
1607
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
1608
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
1609
|
+
model = models.DescribeSpaceKibanaToolsRequest()
|
1610
|
+
model.from_json_string(json.dumps(args))
|
1611
|
+
start_time = time.time()
|
1612
|
+
while True:
|
1613
|
+
rsp = client.DescribeSpaceKibanaTools(model)
|
1614
|
+
result = rsp.to_json_string()
|
1615
|
+
try:
|
1616
|
+
json_obj = json.loads(result)
|
1617
|
+
except TypeError as e:
|
1618
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
1619
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
1620
|
+
break
|
1621
|
+
cur_time = time.time()
|
1622
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
1623
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
1624
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
1625
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
1626
|
+
else:
|
1627
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
1628
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
1629
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1630
|
+
|
1631
|
+
|
1580
1632
|
def doDescribeLogstashPipelines(args, parsed_globals):
|
1581
1633
|
g_param = parse_global_arg(parsed_globals)
|
1582
1634
|
|
@@ -2970,6 +3022,7 @@ ACTION_MAP = {
|
|
2970
3022
|
"DescribeViews": doDescribeViews,
|
2971
3023
|
"UpdateLogstashInstance": doUpdateLogstashInstance,
|
2972
3024
|
"DescribeInstanceOperations": doDescribeInstanceOperations,
|
3025
|
+
"DescribeSpaceKibanaTools": doDescribeSpaceKibanaTools,
|
2973
3026
|
"DescribeLogstashPipelines": doDescribeLogstashPipelines,
|
2974
3027
|
"DescribeLogstashInstances": doDescribeLogstashInstances,
|
2975
3028
|
"DescribeIndexList": doDescribeIndexList,
|
@@ -196,6 +196,13 @@
|
|
196
196
|
"output": "DescribeServerlessSpacesResponse",
|
197
197
|
"status": "online"
|
198
198
|
},
|
199
|
+
"DescribeSpaceKibanaTools": {
|
200
|
+
"document": "space维度的kibana获取登录token",
|
201
|
+
"input": "DescribeSpaceKibanaToolsRequest",
|
202
|
+
"name": "space维度的kibana获取登录token",
|
203
|
+
"output": "DescribeSpaceKibanaToolsResponse",
|
204
|
+
"status": "online"
|
205
|
+
},
|
199
206
|
"DescribeUserCosSnapshotList": {
|
200
207
|
"document": "查询快照信息接口",
|
201
208
|
"input": "DescribeUserCosSnapshotListRequest",
|
@@ -3731,6 +3738,53 @@
|
|
3731
3738
|
],
|
3732
3739
|
"type": "object"
|
3733
3740
|
},
|
3741
|
+
"DescribeSpaceKibanaToolsRequest": {
|
3742
|
+
"document": "DescribeSpaceKibanaTools请求参数结构体",
|
3743
|
+
"members": [
|
3744
|
+
{
|
3745
|
+
"disabled": false,
|
3746
|
+
"document": "space的ID",
|
3747
|
+
"example": "space-xxx",
|
3748
|
+
"member": "string",
|
3749
|
+
"name": "SpaceId",
|
3750
|
+
"required": true,
|
3751
|
+
"type": "string"
|
3752
|
+
}
|
3753
|
+
],
|
3754
|
+
"type": "object"
|
3755
|
+
},
|
3756
|
+
"DescribeSpaceKibanaToolsResponse": {
|
3757
|
+
"document": "DescribeSpaceKibanaTools返回参数结构体",
|
3758
|
+
"members": [
|
3759
|
+
{
|
3760
|
+
"disabled": false,
|
3761
|
+
"document": "该token用于登录内嵌kibana",
|
3762
|
+
"example": "无",
|
3763
|
+
"member": "string",
|
3764
|
+
"name": "KibanaToken",
|
3765
|
+
"output_required": true,
|
3766
|
+
"type": "string",
|
3767
|
+
"value_allowed_null": false
|
3768
|
+
},
|
3769
|
+
{
|
3770
|
+
"disabled": false,
|
3771
|
+
"document": "token的过期时间",
|
3772
|
+
"example": "无",
|
3773
|
+
"member": "int64",
|
3774
|
+
"name": "ExpireTime",
|
3775
|
+
"output_required": true,
|
3776
|
+
"type": "int",
|
3777
|
+
"value_allowed_null": false
|
3778
|
+
},
|
3779
|
+
{
|
3780
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
3781
|
+
"member": "string",
|
3782
|
+
"name": "RequestId",
|
3783
|
+
"type": "string"
|
3784
|
+
}
|
3785
|
+
],
|
3786
|
+
"type": "object"
|
3787
|
+
},
|
3734
3788
|
"DescribeUserCosSnapshotListRequest": {
|
3735
3789
|
"document": "DescribeUserCosSnapshotList请求参数结构体",
|
3736
3790
|
"members": [
|
@@ -224,6 +224,20 @@
|
|
224
224
|
"title": "获取Serverless索引空间列表"
|
225
225
|
}
|
226
226
|
],
|
227
|
+
"DescribeSpaceKibanaTools": [
|
228
|
+
{
|
229
|
+
"document": "索引获取token登录space维度的kibana",
|
230
|
+
"input": "POST / HTTP/1.1\nHost: es.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKibanaTools\n<公共请求参数>\n\n{\n \"SpaceId\": \"abc\"\n}",
|
231
|
+
"output": "{\n \"Response\": {\n \"KibanaToken\": \"abc\",\n \"ExpireTime\": 0,\n \"RequestId\": \"abc\"\n }\n}",
|
232
|
+
"title": "索引获取token"
|
233
|
+
},
|
234
|
+
{
|
235
|
+
"document": "用于登录space维度的内嵌的kibana",
|
236
|
+
"input": "POST / HTTP/1.1\nHost: es.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateServerlessInstanceUser\n<公共请求参数>\n\n{\n \"SpaceId\": \"abc\"\n}",
|
237
|
+
"output": "{\n \"Response\": {\n \"KibanaToken\": \"abc\",\n \"ExpireTime\": 0,\n \"RequestId\": \"abc\"\n }\n}",
|
238
|
+
"title": "kibana内嵌登录token获取"
|
239
|
+
}
|
240
|
+
],
|
227
241
|
"DescribeUserCosSnapshotList": [
|
228
242
|
{
|
229
243
|
"document": "",
|
@@ -337,9 +337,9 @@
|
|
337
337
|
"status": "online"
|
338
338
|
},
|
339
339
|
"CreateUserVerifyUrl": {
|
340
|
-
"document": "
|
340
|
+
"document": "生成个人用户实名认证链接,个人用户点击此链接进入实名流程(若用户已完成实名认证,则直接进入成功页面)。\n\n注: 调用此接口需要购买<font color=\"red\"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。",
|
341
341
|
"input": "CreateUserVerifyUrlRequest",
|
342
|
-
"name": "
|
342
|
+
"name": "获取个人用户实名链接",
|
343
343
|
"output": "CreateUserVerifyUrlResponse",
|
344
344
|
"status": "online"
|
345
345
|
},
|
@@ -491,7 +491,7 @@
|
|
491
491
|
"status": "online"
|
492
492
|
},
|
493
493
|
"DescribeOrganizationAuthStatus": {
|
494
|
-
"document": "
|
494
|
+
"document": "查询企业认证状态- 仅通过[CreateOrganizationAuthUrl](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 和[CreateBatchOrganizationRegistrationTasks](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)这两个接口进行引导认证的企业,调用方企业可以依据这个接口,查询认证状态。",
|
495
495
|
"input": "DescribeOrganizationAuthStatusRequest",
|
496
496
|
"name": "查询企业认证状态",
|
497
497
|
"output": "DescribeOrganizationAuthStatusResponse",
|
@@ -526,7 +526,7 @@
|
|
526
526
|
"status": "online"
|
527
527
|
},
|
528
528
|
"DescribeThirdPartyAuthCode": {
|
529
|
-
"document": "通过AuthCode查询个人用户是否实名\n\n\n注意: \n<ul>\n<li
|
529
|
+
"document": "通过AuthCode查询个人用户是否实名\n\n\n注意: \n<ul>\n<li>此接口为合作引流场景使用,使用<b>有白名单限制</b>,使用前请联系对接的客户经理沟通。</li>\n<li><b>AuthCode 只能使用一次</b>,查询一次再次查询会返回错误</li>\n</ul>",
|
530
530
|
"input": "DescribeThirdPartyAuthCodeRequest",
|
531
531
|
"name": "通过AuthCode查询个人用户是否实名",
|
532
532
|
"output": "DescribeThirdPartyAuthCodeResponse",
|
@@ -7026,7 +7026,7 @@
|
|
7026
7026
|
"members": [
|
7027
7027
|
{
|
7028
7028
|
"disabled": false,
|
7029
|
-
"document": "
|
7029
|
+
"document": "腾讯电子签小程序的实名认证链接。 如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n<b>1.如果EndPoint是APP</b>,\n得到的链接类似于<a href=\"\">pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<b>2.如果EndPoint是HTTP</b>,\n得到的链接类似于<a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<b>3.如果EndPoint是HTTP_SHORT_URL</b>,\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n注: <font color=\"red\">生成的链路后面不能再增加参数</font>\n",
|
7030
7030
|
"example": "无",
|
7031
7031
|
"member": "string",
|
7032
7032
|
"name": "Url",
|
@@ -7036,7 +7036,7 @@
|
|
7036
7036
|
},
|
7037
7037
|
{
|
7038
7038
|
"disabled": false,
|
7039
|
-
"document": "
|
7039
|
+
"document": "链接失效期限,为Unix时间戳(单位秒),有如下规则:\n\n<ul>\n<li>如果指定更换绑定手机号的用户(指定用户ID或姓名等信息),则设定的链接失效期限为7天后。</li>\n<li>如果没有指定更换绑定手机号的用户,则生成通用跳转到个人换手机号的界面,链接不会过期。</li>\n</ul>",
|
7040
7040
|
"example": "无",
|
7041
7041
|
"member": "int64",
|
7042
7042
|
"name": "ExpireTime",
|
@@ -7112,7 +7112,7 @@
|
|
7112
7112
|
},
|
7113
7113
|
{
|
7114
7114
|
"disabled": false,
|
7115
|
-
"document": "要跳转的链接类型\n\n
|
7115
|
+
"document": "要跳转的链接类型\n\n<ul>\n<li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>\n<li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>\n<li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>\n<li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li>\n<li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li>\n</ul>\n\n注:如果不传递,默认值是 <font color=\"red\"> APP </font>",
|
7116
7116
|
"example": "APP",
|
7117
7117
|
"member": "string",
|
7118
7118
|
"name": "Endpoint",
|
@@ -7145,7 +7145,7 @@
|
|
7145
7145
|
"members": [
|
7146
7146
|
{
|
7147
7147
|
"disabled": false,
|
7148
|
-
"document": "腾讯电子签小程序的实名认证链接。\n如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n
|
7148
|
+
"document": "腾讯电子签小程序的实名认证链接。\n如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。\n\n<strong>1.如果EndPoint是APP</strong>:\n得到的链接类似于<a href=\"\">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<strong>2.如果EndPoint是HTTP</strong>:\n得到的链接类似于 <a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>4.如果EndPoint是H5</strong>:\n得到的链接类似于 <a href=\"\">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署\n\n<strong>5.如果EndPoint是H5_SHORT_URL</strong>:\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署\n\n\n`注:` <font color=\"red\">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>\n示例值:https://essurl.cn/2n**42Nd",
|
7149
7149
|
"example": "无",
|
7150
7150
|
"member": "string",
|
7151
7151
|
"name": "UserVerifyUrl",
|
@@ -7155,7 +7155,7 @@
|
|
7155
7155
|
},
|
7156
7156
|
{
|
7157
7157
|
"disabled": false,
|
7158
|
-
"document": "
|
7158
|
+
"document": "链接过期时间,为Unix时间戳(单位为秒)。",
|
7159
7159
|
"example": "无",
|
7160
7160
|
"member": "int64",
|
7161
7161
|
"name": "ExpireTime",
|
@@ -172,6 +172,12 @@
|
|
172
172
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ClientIp\": \"1.2.3.4\",\n \"UserId\": \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n },\n \"FlowApproverInfo\": {\n \"ApproverType\": 1,\n \"ApproverMobile\": \"13200000000\",\n \"ApproverName\": \"典子谦\",\n \"ApproverIdCardNumber\": \"620000198802020000\",\n \"ApproverIdCardType\": \"ID_CARD\"\n }\n}",
|
173
173
|
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"流程ID和合同组ID不能同时为空,请检查参数后再试\"\n },\n \"RequestId\": \"s17007***76147\"\n }\n}",
|
174
174
|
"title": "错误示例,为个人用户生成H5批量签署链接,没有指定合同流程ID信息,也没有指定合同组ID信息"
|
175
|
+
},
|
176
|
+
{
|
177
|
+
"document": "1. 创建批量签署链接的合同签署方,必须都是动态签署人且未补充。\n2. 批量签署的合同数量不少于1份,不超过100份\n3. 上述合同签署方类型必须一致,均为待C端签署人签署状态\n4. 企业已经购买了专业版或以上版本套餐",
|
178
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": 1\n },\n \"FlowIds\": [\n \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ]\n}",
|
179
|
+
"output": "{\n \"Response\": {\n \"FlowApproverUrlInfo\": {\n \"ApproverMobile\": \"\",\n \"ApproverName\": \"\",\n \"ApproverType\": 1,\n \"LongUrl\": \"https://quick.qian.tencent.cn/guide?Code=yDwiB**FOE&CodeType=QUICK&shortKey=yDwiB**1e5&token=Rg0**Q\",\n \"SignUrl\": \"https://essurl.cn/Rg0**Q\"\n },\n \"RequestId\": \"s1698**9686\"\n }\n}",
|
180
|
+
"title": "发起合同后,获取C端签署人的H5批量领取链接"
|
175
181
|
}
|
176
182
|
],
|
177
183
|
"CreateBatchSignUrl": [
|
@@ -1439,7 +1445,7 @@
|
|
1439
1445
|
"DescribeOrganizationAuthStatus": [
|
1440
1446
|
{
|
1441
1447
|
"document": "查询企业认证状态",
|
1442
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOrganizationAuthStatus\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"
|
1448
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOrganizationAuthStatus\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDRCLUUgygq2xun5UuO4zjEwg0vjoimj\"\n },\n \"UniformSocialCreditCode\": \"\",\n \"LegalName\": \"\",\n \"OrganizationName\": \"测试企业\"\n}",
|
1443
1449
|
"output": "{\n \"Response\": {\n \"AuthRecords\": [\n {\n \"AuditStatus\": 0,\n \"AuthType\": 3,\n \"OperatorMobile\": \"132****0000\",\n \"OperatorName\": \"典*谦\"\n }\n ],\n \"AuthStatus\": 2,\n \"IsVerified\": true,\n \"RequestId\": \"s1687254031099376002\"\n }\n}",
|
1444
1450
|
"title": "查询企业认证状态"
|
1445
1451
|
}
|
@@ -1111,6 +1111,58 @@ def doChannelCreateFlowApprovers(args, parsed_globals):
|
|
1111
1111
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1112
1112
|
|
1113
1113
|
|
1114
|
+
def doCreatePersonAuthCertificateImage(args, parsed_globals):
|
1115
|
+
g_param = parse_global_arg(parsed_globals)
|
1116
|
+
|
1117
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
1118
|
+
cred = credential.CVMRoleCredential()
|
1119
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
1120
|
+
cred = credential.STSAssumeRoleCredential(
|
1121
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
1122
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
1123
|
+
)
|
1124
|
+
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):
|
1125
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
1126
|
+
else:
|
1127
|
+
cred = credential.Credential(
|
1128
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
1129
|
+
)
|
1130
|
+
http_profile = HttpProfile(
|
1131
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
1132
|
+
reqMethod="POST",
|
1133
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
1134
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
1135
|
+
)
|
1136
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
1137
|
+
if g_param[OptionsDefine.Language]:
|
1138
|
+
profile.language = g_param[OptionsDefine.Language]
|
1139
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
1140
|
+
client = mod.EssbasicClient(cred, g_param[OptionsDefine.Region], profile)
|
1141
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
1142
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
1143
|
+
model = models.CreatePersonAuthCertificateImageRequest()
|
1144
|
+
model.from_json_string(json.dumps(args))
|
1145
|
+
start_time = time.time()
|
1146
|
+
while True:
|
1147
|
+
rsp = client.CreatePersonAuthCertificateImage(model)
|
1148
|
+
result = rsp.to_json_string()
|
1149
|
+
try:
|
1150
|
+
json_obj = json.loads(result)
|
1151
|
+
except TypeError as e:
|
1152
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
1153
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
1154
|
+
break
|
1155
|
+
cur_time = time.time()
|
1156
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
1157
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
1158
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
1159
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
1160
|
+
else:
|
1161
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
1162
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
1163
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1164
|
+
|
1165
|
+
|
1114
1166
|
def doSignFlow(args, parsed_globals):
|
1115
1167
|
g_param = parse_global_arg(parsed_globals)
|
1116
1168
|
|
@@ -6761,6 +6813,7 @@ ACTION_MAP = {
|
|
6761
6813
|
"ChannelBatchCancelFlows": doChannelBatchCancelFlows,
|
6762
6814
|
"ModifySubOrganizationInfo": doModifySubOrganizationInfo,
|
6763
6815
|
"ChannelCreateFlowApprovers": doChannelCreateFlowApprovers,
|
6816
|
+
"CreatePersonAuthCertificateImage": doCreatePersonAuthCertificateImage,
|
6764
6817
|
"SignFlow": doSignFlow,
|
6765
6818
|
"CheckIdCardVerification": doCheckIdCardVerification,
|
6766
6819
|
"ChannelCreatePreparedPersonalEsign": doChannelCreatePreparedPersonalEsign,
|
@@ -392,6 +392,13 @@
|
|
392
392
|
"output": "CreatePartnerAutoSignAuthUrlResponse",
|
393
393
|
"status": "online"
|
394
394
|
},
|
395
|
+
"CreatePersonAuthCertificateImage": {
|
396
|
+
"document": "获取个人用户认证证书图片下载URL\n\n个人用户认证证书图片样式如下图\n\n\n\n注: \n<ul>\n<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>\n<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>\n</ul>",
|
397
|
+
"input": "CreatePersonAuthCertificateImageRequest",
|
398
|
+
"name": "获取个人用户认证证书图片",
|
399
|
+
"output": "CreatePersonAuthCertificateImageResponse",
|
400
|
+
"status": "online"
|
401
|
+
},
|
395
402
|
"CreateSealByImage": {
|
396
403
|
"document": "1. 可以**通过图片**为子客企业代创建印章,图片最大5MB\n\n2. 可以**系统创建**子客企业代创建印章, 系统创建的印章样子下图(样式可以调整)\n\n",
|
397
404
|
"input": "CreateSealByImageRequest",
|
@@ -6882,6 +6889,119 @@
|
|
6882
6889
|
],
|
6883
6890
|
"type": "object"
|
6884
6891
|
},
|
6892
|
+
"CreatePersonAuthCertificateImageRequest": {
|
6893
|
+
"document": "CreatePersonAuthCertificateImage请求参数结构体",
|
6894
|
+
"members": [
|
6895
|
+
{
|
6896
|
+
"disabled": false,
|
6897
|
+
"document": "关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
|
6898
|
+
"example": "无",
|
6899
|
+
"member": "Agent",
|
6900
|
+
"name": "Agent",
|
6901
|
+
"required": true,
|
6902
|
+
"type": "object"
|
6903
|
+
},
|
6904
|
+
{
|
6905
|
+
"disabled": false,
|
6906
|
+
"document": "个人用户名称",
|
6907
|
+
"example": "无",
|
6908
|
+
"member": "string",
|
6909
|
+
"name": "UserName",
|
6910
|
+
"required": true,
|
6911
|
+
"type": "string"
|
6912
|
+
},
|
6913
|
+
{
|
6914
|
+
"disabled": false,
|
6915
|
+
"document": "证件类型,支持以下类型<ul><li> ID_CARD : 居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>",
|
6916
|
+
"example": "无",
|
6917
|
+
"member": "string",
|
6918
|
+
"name": "IdCardType",
|
6919
|
+
"required": true,
|
6920
|
+
"type": "string"
|
6921
|
+
},
|
6922
|
+
{
|
6923
|
+
"disabled": false,
|
6924
|
+
"document": "证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>",
|
6925
|
+
"example": "无",
|
6926
|
+
"member": "string",
|
6927
|
+
"name": "IdCardNumber",
|
6928
|
+
"required": true,
|
6929
|
+
"type": "string"
|
6930
|
+
},
|
6931
|
+
{
|
6932
|
+
"disabled": false,
|
6933
|
+
"document": "自动签使用的场景值, 可以选择的场景值如下:<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>注: `不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN`",
|
6934
|
+
"example": "E_PRESCRIPTION_AUTO_SIGN",
|
6935
|
+
"member": "string",
|
6936
|
+
"name": "SceneKey",
|
6937
|
+
"required": false,
|
6938
|
+
"type": "string"
|
6939
|
+
}
|
6940
|
+
],
|
6941
|
+
"type": "object"
|
6942
|
+
},
|
6943
|
+
"CreatePersonAuthCertificateImageResponse": {
|
6944
|
+
"document": "CreatePersonAuthCertificateImage返回参数结构体",
|
6945
|
+
"members": [
|
6946
|
+
{
|
6947
|
+
"disabled": false,
|
6948
|
+
"document": "个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。",
|
6949
|
+
"example": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=fcb0d640136f8f47d28e3f4cd5fb8bac321**da99b18e29d28807fc8e",
|
6950
|
+
"member": "string",
|
6951
|
+
"name": "AuthCertUrl",
|
6952
|
+
"output_required": true,
|
6953
|
+
"type": "string",
|
6954
|
+
"value_allowed_null": false
|
6955
|
+
},
|
6956
|
+
{
|
6957
|
+
"disabled": false,
|
6958
|
+
"document": "个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`\n注意:此字段可能返回 null,表示取不到有效值。",
|
6959
|
+
"example": "23090411***877319694",
|
6960
|
+
"member": "string",
|
6961
|
+
"name": "ImageCertId",
|
6962
|
+
"output_required": false,
|
6963
|
+
"type": "string",
|
6964
|
+
"value_allowed_null": true
|
6965
|
+
},
|
6966
|
+
{
|
6967
|
+
"disabled": false,
|
6968
|
+
"document": "CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`\n注意:此字段可能返回 null,表示取不到有效值。",
|
6969
|
+
"example": "2206EB**4597742",
|
6970
|
+
"member": "string",
|
6971
|
+
"name": "SerialNumber",
|
6972
|
+
"output_required": false,
|
6973
|
+
"type": "string",
|
6974
|
+
"value_allowed_null": true
|
6975
|
+
},
|
6976
|
+
{
|
6977
|
+
"disabled": false,
|
6978
|
+
"document": "CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片\n注意:此字段可能返回 null,表示取不到有效值。",
|
6979
|
+
"example": "无",
|
6980
|
+
"member": "uint64",
|
6981
|
+
"name": "ValidFrom",
|
6982
|
+
"output_required": false,
|
6983
|
+
"type": "int",
|
6984
|
+
"value_allowed_null": true
|
6985
|
+
},
|
6986
|
+
{
|
6987
|
+
"disabled": false,
|
6988
|
+
"document": "CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片\n注意:此字段可能返回 null,表示取不到有效值。",
|
6989
|
+
"example": "无",
|
6990
|
+
"member": "uint64",
|
6991
|
+
"name": "ValidTo",
|
6992
|
+
"output_required": false,
|
6993
|
+
"type": "int",
|
6994
|
+
"value_allowed_null": true
|
6995
|
+
},
|
6996
|
+
{
|
6997
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
6998
|
+
"member": "string",
|
6999
|
+
"name": "RequestId",
|
7000
|
+
"type": "string"
|
7001
|
+
}
|
7002
|
+
],
|
7003
|
+
"type": "object"
|
7004
|
+
},
|
6885
7005
|
"CreateSealByImageRequest": {
|
6886
7006
|
"document": "CreateSealByImage请求参数结构体",
|
6887
7007
|
"members": [
|
@@ -112,6 +112,12 @@
|
|
112
112
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\"\n },\n \"FlowApproverInfo\": {\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"IdCardNumber\": \"620000198802020000\",\n \"IdCardType\": \"ID_CARD\"\n }\n}",
|
113
113
|
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"流程ID和合同组ID不能同时为空,请检查参数后再试\"\n },\n \"RequestId\": \"s1700727885657576147\"\n }\n}",
|
114
114
|
"title": "错误示例-为个人用户生成H5批量签署链接,没有指定合同流程ID信息,也没有指定合同组ID信息"
|
115
|
+
},
|
116
|
+
{
|
117
|
+
"document": "1. 创建批量签署链接的合同签署方,必须都是动态签署人且未补充。\n2. 批量签署的合同数量不少于1份,不超过100份\n3. 上述合同签署方类型必须一致,均为待C端签署人签署状态\n4. 企业已经购买了专业版或以上版本套餐\n5. 获取领取链接通过指定RecipientId定位签署方,可以从发起合同的返回结果中获取",
|
118
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"AppId\": \"yDRSRUUgygj6rq7wUuO4zjECxndqQApl\"\n },\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": \"PERSON\"\n },\n \"FlowIds\": [\n \"yDwFkUUckpstin4sUuZjBEY5Ia2XB7sz\",\n \"yDwFkUUckpstzjhfUugNAWf1KibXqS26\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ]\n}",
|
119
|
+
"output": "{\n \"Response\": {\n \"FlowApproverUrlInfo\": {\n \"ApproverType\": \"PERSON\",\n \"LongUrl\": \"https://quick.qian.tencent.cn/guide?Code=yDwi0**BWW4MYlpI&CodeType=QUICK&shortKey=yDwi**KF45&token=C**E\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"SignUrl\": \"https://test.essurl.cn/C**E\"\n },\n \"RequestId\": \"s16986**08\"\n }\n}",
|
120
|
+
"title": "发起合同后,获取C端签署人的H5批量领取链接"
|
115
121
|
}
|
116
122
|
],
|
117
123
|
"ChannelCreateBatchSignUrl": [
|
@@ -844,6 +850,14 @@
|
|
844
850
|
"title": "创建他方自动签授权链接-他方授权"
|
845
851
|
}
|
846
852
|
],
|
853
|
+
"CreatePersonAuthCertificateImage": [
|
854
|
+
{
|
855
|
+
"document": "创建个人用户证明证书图片",
|
856
|
+
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: CreatePersonAuthCertificateImage\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"UserName\": \"典子谦\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"620000198802020000\"\n}",
|
857
|
+
"output": "{\n \"Response\": {\n \"AuthCertUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=522d****6cb5\",\n \"RequestId\": \"69c19f7e7240\",\n \"SerialNumber\": \"23090411***877319694\",\n \"ValidFrom\": 1692788219,\n \"ValidTo\": 1724324219\n }\n}",
|
858
|
+
"title": "创建个人用户证明证书图片"
|
859
|
+
}
|
860
|
+
],
|
847
861
|
"CreateSealByImage": [
|
848
862
|
{
|
849
863
|
"document": "GenerateSource为SealGenerateSourceSystem表示系统生成印章",
|
@@ -1027,7 +1027,7 @@
|
|
1027
1027
|
"example": "3edappId",
|
1028
1028
|
"member": "string",
|
1029
1029
|
"name": "MiniProgramAppId",
|
1030
|
-
"required":
|
1030
|
+
"required": false,
|
1031
1031
|
"type": "string"
|
1032
1032
|
},
|
1033
1033
|
{
|
@@ -9423,7 +9423,7 @@
|
|
9423
9423
|
"example": "3edappId",
|
9424
9424
|
"member": "string",
|
9425
9425
|
"name": "MiniProgramAppId",
|
9426
|
-
"required":
|
9426
|
+
"required": false,
|
9427
9427
|
"type": "string"
|
9428
9428
|
},
|
9429
9429
|
{
|