tccli 3.0.1083.1__py2.py3-none-any.whl → 3.0.1084.1__py2.py3-none-any.whl

tccli/examples/essbasic/v20210526/ChannelCreateFlowGroupByTemplates.md

@@ -61,3 +61,95 @@ Output:
 }
 ```
 
+**Example 2: 通过多模板创建有2个合同的合同组，指定每个子合同第一方为动态签署方**
+
+1. 入参中FlowFileInfos有2个元素, 表示2个合同组成此合同组
+2. 每个合同都是B2C合同
+4.指定子合同一方为动态签署方（即不指定具体签署人，FillType=1），可在发起后再进行补充。
+
+Input: 
+
+```
+tccli essbasic ChannelCreateFlowGroupByTemplates --cli-unfold-argument  \
+    --Agent.ProxyOperator.OpenId kev_8 \
+    --Agent.ProxyOrganizationOpenId kev_open_organization_8 \
+    --Agent.AppId 16fd2f7d7ae85d13ca5f8d501d57b5ec \
+    --FlowGroupName 2023年张三入职合同组合 \
+    --FlowInfos.0.FlowName 2023年张三入职合同 \
+    --FlowInfos.0.FlowApprovers.0.ApproverOption.FillType 1 \
+    --FlowInfos.0.FlowApprovers.0.ApproverType ORGANIZATION \
+    --FlowInfos.0.FlowApprovers.0.RecipientId yDwgKUUckp1jdybwUWptGKyGVpNME9fH \
+    --FlowInfos.0.FlowApprovers.1.Name 张三 \
+    --FlowInfos.0.FlowApprovers.1.Mobile 18888888888 \
+    --FlowInfos.0.FlowApprovers.1.ApproverType PERSON \
+    --FlowInfos.0.FlowApprovers.1.RecipientId yDwgKUUckp1jdybvUWptGKBD9TeupFMV \
+    --FlowInfos.0.Deadline 1698202075 \
+    --FlowInfos.0.TemplateId yDwgKUUckp1jdy4dUWptGKRavSGWt9cW \
+    --FlowInfos.1.FlowName 2023年张三入职保密协议 \
+    --FlowInfos.1.FlowApprovers.0.ApproverOption.FillType 1 \
+    --FlowInfos.1.FlowApprovers.0.ApproverType ORGANIZATION \
+    --FlowInfos.1.FlowApprovers.0.RecipientId yDwgKUUckp1jdybwUWptGKyGVpNME9fH \
+    --FlowInfos.1.FlowApprovers.1.Name 张三 \
+    --FlowInfos.1.FlowApprovers.1.Mobile 18888888888 \
+    --FlowInfos.1.FlowApprovers.1.ApproverType PERSON \
+    --FlowInfos.1.FlowApprovers.1.RecipientId yDwgKUUckp1jdybvUWptGKBD9TeupFMV \
+    --FlowInfos.1.Deadline 1698202075 \
+    --FlowInfos.1.TemplateId yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Approvers": [
+            {
+                "Approvers": [
+                    {
+                        "ApproverRoleName": "",
+                        "RecipientId": "yDSx0UUckptqcu0rUuvGhoq88RKQezmP",
+                        "SignId": "yDCVHUUckpwbqurqUuyXGHS1da6wB7v2"
+                    },
+                    {
+                        "ApproverRoleName": "",
+                        "RecipientId": "yDCVHUUckpwbqurlUuyXGHSChXDgrj1C",
+                        "SignId": "yDCVHUUckpwbqurgUuyXGHS1cwtnpm8o"
+                    }
+                ],
+                "FlowId": "yDCVHUUckpwbqur3UuyXGHSxpj1wPeJn"
+            },
+            {
+                "Approvers": [
+                    {
+                        "ApproverRoleName": "",
+                        "RecipientId": "yDSx0UUckptqcu0rUuvGhoq88RKQezmP",
+                        "SignId": "yDCVHUUckpwbqursUuyXGHSCOm804z86"
+                    },
+                    {
+                        "ApproverRoleName": "",
+                        "RecipientId": "yDCVHUUckpwbqurrUuyXGHS8cOo8z4Vc",
+                        "SignId": "yDCVHUUckpwbqulcUuyXGHSSvCaqc6He"
+                    }
+                ],
+                "FlowId": "yDCVHUUckpwbqur1UuyXGHS1JCWpHawy"
+            }
+        ],
+        "FlowGroupId": "yDCVHUUckpwbqurkUuyXGHS89Y9LLM4x",
+        "FlowIds": [
+            "yDCVHUUckpwbqur3UuyXGHSxpj1wPeJn",
+            "yDCVHUUckpwbqur1UuyXGHS1JCWpHawy"
+        ],
+        "RequestId": "s1711352113176693412",
+        "TaskInfos": [
+            {
+                "TaskId": "",
+                "TaskStatus": ""
+            },
+            {
+                "TaskId": "",
+                "TaskStatus": ""
+            }
+        ]
+    }
+}
+```
+

tccli/examples/essbasic/v20210526/CreateSignUrls.md

@@ -316,3 +316,55 @@ Output:
 }
 ```
 
+**Example 7: 获取合同组动态签署人补充链接**
+
+获取动态签署人补充链接，创建合同组时未指定具体签署人，可获取链接后推送给指定的人进行补充
+注： 
+`1.参数GenerateType需传值为RECIPIENT` 
+`2.需指定对应的合同组FlowGroupUrlInfo签署方角色编号（即RecipientId）` 
+
+
+Input: 
+
+```
+tccli essbasic CreateSignUrls --cli-unfold-argument  \
+    --FlowGroupId yDCVAUUckpwa592pUxoLjOlRVS9Zgusf \
+    --FlowGroupUrlInfo.FlowGroupApproverInfos.0.FlowId yDCVAUUckpwa59rcUxoLjOlEctyesTzj \
+    --FlowGroupUrlInfo.FlowGroupApproverInfos.0.RecipientId yDCVAUUckpwa59riUxoLjOluu9cf6B3s \
+    --FlowGroupUrlInfo.FlowGroupApproverInfos.1.FlowId yDCVAUUckpwa592dUxoLjOl8StWKvg9K \
+    --FlowGroupUrlInfo.FlowGroupApproverInfos.1.RecipientId yDCVAUUckpwa59r6UxoLjOlCC6ZHk7rL \
+    --GenerateType RECIPIENT \
+    --Agent.ProxyOrganizationOpenId 1000***8062 \
+    --Agent.ProxyOperator.OpenId yDR3L****eTdCt5TVx \
+    --Agent.AppId 125***319 \
+    --Endpoint 
+```
+
+Output: 
+```
+{
+    "Response": {
+        "ErrorMessages": [],
+        "RequestId": "s1696937862717144539",
+        "SignUrlInfos": [
+            {
+                "ApproverType": "",
+                "CustomUserId": "",
+                "Deadline": 0,
+                "FlowGroupId": "",
+                "FlowId": "yDwhGUUfe5g******CX8ZwTiSg8gISocy",
+                "IdCardNumber": "",
+                "Mobile": "",
+                "Name": "",
+                "OpenId": "",
+                "OrganizationName": "",
+                "SignId": "",
+                "SignOrder": 0,
+                "SignQrcodeUrl": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06dcbe2797f**************69ee4e24cd976dd8376dbd41c6ff227c803c4c561c",
+                "SignUrl": "https://test.essurl.cn/gGI***nZC"
+            }
+        ]
+    }
+}
+```
+

tccli/examples/faceid/v20180301/GetFaceIdRiskInfo.md

@@ -0,0 +1,26 @@
+**Example 1: 获取结果成功**
+
+获取结果成功
+
+Input: 
+
+```
+tccli faceid GetFaceIdRiskInfo --cli-unfold-argument  \
+    --FaceIdToken CE661F1A-0F1E-45BD-BE13-34C05CEA7681
+```
+
+Output: 
+```
+{
+    "Response": {
+        "CameraInfoLevel": null,
+        "CameraInfoTag": null,
+        "DeviceInfoLevel": 1,
+        "DeviceInfoTag": null,
+        "Extra": null,
+        "OpenId": "9B0104204DAB86054F6C9E38",
+        "RequestId": "dbabb231-4adc-4e88-b763-b3dfd9476923"
+    }
+}
+```
+

tccli/examples/faceid/v20180301/GetFaceidRiskInfoToken.md

@@ -0,0 +1,22 @@
+**Example 1: 获取 SDK 核验 token**
+
+获取 SDK 核验 token
+
+Input: 
+
+```
+tccli faceid GetFaceidRiskInfoToken --cli-unfold-argument  \
+    --Meta  \
+    --Extra 
+```
+
+Output: 
+```
+{
+    "Response": {
+        "FaceIdToken": "224C8901-0D1B-4350-914A-CFD74E54D940",
+        "RequestId": "63013220-4d82-4e2f-b508-a34286baac26"
+    }
+}
+```
+

tccli/examples/live/v20180801/CreateLiveTimeShiftTemplate.md

@@ -6,21 +6,21 @@ Input:
 
 ```
 tccli live CreateLiveTimeShiftTemplate --cli-unfold-argument  \
-    --Description xx \
-    --TranscodeTemplateIds 0 \
-    --RemoveWatermark True \
-    --TemplateName xx \
-    --ItemDuration 1 \
+    --TemplateName abc \
+    --Description abc \
+    --Area abc \
     --Duration 1 \
-    --Area xx
+    --ItemDuration 1 \
+    --RemoveWatermark True \
+    --TranscodeTemplateIds 0
 ```
 
 Output: 
 ```
 {
     "Response": {
-        "TemplateId": 1000,
-        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
+        "TemplateId": 0,
+        "RequestId": "abc"
     }
 }
 ```

tccli/examples/wedata/v20210820/ModifyTaskInfo.md

@@ -1,40 +1,65 @@
 **Example 1: 范例**
 
-
+修改任务信息
+POST / HTTP/1.1
+Host: wedata.tencentcloudapi.com
+Content-Type: application/json
+X-TC-Action: ModifyTaskInfo
+<公共请求参数>
 
 Input: 
 
 ```
 tccli wedata ModifyTaskInfo --cli-unfold-argument  \
-    --SourceServer  \
-    --EndTime 2099-12-31 23:59:59 \
-    --ExecutionEndTime  \
-    --TaskAction  \
-    --CycleStep 10 \
-    --TaskId 20220727140613327 \
-    --TargetServer DelayTime \
-    --ProjectId 1 \
-    --Notes  \
-    --Retriable 1 \
-    --DependencyWorkflow yes \
-    --ResourceGroup  \
-    --RetryWait 1 \
-    --ExecutionStartTime  \
-    --TaskName  \
-    --BrokerIp  \
+    --ProjectId abc \
+    --TaskId abc \
+    --DelayTime 0 \
     --StartupTime 0 \
-    --SelfDepend 1 \
-    --RunPriority 4 \
-    --TaskExt.0.Key aa \
-    --TaskExt.0.Value bb \
-    --InCharge  \
-    --TryLimit 3 \
-    --CycleType 1 \
-    --StartTime 2022-09-03 11:00:00 \
-    --TaskParamInfos.0.ParamValue ff \
-    --TaskParamInfos.0.ParamKey ee \
-    --YarnQueue  \
-    --CrontabExpression 
+    --SelfDepend 0 \
+    --StartTime abc \
+    --EndTime abc \
+    --TaskAction abc \
+    --CycleType 0 \
+    --CycleStep 0 \
+    --CrontabExpression abc \
+    --ExecutionStartTime abc \
+    --ExecutionEndTime abc \
+    --TaskName abc \
+    --RetryWait 0 \
+    --TryLimit 0 \
+    --Retriable 0 \
+    --RunPriority 0 \
+    --TaskExt.0.Key abc \
+    --TaskExt.0.Value abc \
+    --ResourceGroup abc \
+    --YarnQueue abc \
+    --BrokerIp abc \
+    --InCharge abc \
+    --Notes abc \
+    --TaskParamInfos.0.ParamKey abc \
+    --TaskParamInfos.0.ParamValue abc \
+    --SourceServer abc \
+    --TargetServer abc \
+    --DependencyWorkflow abc \
+    --DependencyConfigDTOs.0.ParentTask.TaskId abc \
+    --DependencyConfigDTOs.0.ParentTask.VirtualTaskId abc \
+    --DependencyConfigDTOs.0.ParentTask.VirtualFlag True \
+    --DependencyConfigDTOs.0.ParentTask.TaskName abc \
+    --DependencyConfigDTOs.0.ParentTask.WorkflowId abc \
+    --DependencyConfigDTOs.0.ParentTask.RealWorkflowId abc \
+    --DependencyConfigDTOs.0.ParentTask.CycleType 0 \
+    --DependencyConfigDTOs.0.SonTask.TaskId abc \
+    --DependencyConfigDTOs.0.SonTask.VirtualTaskId abc \
+    --DependencyConfigDTOs.0.SonTask.VirtualFlag True \
+    --DependencyConfigDTOs.0.SonTask.TaskName abc \
+    --DependencyConfigDTOs.0.SonTask.WorkflowId abc \
+    --DependencyConfigDTOs.0.SonTask.RealWorkflowId abc \
+    --DependencyConfigDTOs.0.SonTask.CycleType 0 \
+    --DependencyConfigDTOs.0.DependConfType abc \
+    --DependencyConfigDTOs.0.SubordinateCyclicType abc \
+    --DependencyConfigDTOs.0.DependencyStrategy abc \
+    --ExecutionTTL 0 \
+    --ScriptChange True
 ```
 
 Output: 
@@ -47,3 +72,28 @@ Output:
 }
 ```
 
+**Example 2: 错误示例**
+
+错误示例
+
+Input: 
+
+```
+tccli wedata ModifyTaskInfo --cli-unfold-argument  \
+    --ProjectId 1 \
+    --TaskId 1
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Error": {
+            "Code": "AuthFailure.SignatureFailure",
+            "Message": "请求签名验证失败，请检查您的签名计算是否正确。"
+        },
+        "RequestId": "11d5af39-eac3-4960-b0d5-5cced5cdc49f"
+    }
+}
+```
+

tccli/services/cdb/v20170320/api.json

@@ -5018,6 +5018,24 @@
           "name": "ProjectId",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "付费类型，PRE_PAID：包年包月，USED_PAID：按量计费。默认为按量计费",
+          "example": "无",
+          "member": "string",
+          "name": "PayType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例时长，PayType为PRE_PAID时必传，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。",
+          "example": "无",
+          "member": "int64",
+          "name": "Period",
+          "required": false,
+          "type": "int"
         }
       ],
       "type": "object"
@@ -5031,7 +5049,7 @@
           "example": "256117ed-efa08b54-61784d44-91781bbd",
           "member": "string",
           "name": "AsyncRequestId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -19069,108 +19087,144 @@
       ],
       "usage": "out"
     },
+    "TaskAttachInfo": {
+      "document": "任务列表中的部分任务支持特定的附加信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "升级任务：\n”FastUpgradeStatus“：表示升级类型。1-原地升级；0-普通升级。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "”FastUpgradeStatus“",
+          "member": "string",
+          "name": "AttachKey",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "升级任务：\n”FastUpgradeStatus“：表示升级类型。1-原地升级；0-普通升级。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "”1“",
+          "member": "string",
+          "name": "AttachValue",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "TaskDetail": {
       "document": "实例任务详情",
       "members": [
         {
           "disabled": false,
           "document": "错误码。",
-          "example": "",
+          "example": "无",
           "member": "int64",
           "name": "Code",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "错误信息。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "Message",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "实例任务 ID。",
-          "example": "",
+          "example": "无",
           "member": "int64",
           "name": "JobId",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "实例任务进度。",
-          "example": "",
+          "example": "无",
           "member": "int64",
           "name": "Progress",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "实例任务状态，可能的值包括：\n\"UNDEFINED\" - 未定义；\n\"INITIAL\" - 初始化；\n\"RUNNING\" - 运行中；\n\"SUCCEED\" - 执行成功；\n\"FAILED\" - 执行失败；\n\"KILLED\" - 已终止；\n\"REMOVED\" - 已删除；\n\"PAUSED\" - 已暂停。\n\"WAITING\" - 等待中（可撤销）",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "TaskStatus",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "实例任务类型，可能的值包括：\n\"ROLLBACK\" - 数据库回档；\n\"SQL OPERATION\" - SQL操作；\n\"IMPORT DATA\" - 数据导入；\n\"MODIFY PARAM\" - 参数设置；\n\"INITIAL\" - 初始化云数据库实例；\n\"REBOOT\" - 重启云数据库实例；\n\"OPEN GTID\" - 开启云数据库实例GTID；\n\"UPGRADE RO\" - 只读实例升级；\n\"BATCH ROLLBACK\" - 数据库批量回档；\n\"UPGRADE MASTER\" - 主实例升级；\n\"DROP TABLES\" - 删除云数据库库表；\n\"SWITCH DR TO MASTER\" - 灾备实例提升为主。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "TaskType",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "实例任务开始时间。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "StartTime",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "实例任务结束时间。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "EndTime",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
         {
           "disabled": false,
           "document": "任务关联的实例 ID。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "InstanceIds",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
         {
           "disabled": false,
           "document": "异步任务的请求 ID。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "AsyncRequestId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务的附加信息。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "TaskAttachInfo",
+          "name": "TaskAttachInfo",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"

tccli/services/cdb/v20170320/examples.json

@@ -158,8 +158,8 @@
     ],
     "CreateCloneInstance": [
       {
-        "document": "",
-        "input": "https://cdb.tencentcloudapi.com/?Action=CreateCloneInstance\n&InstanceId=cdb-9303wd4x\n&SpecifiedRollbackTime=2020-08-0116:27:43\n&UniqVpcId=vpc-594gwq4l\n&UniqSubnetId=subnet-dz5pj862\n&Memory=1000\n&Volume=50\n&<公共请求参数>",
+        "document": "克隆实例并回档到指定时间",
+        "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCloneInstance\n<公共请求参数>\n\n{\n    \"UniqVpcId\": \"vpc-594gwq4l\",\n    \"InstanceId\": \"cdb-9303wd4x\",\n    \"Volume\": \"50\",\n    \"UniqSubnetId\": \"subnet-dz5pj862\",\n    \"SpecifiedRollbackTime\": \"2020-08-0116:27:43\",\n    \"Memory\": \"1000\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n        \"AsyncRequestId\": \"256117ed-efa08b54-61784d44-91781bbd\"\n    }\n}",
         "title": "克隆实例并回档到指定时间"
       }