tccli 3.0.1183.1__py2.py3-none-any.whl → 3.0.1185.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/bi/v20220105/api.json +9 -0
- tccli/services/cdb/v20170320/api.json +2 -2
- tccli/services/cdwdoris/v20211228/api.json +137 -0
- tccli/services/cdwdoris/v20211228/examples.json +1 -1
- tccli/services/cls/v20201016/api.json +1 -1
- tccli/services/cynosdb/cynosdb_client.py +65 -12
- tccli/services/cynosdb/v20190107/api.json +99 -0
- tccli/services/cynosdb/v20190107/examples.json +8 -0
- tccli/services/dlc/v20210125/api.json +48 -11
- tccli/services/dlc/v20210125/examples.json +4 -4
- tccli/services/dsgc/v20190723/api.json +9 -0
- tccli/services/ecc/v20181213/api.json +14 -12
- tccli/services/ecc/v20181213/examples.json +3 -3
- tccli/services/ess/v20201111/api.json +1 -1
- tccli/services/ess/v20201111/examples.json +4 -4
- tccli/services/essbasic/v20210526/examples.json +9 -9
- tccli/services/hunyuan/v20230901/api.json +1 -1
- tccli/services/lke/v20231130/api.json +1 -1
- tccli/services/oceanus/v20190422/api.json +9 -0
- tccli/services/oceanus/v20190422/examples.json +1 -1
- tccli/services/redis/v20180412/api.json +18 -13
- tccli/services/redis/v20180412/examples.json +2 -2
- tccli/services/ssl/ssl_client.py +65 -12
- tccli/services/ssl/v20191205/api.json +130 -0
- tccli/services/ssl/v20191205/examples.json +8 -0
- tccli/services/tcr/v20190924/api.json +3 -3
- tccli/services/tcr/v20190924/examples.json +1 -1
- tccli/services/thpc/thpc_client.py +276 -64
- tccli/services/thpc/v20230321/api.json +886 -12
- tccli/services/thpc/v20230321/examples.json +32 -0
- tccli/services/trtc/v20190722/api.json +2 -2
- tccli/services/waf/v20180125/api.json +3 -3
- tccli/services/waf/v20180125/examples.json +1 -1
- {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/RECORD +39 -39
- {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1183.1.dist-info → tccli-3.0.1185.1.dist-info}/license_files/LICENSE +0 -0
@@ -231,13 +231,13 @@
|
|
231
231
|
"ChannelCreateFlowGroupByFiles": [
|
232
232
|
{
|
233
233
|
"document": "1. 入参中FlowFileInfos有三个元素, 表示三个合同组成此合同组\n2. 每个合同都是B2C合同",
|
234
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kevin\"\n },\n \"ProxyOrganizationOpenId\": \"zk_online_org\",\n \"AppId\": \"394fc83e7a1cc97ba27c3342f425c836\"\n },\n \"FlowGroupName\": \"采购合同\",\n \"FlowFileInfos\": [\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"番茄的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年番茄的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"
|
234
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kevin\"\n },\n \"ProxyOrganizationOpenId\": \"zk_online_org\",\n \"AppId\": \"394fc83e7a1cc97ba27c3342f425c836\"\n },\n \"FlowGroupName\": \"采购合同\",\n \"FlowFileInfos\": [\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"番茄的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年番茄的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"王五示例企业\",\n \"OrganizationOpenId\": \"zk_online_org\",\n \"OpenId\": \"zk\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"CustomerData\": \"5ZCI5ZCM5Lus5ZCI5ZCM5Lus\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"黄瓜的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年黄瓜的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"李四示例企业\",\n \"OrganizationOpenId\": \"zk_online_org\",\n \"OpenId\": \"zk\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMg==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"马铃薯的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年马铃薯的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"张三示例企业\",\n \"OrganizationOpenId\": \"zk_online_org\",\n \"OpenId\": \"zk\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMw==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n }\n ]\n}",
|
235
235
|
"output": "{\n \"Response\": {\n \"FlowGroupId\": \"yDwiSUUg0e3wmkUyoVjXzyZbNlhaVk85\",\n \"FlowIds\": [\n \"yDwiSUUg0e3wm2UyoVjXz1xWSYus0Jtc\",\n \"yDwiSUUg0e3wmrUyoVjXzSP9OEVRSAlk\",\n \"yDwiSUUg0e3wmhUyoVjXzByicWYPOymz\"\n ],\n \"RequestId\": \"s1698139089675399175\"\n }\n}",
|
236
236
|
"title": "创建三个合同组成的合同组"
|
237
237
|
},
|
238
238
|
{
|
239
239
|
"document": "1. 入参中FlowFileInfos有三个元素, 表示三个合同组成此合同组\n2. 每个合同都是B2C合同\n3.三份子合同均指定一方为动态签署方(即不指定具体签署人,FillType=1),可在发起后再进行补充。",
|
240
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kevin\"\n },\n \"ProxyOrganizationOpenId\": \"zk_online_org\",\n \"AppId\": \"394fc83e7a1cc97ba27c3342f425c836\"\n },\n \"FlowGroupName\": \"采购合同\",\n \"FlowFileInfos\": [\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"番茄的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年番茄的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"
|
240
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowGroupByFiles\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"kevin\"\n },\n \"ProxyOrganizationOpenId\": \"zk_online_org\",\n \"AppId\": \"394fc83e7a1cc97ba27c3342f425c836\"\n },\n \"FlowGroupName\": \"采购合同\",\n \"FlowFileInfos\": [\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"番茄的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年番茄的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"CustomerData\": \"5ZCI5ZCM5Lus5ZCI5ZCM5Lus\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"黄瓜的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年黄瓜的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMg==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n },\n {\n \"FileIds\": [\n \"yDR1nUU06b46rUy0fKyKocxqVM6QwE88\"\n ],\n \"FlowName\": \"马铃薯的采购合同\",\n \"Deadline\": 0,\n \"FlowDescription\": \"2023年马铃薯的采购50吨合同\",\n \"FlowType\": \"采购合同\",\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"ApproverOption\": {\n \"FillType\": 1\n },\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 100,\n \"ComponentHeight\": 100,\n \"ComponentValue\": \"yDR1kUU0zproxUy0fKyKg4XBzdcXcTBg\"\n }\n ]\n },\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"SignComponents\": [\n {\n \"ComponentWidth\": 100,\n \"FileIndex\": 0,\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentPage\": 1,\n \"ComponentRequired\": true,\n \"ComponentPosX\": 100,\n \"ComponentPosY\": 200,\n \"ComponentHeight\": 100\n }\n ]\n }\n ],\n \"CustomerData\": \"5paw55qE5a2Q5ZCI5ZCMMw==\",\n \"Unordered\": true,\n \"NeedSignReview\": false\n }\n ]\n}",
|
241
241
|
"output": "{\n \"Response\": {\n \"Approvers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu2fUuyXGHSxNMdtKoFQ\",\n \"SignId\": \"yDCVHUUckpwbqu2xUuyXGHS1pifZeuEM\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu24UuyXGHSwSOzFjmPR\",\n \"SignId\": \"yDCVHUUckpwbqu2bUuyXGHSyMBsyo35X\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqu2eUuyXGHSubvJWEDif\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu2mUuyXGHSx4AVZuJkj\",\n \"SignId\": \"yDCVHUUckpwbqu29UuyXGHSS9mARSyFZ\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu27UuyXGHSR81vG2CR9\",\n \"SignId\": \"yDCVHUUckpwbqu2uUuyXGHS8JfqC4sho\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqu2zUuyXGHSBho2CDwGz\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu28UuyXGHS1CLfd5m1g\",\n \"SignId\": \"yDCVHUUckpwbqu22UuyXGHS8gj9IYCTL\"\n },\n {\n \"ApproverRoleName\": \"\",\n \"RecipientId\": \"yDCVHUUckpwbqu2rUuyXGHSw7ZeJH7Dk\",\n \"SignId\": \"yDCVHUUckpwbqu25UuyXGHSu11RucwZR\"\n }\n ],\n \"FlowId\": \"yDCVHUUckpwbqu2qUuyXGHSvEB4yY7su\"\n }\n ],\n \"FlowGroupId\": \"yDCVHUUckpwbquhgUuyXGHSxM3rGJCM3\",\n \"FlowIds\": [\n \"yDCVHUUckpwbqu2eUuyXGHSubvJWEDif\",\n \"yDCVHUUckpwbqu2zUuyXGHSBho2CDwGz\",\n \"yDCVHUUckpwbqu2qUuyXGHSvEB4yY7su\"\n ],\n \"RequestId\": \"s1711351873868654231\"\n }\n}",
|
242
242
|
"title": "创建三个合同组成的合同组,指定每个子合同第一方为动态签署方"
|
243
243
|
}
|
@@ -449,25 +449,25 @@
|
|
449
449
|
"ChannelCreateUserAutoSignEnableUrl": [
|
450
450
|
{
|
451
451
|
"document": "将UrlType参数设置为 H5SIGN,即可获得H5页面开通链接",
|
452
|
-
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false
|
452
|
+
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false\n },\n \"NotifyType\": \"SMS\",\n \"NotifyAddress\": \"13200000000\",\n \"ExpiredTime\": 1693290580,\n \"UrlType\": \"H5SIGN\"\n}",
|
453
453
|
"output": "{\n \"Response\": {\n \"AppId\": \"\",\n \"AppOriginalId\": \"\",\n \"Path\": \"\",\n \"QrCode\": \"\",\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"Url\": \"https://essurl.cn/q5nQ*CSFBZ\",\n \"UrlType\": \"H5SIGN\"\n }\n}",
|
454
454
|
"title": "获取H5开通跳转链接"
|
455
455
|
},
|
456
456
|
{
|
457
457
|
"document": "UrlType参数是用来控制生成链接类型的,如果不传,则默认生成小程序跳转链接",
|
458
|
-
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false
|
458
|
+
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false\n },\n \"NotifyType\": \"SMS\",\n \"NotifyAddress\": \"13200000000\",\n \"ExpiredTime\": 1693290580,\n \"UrlType\": \"\"\n}",
|
459
459
|
"output": "{\n \"Response\": {\n \"AppId\": \"wxa02378y4jruwye1d\",\n \"AppOriginalId\": \"gh_da87293fsd87987\",\n \"Path\": \"page?abc=123&def=456\",\n \"QrCode\": \"EBAQAAAAAAAAAAAQIDBAUGBwgJCgsQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCN\",\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"Url\": \"https://xxx.xxx/abc123\",\n \"UrlType\": \"\"\n }\n}",
|
460
460
|
"title": "获取小程序跳转链接"
|
461
461
|
},
|
462
462
|
{
|
463
463
|
"document": "通过 AutoSignConfig.VerifyChannels 参数,可以控制用户在开通的时候所使用的认证方式。以下例子为生成用户短信验证开通的链接为例,链接类型为H5跳转链接。",
|
464
|
-
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false,\n \"
|
464
|
+
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false,\n \"VerifyChannels\": [\n \"TELECOM\"\n ]\n },\n \"NotifyType\": \"SMS\",\n \"NotifyAddress\": \"13200000000\",\n \"ExpiredTime\": 1693290580,\n \"UrlType\": \"H5SIGN\"\n}",
|
465
465
|
"output": "{\n \"Response\": {\n \"AppId\": \"\",\n \"AppOriginalId\": \"\",\n \"Path\": \"\",\n \"QrCode\": \"\",\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"Url\": \"https://essurl.cn/q5nQ*CSFBZ\",\n \"UrlType\": \"H5SIGN\"\n }\n}",
|
466
466
|
"title": "设置用户开通认证校验方式"
|
467
467
|
},
|
468
468
|
{
|
469
469
|
"document": "\t\n可以使用短信通知用户点击链接进行开通,短信中的链接跳转到小程序或者H5取决于UrlType参数。下面的例子将使用H5跳转链接为例。 过期时间需要使用时间戳类型进行设置,要求请参考 \"ExpiredTime\" 参数。",
|
470
|
-
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false,\n \"
|
470
|
+
"input": "POST / HTTP / 1.1\nHost: essbasic.tencentcloudapi.com\nContent - Type: application / json\nX - TC - Action: ChannelCreateUserAutoSignEnableUrl <\n\t公共请求参数 >\n\n{\n \"Operator\": {\n \"OpenId\": \"\",\n \"ClientIp\": \"\",\n \"CustomUserId\": \"\",\n \"ProxyIp\": \"\",\n \"Channel\": \"\"\n },\n \"SceneKey\": \"E_PRESCRIPTION_AUTO_SIGN\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"AutoSignConfig\": {\n \"UserInfo\": {\n \"Name\": \"小明\",\n \"IdCardType\": \"ID_CARD\",\n \"IdCardNumber\": \"1xxxxxxxxxxxxxx0\"\n },\n \"CertInfoCallback\": true,\n \"UserDefineSeal\": false,\n \"SealImgCallback\": false,\n \"VerifyChannels\": [\n \"TELECOM\"\n ]\n },\n \"NotifyType\": \"SMS\",\n \"NotifyAddress\": \"13200000000\",\n \"ExpiredTime\": 1693290580,\n \"UrlType\": \"H5SIGN\"\n}",
|
471
471
|
"output": "{\n \"Response\": {\n \"AppId\": \"\",\n \"AppOriginalId\": \"\",\n \"Path\": \"\",\n \"QrCode\": \"\",\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"Url\": \"https://essurl.cn/q5nQ*CSFBZ\",\n \"UrlType\": \"H5SIGN\"\n }\n}",
|
472
472
|
"title": "通知对应开通用户以及设置过期时间"
|
473
473
|
}
|
@@ -805,13 +805,13 @@
|
|
805
805
|
},
|
806
806
|
{
|
807
807
|
"document": "使用模板批量创建两个签署流程\n第一个签署流程是 一个 单 C 合同,有发起方控件姓名,在发起的时候进行了填充, 即在 formfields 中填入了 components 对象\n第二个签署流程是 一个 C2B 合同, 第一方 ApproverType 设置为 PERSON,第二方的 ApproverType设置为 ORGANIZATION, 有发起方控件姓名,在发起的时候进行了填充, 即在 formfields 中填入了 components 对象",
|
808
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowsByTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDwfwUUgygormhg1UuS2eARxjMT0mxAw\"\n },\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试签署流程一\",\n \"TemplateId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"FlowDescription\": \"测试签署流程一的描述信息\",\n \"Deadline\": 1989688460,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"李四\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"PERSON\",\n \"Name\": \"李四\",\n \"Mobile\": \"13888888888\",\n \"RecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpeI\"\n }\n ]\n },\n {\n \"FlowName\": \"测试签署流程二\",\n \"TemplateId\": \"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\n \"FlowDescription\": \"测试签署流程二的描述信息\",\n \"
|
808
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowsByTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDwfwUUgygormhg1UuS2eARxjMT0mxAw\"\n },\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试签署流程一\",\n \"TemplateId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"FlowDescription\": \"测试签署流程一的描述信息\",\n \"Deadline\": 1989688460,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"李四\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"PERSON\",\n \"Name\": \"李四\",\n \"Mobile\": \"13888888888\",\n \"RecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpeI\"\n }\n ]\n },\n {\n \"FlowName\": \"测试签署流程二\",\n \"TemplateId\": \"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\n \"FlowDescription\": \"测试签署流程二的描述信息\",\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"张三\"\n }\n ],\n \"Deadline\": 1989688460,\n \"FlowApprovers\": [\n {\n \"Name\": \"典子谦\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"RecipientId\": \"yDxZzUyKQDKuihUuO4zjEy09jfapyHjn\"\n },\n {\n \"Name\": \"张三\",\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationOpenId\": \"ess_open_organization_1\",\n \"OrganizationName\": \"org_zhangsan\",\n \"Mobile\": \"18888888888\",\n \"OpenId\": \"n02468\",\n \"RecipientId\": \"yDwJ0UUckpk2077lUxgm9jJ9eZgZChJe\"\n }\n ]\n }\n ]\n}",
|
809
809
|
"output": "{\n \"Response\": {\n \"CustomerData\": [\n \"\"\n ],\n \"ErrorMessages\": [\n \"\"\n ],\n \"FlowApprovers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"个人签署方\",\n \"RecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpeI\",\n \"SignId\": \"yDCNsUUckpvsadteUEEw4Igush89GzOR\"\n }\n ],\n \"FlowId\": \"yDCNsUUckpvsadtiUEEw4Ig1G1yak1QY\"\n },\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"个人签署方\",\n \"RecipientId\": \"yDxZzUyKQDKuihUuO4zjEy09jfapyHjn\",\n \"SignId\": \"yDCNsUUckpvsadteUEEw4Igush87GzOR\"\n },\n {\n \"ApproverRoleName\": \"张三示例企业\",\n \"RecipientId\": \"yDwJ0UUckpk2077lUxgm9jJ9eZgZChJe\",\n \"SignId\": \"yDCNsUUckpvsadtzUEEw4IgycXgrG82a\"\n }\n ],\n \"FlowId\": \"yDCNsUUckpvsadtiUEEw4Ig1G1ybk1QY\"\n }\n ],\n \"FlowIds\": [\n \"yDCNsUUckpvsadtiUEEw4Ig1G1yak1QY\",\n \"yDCNsUUckpvsadtiUEEw4Ig1G1ybk1QY\"\n ],\n \"PreviewUrls\": [\n \"\",\n \"\"\n ],\n \"RequestId\": \"s1706111849162794392\",\n \"TaskInfos\": [\n {\n \"TaskId\": \"\",\n \"TaskStatus\": \"\"\n },\n {\n \"TaskId\": \"\",\n \"TaskStatus\": \"\"\n }\n ]\n }\n}",
|
810
810
|
"title": "使用模板批量创建两个签署流程"
|
811
811
|
},
|
812
812
|
{
|
813
813
|
"document": "创建一个B2C流程,两方签署方不指定具体的签署人\n注: \n`1.签署人相关信息为空,如:姓名、手机号码等` \n`2.FillType需传值为1,表示为动态签署人(不确定具体的签署人),需后续进行补充。` \n`3.需保留对应的角色编号,即RecipientId,后续补充具体的签署人时需指定对应的RecipientId`",
|
814
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowsByTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"d7c13a8b***********68c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc***********3aff766cac\"\n },\n \"AppId\": \"65fb0c59***********a382cc5ed0e\"\n },\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试流程一\",\n \"TemplateId\": \"005c***********4f7f64e8c\",\n \"FlowDescription\": \"测试流程一的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"
|
814
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowsByTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"d7c13a8b***********68c0ee248f04\",\n \"ProxyOperator\": {\n \"OpenId\": \"00498cc***********3aff766cac\"\n },\n \"AppId\": \"65fb0c59***********a382cc5ed0e\"\n },\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试流程一\",\n \"TemplateId\": \"005c***********4f7f64e8c\",\n \"FlowDescription\": \"测试流程一的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"李四\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"ApproverType\": \"ORGANIZATION\",\n \"ApproverRoleName\": \"企业签署方\",\n \"RecipientId\": \"yDxjbUU***********zjEuCkSaxt8n\",\n \"ApproverOption\": {\n \"FillType\": 1\n }\n },\n {\n \"ApproverType\": \"PERSON\",\n \"ApproverRoleName\": \"个人签署方\",\n \"RecipientId\": \"yDxjbUU***********ChJBkK7qS\",\n \"ApproverOption\": {\n \"FillType\": 1\n }\n }\n ]\n }\n ]\n}",
|
815
815
|
"output": "{\n \"Response\": {\n \"CustomerData\": [\n \"\"\n ],\n \"FlowIds\": [\n \"yDxMqU***********vaigGvi\"\n ],\n \"PreviewUrls\": [\n \"\"\n ],\n \"ErrorMessages\": [\n \"\"\n ],\n \"TaskInfos\": [\n {\n \"TaskId\": \"taskid\",\n \"TaskStatus\": \"status\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Approvers\": [\n {\n \"ApproverRoleName\": \"企业签署方\",\n \"RecipientId\": \"yDxjbUU***********zjEuCkSaxt8n\",\n \"SignId\": \"yDw7hUUckpkmtvenURxlqRxRcrWD0zVk\"\n },\n {\n \"ApproverRoleName\": \"个人签署方\",\n \"RecipientId\": \"yDxjbUU***********ChJBkK7qS\",\n \"SignId\": \"yDw7hUUckpkmtvegURxlqRxSV5qDMex1\"\n }\n ],\n \"FlowId\": \"yDxMqU***********vaigGvi\"\n }\n ],\n \"RequestId\": \"s16294xxxxx0001803\"\n }\n}",
|
816
816
|
"title": "创建含有动态签署人流程,签署方不指定具体的签署人"
|
817
817
|
}
|
@@ -1133,7 +1133,7 @@
|
|
1133
1133
|
"PrepareFlows": [
|
1134
1134
|
{
|
1135
1135
|
"document": "创建待发起文件",
|
1136
|
-
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PrepareFlows\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"test\",\n \"ProxyOperator\": {\n \"OpenId\": \"test\"\n },\n \"AppId\": \"x\"\n },\n \"JumpUrl\": \"http://www.test.com\",\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试签署流程一\",\n \"TemplateId\": \"test\",\n \"FlowDescription\": \"测试签署流程一的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"
|
1136
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PrepareFlows\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"test\",\n \"ProxyOperator\": {\n \"OpenId\": \"test\"\n },\n \"AppId\": \"x\"\n },\n \"JumpUrl\": \"http://www.test.com\",\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试签署流程一\",\n \"TemplateId\": \"test\",\n \"FlowDescription\": \"测试签署流程一的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"李四\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Name\": \"李四\",\n \"Mobile\": \"13888888888\",\n \"Deadline\": 1604910798\n }\n ]\n },\n {\n \"FlowName\": \"测试签署流程二\",\n \"TemplateId\": \"test\",\n \"FlowDescription\": \"测试签署流程二的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"张三\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Name\": \"鹅鹅子\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"Deadline\": 1663336465\n },\n {\n \"Name\": \"发起方\",\n \"ApproverType\": \"ORGANIZATION\",\n \"Mobile\": \"13700000000\",\n \"OpenId\": \"12345678\",\n \"Deadline\": 1663336465\n }\n ]\n }\n ]\n}",
|
1137
1137
|
"output": "{\n \"Response\": {\n \"ConfirmUrl\": \"https://www.xx.com\",\n \"RequestId\": \"id\"\n }\n}",
|
1138
1138
|
"title": "创建待发起文件"
|
1139
1139
|
}
|
@@ -814,7 +814,7 @@
|
|
814
814
|
},
|
815
815
|
{
|
816
816
|
"disabled": false,
|
817
|
-
"document": "模型生成的工具调用,仅 hunyuan-functioncall 模型支持\n注意:此字段可能返回 null,表示取不到有效值。",
|
817
|
+
"document": "模型生成的工具调用,仅 hunyuan-pro 或者 hunyuan-functioncall 模型支持\n注意:此字段可能返回 null,表示取不到有效值。",
|
818
818
|
"example": "无",
|
819
819
|
"member": "ToolCall",
|
820
820
|
"name": "ToolCalls",
|
@@ -2350,6 +2350,15 @@
|
|
2350
2350
|
"name": "WorkSpaceId",
|
2351
2351
|
"required": false,
|
2352
2352
|
"type": "string"
|
2353
|
+
},
|
2354
|
+
{
|
2355
|
+
"disabled": false,
|
2356
|
+
"document": "作业名称列表",
|
2357
|
+
"example": "[\"name1\",\"name2\"]",
|
2358
|
+
"member": "string",
|
2359
|
+
"name": "JobNames",
|
2360
|
+
"required": false,
|
2361
|
+
"type": "list"
|
2353
2362
|
}
|
2354
2363
|
],
|
2355
2364
|
"type": "object"
|
@@ -89,7 +89,7 @@
|
|
89
89
|
"DeleteJobs": [
|
90
90
|
{
|
91
91
|
"document": "删除作业",
|
92
|
-
"input": "POST / HTTP/1.1\nHost: oceanus.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteJobs\n<公共请求参数>\n\n{\n \"JobIds\": [\n \"cql-6ntmhryo\"\n ],\n \"WorkSpaceId\": \"space-53rqk422\"\n}",
|
92
|
+
"input": "POST / HTTP/1.1\nHost: oceanus.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteJobs\n<公共请求参数>\n\n{\n \"JobIds\": [\n \"cql-6ntmhryo\"\n ],\n \"JobNames\": [\n \"name1\"\n ],\n \"WorkSpaceId\": \"space-53rqk422\"\n}",
|
93
93
|
"output": "{\n \"Response\": {\n \"RequestId\": \"12470b27-ef12-4c52-9b79-bddd64ae0a5b\"\n }\n}",
|
94
94
|
"title": "删除作业"
|
95
95
|
}
|
@@ -891,7 +891,7 @@
|
|
891
891
|
"example": "486489",
|
892
892
|
"member": "int64",
|
893
893
|
"name": "FlowId",
|
894
|
-
"
|
894
|
+
"output_required": true,
|
895
895
|
"type": "int",
|
896
896
|
"value_allowed_null": false
|
897
897
|
},
|
@@ -901,7 +901,7 @@
|
|
901
901
|
"example": "\"外网开通中\"",
|
902
902
|
"member": "string",
|
903
903
|
"name": "WanStatus",
|
904
|
-
"
|
904
|
+
"output_required": true,
|
905
905
|
"type": "string",
|
906
906
|
"value_allowed_null": false
|
907
907
|
},
|
@@ -6187,7 +6187,7 @@
|
|
6187
6187
|
"example": "6977675",
|
6188
6188
|
"member": "string",
|
6189
6189
|
"name": "DealId",
|
6190
|
-
"
|
6190
|
+
"output_required": true,
|
6191
6191
|
"type": "string",
|
6192
6192
|
"value_allowed_null": false
|
6193
6193
|
},
|
@@ -8710,6 +8710,7 @@
|
|
8710
8710
|
"example": "1",
|
8711
8711
|
"member": "int64",
|
8712
8712
|
"name": "AutoBackupType",
|
8713
|
+
"output_required": true,
|
8713
8714
|
"type": "int",
|
8714
8715
|
"value_allowed_null": false
|
8715
8716
|
},
|
@@ -8719,6 +8720,7 @@
|
|
8719
8720
|
"example": "[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"]",
|
8720
8721
|
"member": "string",
|
8721
8722
|
"name": "WeekDays",
|
8723
|
+
"output_required": true,
|
8722
8724
|
"type": "list",
|
8723
8725
|
"value_allowed_null": false
|
8724
8726
|
},
|
@@ -8728,6 +8730,7 @@
|
|
8728
8730
|
"example": "04:00-05:00",
|
8729
8731
|
"member": "string",
|
8730
8732
|
"name": "TimePeriod",
|
8733
|
+
"output_required": true,
|
8731
8734
|
"type": "string",
|
8732
8735
|
"value_allowed_null": false
|
8733
8736
|
},
|
@@ -8737,6 +8740,7 @@
|
|
8737
8740
|
"example": "7",
|
8738
8741
|
"member": "int64",
|
8739
8742
|
"name": "BackupStorageDays",
|
8743
|
+
"output_required": true,
|
8740
8744
|
"type": "int",
|
8741
8745
|
"value_allowed_null": false
|
8742
8746
|
},
|
@@ -8854,7 +8858,7 @@
|
|
8854
8858
|
"example": "95027",
|
8855
8859
|
"member": "int64",
|
8856
8860
|
"name": "TaskId",
|
8857
|
-
"
|
8861
|
+
"output_required": true,
|
8858
8862
|
"type": "int",
|
8859
8863
|
"value_allowed_null": false
|
8860
8864
|
},
|
@@ -9169,11 +9173,11 @@
|
|
9169
9173
|
"members": [
|
9170
9174
|
{
|
9171
9175
|
"disabled": false,
|
9172
|
-
"document": "说明修改参数配置是否成功。<br><li>true
|
9176
|
+
"document": "说明修改参数配置是否成功。<br><li>true:指修改成功;</li><li>false:指修改失败。</li>",
|
9173
9177
|
"example": "true",
|
9174
9178
|
"member": "bool",
|
9175
9179
|
"name": "Changed",
|
9176
|
-
"
|
9180
|
+
"output_required": true,
|
9177
9181
|
"type": "bool",
|
9178
9182
|
"value_allowed_null": false
|
9179
9183
|
},
|
@@ -9183,7 +9187,7 @@
|
|
9183
9187
|
"example": "327",
|
9184
9188
|
"member": "int64",
|
9185
9189
|
"name": "TaskId",
|
9186
|
-
"
|
9190
|
+
"output_required": true,
|
9187
9191
|
"type": "int",
|
9188
9192
|
"value_allowed_null": false
|
9189
9193
|
},
|
@@ -9374,7 +9378,7 @@
|
|
9374
9378
|
"example": "success",
|
9375
9379
|
"member": "string",
|
9376
9380
|
"name": "Status",
|
9377
|
-
"
|
9381
|
+
"output_required": true,
|
9378
9382
|
"type": "string",
|
9379
9383
|
"value_allowed_null": false
|
9380
9384
|
},
|
@@ -10715,7 +10719,7 @@
|
|
10715
10719
|
"example": "486489",
|
10716
10720
|
"member": "int64",
|
10717
10721
|
"name": "FlowId",
|
10718
|
-
"
|
10722
|
+
"output_required": true,
|
10719
10723
|
"type": "int",
|
10720
10724
|
"value_allowed_null": false
|
10721
10725
|
},
|
@@ -10725,7 +10729,7 @@
|
|
10725
10729
|
"example": "\"外网关闭中\"",
|
10726
10730
|
"member": "string",
|
10727
10731
|
"name": "WanStatus",
|
10728
|
-
"
|
10732
|
+
"output_required": true,
|
10729
10733
|
"type": "string",
|
10730
10734
|
"value_allowed_null": false
|
10731
10735
|
},
|
@@ -10946,7 +10950,7 @@
|
|
10946
10950
|
"example": "16657",
|
10947
10951
|
"member": "int64",
|
10948
10952
|
"name": "TaskId",
|
10949
|
-
"
|
10953
|
+
"output_required": true,
|
10950
10954
|
"type": "int",
|
10951
10955
|
"value_allowed_null": false
|
10952
10956
|
},
|
@@ -11354,11 +11358,11 @@
|
|
11354
11358
|
"members": [
|
11355
11359
|
{
|
11356
11360
|
"disabled": false,
|
11357
|
-
"document": "
|
11361
|
+
"document": "该字段已废弃,请通过查询实例接口获取到的状态来判断实例是否已解隔离",
|
11358
11362
|
"example": "1203",
|
11359
11363
|
"member": "int64",
|
11360
11364
|
"name": "TaskId",
|
11361
|
-
"
|
11365
|
+
"output_required": true,
|
11362
11366
|
"type": "int",
|
11363
11367
|
"value_allowed_null": false
|
11364
11368
|
},
|
@@ -11936,6 +11940,7 @@
|
|
11936
11940
|
"example": "6954227",
|
11937
11941
|
"member": "string",
|
11938
11942
|
"name": "DealId",
|
11943
|
+
"output_required": true,
|
11939
11944
|
"type": "string",
|
11940
11945
|
"value_allowed_null": false
|
11941
11946
|
},
|
@@ -466,7 +466,7 @@
|
|
466
466
|
{
|
467
467
|
"document": "查询单个复制组信息",
|
468
468
|
"input": "POST / HTTP/1.1\nHost: redis.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReplicationGroup\n<公共请求参数>\n\n{\n \"Limit\": 20,\n \"GroupId\": \"crs-rpl-lkgv****\",\n \"Offset\": 0\n}",
|
469
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"65e950b9-78e8-49b1-9200-0e62a1925557\",\n \"Groups\": [\n {\n \"Status\": 37,\n \"Remark\": \"测试复制组\",\n \"InstanceCount\": 1,\n \"Instances\": [\n {\n \"Engine\": \"社区版Redis\",\n \"Vip6\": \"\",\n \"UpdateTime\": \"2022-11-02 15:04:05\",\n \"VpcID\": 16770550,\n \"InstanceId\": \"crs-9c36****\",\n \"RedisShardSize\": 1024,\n \"RegionId\": 1,\n \"RedisShardNum\": 1,\n \"Status\": 1,\n \"Vip\": \"10.0.4.42\",\n \"DiskSize\": 0,\n \"CreateTime\": \"2022-11-02 15:04:05\",\n \"ProductType\": 9,\n \"AppId\": 0,\n \"Role\": \"rw\",\n \"VPort\": 6379,\n \"ZoneId\": 1,\n \"InstanceName\": \"crs-test\",\n \"RedisReplicasNum\": 1,\n \"GrocerySysId\": 1000259\n }\n ],\n \"RegionId\": 1,\n \"GroupName\": \"crs-ben-test\",\n \"AppId\": 0,\n \"GroupId\": \"crs-rpl-lkgv****\"\n }\n ]\n }\n}",
|
469
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"65e950b9-78e8-49b1-9200-0e62a1925557\",\n \"Groups\": [\n {\n \"Status\": 37,\n \"Remark\": \"测试复制组\",\n \"InstanceCount\": 1,\n \"Instances\": [\n {\n \"Engine\": \"社区版Redis\",\n \"Vip6\": \"\",\n \"IPv6\": \"abc\",\n \"UpdateTime\": \"2022-11-02 15:04:05\",\n \"VpcID\": 16770550,\n \"InstanceId\": \"crs-9c36****\",\n \"RedisShardSize\": 1024,\n \"RegionId\": 1,\n \"RedisShardNum\": 1,\n \"Status\": 1,\n \"Vip\": \"10.0.4.42\",\n \"DiskSize\": 0,\n \"CreateTime\": \"2022-11-02 15:04:05\",\n \"ProductType\": 9,\n \"AppId\": 0,\n \"Role\": \"rw\",\n \"VPort\": 6379,\n \"ZoneId\": 1,\n \"InstanceName\": \"crs-test\",\n \"RedisReplicasNum\": 1,\n \"GrocerySysId\": 1000259\n }\n ],\n \"RegionId\": 1,\n \"GroupName\": \"crs-ben-test\",\n \"AppId\": 0,\n \"GroupId\": \"crs-rpl-lkgv****\"\n }\n ]\n }\n}",
|
470
470
|
"title": "请求示例"
|
471
471
|
}
|
472
472
|
],
|
@@ -769,7 +769,7 @@
|
|
769
769
|
"StartupInstance": [
|
770
770
|
{
|
771
771
|
"document": "",
|
772
|
-
"input": "
|
772
|
+
"input": "POST / HTTP/1.1\nHost: redis.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartupInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"crs-7ponppu3\"\n}",
|
773
773
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e96ecad-23db-4fa8-ac41-af9b8e015b26\",\n \"TaskId\": 1203\n }\n}",
|
774
774
|
"title": "请求示例"
|
775
775
|
}
|
tccli/services/ssl/ssl_client.py
CHANGED
@@ -173,6 +173,58 @@ def doDescribeHostCdnInstanceList(args, parsed_globals):
|
|
173
173
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
174
174
|
|
175
175
|
|
176
|
+
def doCancelAuditCertificate(args, parsed_globals):
|
177
|
+
g_param = parse_global_arg(parsed_globals)
|
178
|
+
|
179
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
180
|
+
cred = credential.CVMRoleCredential()
|
181
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
182
|
+
cred = credential.STSAssumeRoleCredential(
|
183
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
184
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
185
|
+
)
|
186
|
+
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):
|
187
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
188
|
+
else:
|
189
|
+
cred = credential.Credential(
|
190
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
191
|
+
)
|
192
|
+
http_profile = HttpProfile(
|
193
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
194
|
+
reqMethod="POST",
|
195
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
196
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
197
|
+
)
|
198
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
199
|
+
if g_param[OptionsDefine.Language]:
|
200
|
+
profile.language = g_param[OptionsDefine.Language]
|
201
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
202
|
+
client = mod.SslClient(cred, g_param[OptionsDefine.Region], profile)
|
203
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
204
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
205
|
+
model = models.CancelAuditCertificateRequest()
|
206
|
+
model.from_json_string(json.dumps(args))
|
207
|
+
start_time = time.time()
|
208
|
+
while True:
|
209
|
+
rsp = client.CancelAuditCertificate(model)
|
210
|
+
result = rsp.to_json_string()
|
211
|
+
try:
|
212
|
+
json_obj = json.loads(result)
|
213
|
+
except TypeError as e:
|
214
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
215
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
216
|
+
break
|
217
|
+
cur_time = time.time()
|
218
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
219
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
220
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
221
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
222
|
+
else:
|
223
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
224
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
225
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
226
|
+
|
227
|
+
|
176
228
|
def doDescribeHostTkeInstanceList(args, parsed_globals):
|
177
229
|
g_param = parse_global_arg(parsed_globals)
|
178
230
|
|
@@ -745,7 +797,7 @@ def doDescribeHostDdosInstanceList(args, parsed_globals):
|
|
745
797
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
746
798
|
|
747
799
|
|
748
|
-
def
|
800
|
+
def doCompleteCertificate(args, parsed_globals):
|
749
801
|
g_param = parse_global_arg(parsed_globals)
|
750
802
|
|
751
803
|
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
@@ -774,11 +826,11 @@ def doVerifyManager(args, parsed_globals):
|
|
774
826
|
client = mod.SslClient(cred, g_param[OptionsDefine.Region], profile)
|
775
827
|
client._sdkVersion += ("_CLI_" + __version__)
|
776
828
|
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
777
|
-
model = models.
|
829
|
+
model = models.CompleteCertificateRequest()
|
778
830
|
model.from_json_string(json.dumps(args))
|
779
831
|
start_time = time.time()
|
780
832
|
while True:
|
781
|
-
rsp = client.
|
833
|
+
rsp = client.CompleteCertificate(model)
|
782
834
|
result = rsp.to_json_string()
|
783
835
|
try:
|
784
836
|
json_obj = json.loads(result)
|
@@ -1057,7 +1109,7 @@ def doDeleteCertificate(args, parsed_globals):
|
|
1057
1109
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1058
1110
|
|
1059
1111
|
|
1060
|
-
def
|
1112
|
+
def doVerifyManager(args, parsed_globals):
|
1061
1113
|
g_param = parse_global_arg(parsed_globals)
|
1062
1114
|
|
1063
1115
|
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
@@ -1086,11 +1138,11 @@ def doCompleteCertificate(args, parsed_globals):
|
|
1086
1138
|
client = mod.SslClient(cred, g_param[OptionsDefine.Region], profile)
|
1087
1139
|
client._sdkVersion += ("_CLI_" + __version__)
|
1088
1140
|
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
1089
|
-
model = models.
|
1141
|
+
model = models.VerifyManagerRequest()
|
1090
1142
|
model.from_json_string(json.dumps(args))
|
1091
1143
|
start_time = time.time()
|
1092
1144
|
while True:
|
1093
|
-
rsp = client.
|
1145
|
+
rsp = client.VerifyManager(model)
|
1094
1146
|
result = rsp.to_json_string()
|
1095
1147
|
try:
|
1096
1148
|
json_obj = json.loads(result)
|
@@ -1837,7 +1889,7 @@ def doDescribeCertificateBindResourceTaskResult(args, parsed_globals):
|
|
1837
1889
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
1838
1890
|
|
1839
1891
|
|
1840
|
-
def
|
1892
|
+
def doCheckCertificateDomainVerification(args, parsed_globals):
|
1841
1893
|
g_param = parse_global_arg(parsed_globals)
|
1842
1894
|
|
1843
1895
|
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
@@ -1866,11 +1918,11 @@ def doCancelAuditCertificate(args, parsed_globals):
|
|
1866
1918
|
client = mod.SslClient(cred, g_param[OptionsDefine.Region], profile)
|
1867
1919
|
client._sdkVersion += ("_CLI_" + __version__)
|
1868
1920
|
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
1869
|
-
model = models.
|
1921
|
+
model = models.CheckCertificateDomainVerificationRequest()
|
1870
1922
|
model.from_json_string(json.dumps(args))
|
1871
1923
|
start_time = time.time()
|
1872
1924
|
while True:
|
1873
|
-
rsp = client.
|
1925
|
+
rsp = client.CheckCertificateDomainVerification(model)
|
1874
1926
|
result = rsp.to_json_string()
|
1875
1927
|
try:
|
1876
1928
|
json_obj = json.loads(result)
|
@@ -3099,6 +3151,7 @@ ACTION_MAP = {
|
|
3099
3151
|
"DescribeHostCosInstanceList": doDescribeHostCosInstanceList,
|
3100
3152
|
"DescribeCertificates": doDescribeCertificates,
|
3101
3153
|
"DescribeHostCdnInstanceList": doDescribeHostCdnInstanceList,
|
3154
|
+
"CancelAuditCertificate": doCancelAuditCertificate,
|
3102
3155
|
"DescribeHostTkeInstanceList": doDescribeHostTkeInstanceList,
|
3103
3156
|
"UploadRevokeLetter": doUploadRevokeLetter,
|
3104
3157
|
"DeleteManager": doDeleteManager,
|
@@ -3110,13 +3163,13 @@ ACTION_MAP = {
|
|
3110
3163
|
"SubmitCertificateInformation": doSubmitCertificateInformation,
|
3111
3164
|
"DeleteCertificates": doDeleteCertificates,
|
3112
3165
|
"DescribeHostDdosInstanceList": doDescribeHostDdosInstanceList,
|
3113
|
-
"
|
3166
|
+
"CompleteCertificate": doCompleteCertificate,
|
3114
3167
|
"DescribeHostClbInstanceList": doDescribeHostClbInstanceList,
|
3115
3168
|
"DescribeHostTeoInstanceList": doDescribeHostTeoInstanceList,
|
3116
3169
|
"CancelCertificateOrder": doCancelCertificateOrder,
|
3117
3170
|
"DownloadCertificate": doDownloadCertificate,
|
3118
3171
|
"DeleteCertificate": doDeleteCertificate,
|
3119
|
-
"
|
3172
|
+
"VerifyManager": doVerifyManager,
|
3120
3173
|
"UpdateCertificateInstance": doUpdateCertificateInstance,
|
3121
3174
|
"UploadCertificate": doUploadCertificate,
|
3122
3175
|
"CheckCertificateChain": doCheckCertificateChain,
|
@@ -3131,7 +3184,7 @@ ACTION_MAP = {
|
|
3131
3184
|
"DeployCertificateRecordRollback": doDeployCertificateRecordRollback,
|
3132
3185
|
"DeployCertificateRecordRetry": doDeployCertificateRecordRetry,
|
3133
3186
|
"DescribeCertificateBindResourceTaskResult": doDescribeCertificateBindResourceTaskResult,
|
3134
|
-
"
|
3187
|
+
"CheckCertificateDomainVerification": doCheckCertificateDomainVerification,
|
3135
3188
|
"DescribeHostDeployRecord": doDescribeHostDeployRecord,
|
3136
3189
|
"UpdateCertificateRecordRetry": doUpdateCertificateRecordRetry,
|
3137
3190
|
"DescribeDeleteCertificatesTaskResult": doDescribeDeleteCertificatesTaskResult,
|