tccli 3.0.1212.1__py2.py3-none-any.whl → 3.0.1214.1__py2.py3-none-any.whl

tccli/services/cynosdb/v20190107/api.json

@@ -71,7 +71,7 @@
       "status": "online"
     },
     "CreateAccounts": {
-      "document": "创建用户账号",
+      "document": "本接口（CreateAccounts）用于创建用户账号。",
       "input": "CreateAccountsRequest",
       "name": "创建用户账号",
       "output": "CreateAccountsResponse",
@@ -92,7 +92,7 @@
       "status": "online"
     },
     "CreateBackup": {
-      "document": "为集群创建手动备份",
+      "document": "本接口（CreateBackup）用于为集群创建手动备份。",
       "input": "CreateBackupRequest",
       "name": "创建手动备份",
       "output": "CreateBackupResponse",
@@ -106,7 +106,7 @@
       "status": "online"
     },
     "CreateClusterDatabase": {
-      "document": "创建数据库",
+      "document": "本接口（CreateClusterDatabase）用于创建数据库。",
       "input": "CreateClusterDatabaseRequest",
       "name": "创建数据库",
       "output": "CreateClusterDatabaseResponse",
@@ -120,7 +120,7 @@
       "status": "online"
     },
     "CreateParamTemplate": {
-      "document": "本接口（CreateParamTemplate）用于创建参数模板",
+      "document": "本接口（CreateParamTemplate）用于创建参数模板。",
       "input": "CreateParamTemplateRequest",
       "name": "创建参数模板",
       "output": "CreateParamTemplateResponse",
@@ -134,7 +134,7 @@
       "status": "online"
     },
     "CreateProxyEndPoint": {
-      "document": "创建数据库代理连接点",
+      "document": "本接口（CreateProxyEndPoint）用于创建数据库代理连接点。",
       "input": "CreateProxyEndPointRequest",
       "name": "创建数据库代理连接点",
       "output": "CreateProxyEndPointResponse",
@@ -148,7 +148,7 @@
       "status": "online"
     },
     "DeleteAccounts": {
-      "document": "删除用户账号",
+      "document": "本接口（DeleteAccounts）用于删除用户账号。",
       "input": "DeleteAccountsRequest",
       "name": "删除用户账号",
       "output": "DeleteAccountsResponse",
@@ -162,7 +162,7 @@
       "status": "online"
     },
     "DeleteAuditRuleTemplates": {
-      "document": "删除审计规则模板",
+      "document": "本接口（DeleteAuditRuleTemplates）用于删除审计规则模板。",
       "input": "DeleteAuditRuleTemplatesRequest",
       "name": "删除审计规则模板",
       "output": "DeleteAuditRuleTemplatesResponse",
@@ -204,7 +204,7 @@
       "status": "online"
     },
     "DescribeAccountPrivileges": {
-      "document": "查询账号已有权限",
+      "document": "本接口（DescribeAccountPrivileges）用于查询账号已有权限。",
       "input": "DescribeAccountPrivilegesRequest",
       "name": "查询账号已有权限",
       "output": "DescribeAccountPrivilegesResponse",
@@ -239,7 +239,7 @@
       "status": "online"
     },
     "DescribeAuditRuleTemplates": {
-      "document": "查询审计规则模板信息",
+      "document": "本接口（DescribeAuditRuleTemplates）用于查询审计规则模板信息。",
       "input": "DescribeAuditRuleTemplatesRequest",
       "name": "查询审计规则模板",
       "output": "DescribeAuditRuleTemplatesResponse",
@@ -351,14 +351,14 @@
       "status": "online"
     },
     "DescribeClusterParams": {
-      "document": "本接口（DescribeClusterParams）用于查询集群参数",
+      "document": "本接口（DescribeClusterParams）用于查询集群参数。",
       "input": "DescribeClusterParamsRequest",
       "name": "查询集群参数",
       "output": "DescribeClusterParamsResponse",
       "status": "online"
     },
     "DescribeClusterPasswordComplexity": {
-      "document": "本接口（DescribeClusterPasswordComplexity）用于查看集群密码复杂度详情",
+      "document": "本接口（DescribeClusterPasswordComplexity）用于查看集群密码复杂度详情。",
       "input": "DescribeClusterPasswordComplexityRequest",
       "name": "查看集群密码复杂度详情",
       "output": "DescribeClusterPasswordComplexityResponse",
@@ -372,7 +372,7 @@
       "status": "online"
     },
     "DescribeDBSecurityGroups": {
-      "document": "查询实例安全组信息",
+      "document": "本接口（DescribeDBSecurityGroups）用于查询实例安全组信息。",
       "input": "DescribeDBSecurityGroupsRequest",
       "name": "查询实例安全组信息",
       "output": "DescribeDBSecurityGroupsResponse",
@@ -400,14 +400,14 @@
       "status": "online"
     },
     "DescribeInstanceErrorLogs": {
-      "document": "查询实例错误日志列表",
+      "document": "本接口（DescribeInstanceErrorLogs）用于查询实例错误日志列表。",
       "input": "DescribeInstanceErrorLogsRequest",
       "name": "查询错误日志列表",
       "output": "DescribeInstanceErrorLogsResponse",
       "status": "online"
     },
     "DescribeInstanceParams": {
-      "document": "该接口(DescribeInstanceParams)查询实例参数列表",
+      "document": "本接口（DescribeInstanceParams）用于查询实例参数列表。",
       "input": "DescribeInstanceParamsRequest",
       "name": "查询实例参数列表",
       "output": "DescribeInstanceParamsResponse",
@@ -449,14 +449,14 @@
       "status": "online"
     },
     "DescribeParamTemplateDetail": {
-      "document": "本接口（DescribeParamTemplateDetail）用于查询用户参数模板详情",
+      "document": "本接口（DescribeParamTemplateDetail）用于查询用户参数模板详情。",
       "input": "DescribeParamTemplateDetailRequest",
       "name": "查询参数模板详情",
       "output": "DescribeParamTemplateDetailResponse",
       "status": "online"
     },
     "DescribeParamTemplates": {
-      "document": "查询用户指定产品下的所有参数模板信息",
+      "document": "本接口（DescribeParamTemplates）用于查询用户指定产品下的所有参数模板信息。",
       "input": "DescribeParamTemplatesRequest",
       "name": "查询参数模板信息",
       "output": "DescribeParamTemplatesResponse",
@@ -470,7 +470,7 @@
       "status": "online"
     },
     "DescribeProxies": {
-      "document": "查询数据库代理列表",
+      "document": "本接口（DescribeProxies）用于查询数据库代理列表。",
       "input": "DescribeProxiesRequest",
       "name": "查询数据库代理列表",
       "output": "DescribeProxiesResponse",
@@ -512,7 +512,7 @@
       "status": "online"
     },
     "DescribeResourcesByDealName": {
-      "document": "查询订单关联实例",
+      "document": "本接口（DescribeResourcesByDealName）用于查询订单关联实例。",
       "input": "DescribeResourcesByDealNameRequest",
       "name": "查询订单关联实例",
       "output": "DescribeResourcesByDealNameResponse",
@@ -533,7 +533,7 @@
       "status": "online"
     },
     "DescribeSupportProxyVersion": {
-      "document": "查询支持的数据库代理版本",
+      "document": "本接口（DescribeSupportProxyVersion）用于查询支持的数据库代理版本。",
       "input": "DescribeSupportProxyVersionRequest",
       "name": "查询支持的数据库代理版本",
       "output": "DescribeSupportProxyVersionResponse",
@@ -582,7 +582,7 @@
       "status": "online"
     },
     "GrantAccountPrivileges": {
-      "document": "批量授权账号权限",
+      "document": "本接口（GrantAccountPrivileges）用于批量授权账号权限。",
       "input": "GrantAccountPrivilegesRequest",
       "name": "批量授权账号权限",
       "output": "GrantAccountPrivilegesResponse",
@@ -603,7 +603,7 @@
       "status": "online"
     },
     "InquirePriceRenew": {
-      "document": "查询续费集群价格",
+      "document": "本接口（InquirePriceRenew）用于查询续费集群价格。",
       "input": "InquirePriceRenewRequest",
       "name": "续费集群询价",
       "output": "InquirePriceRenewResponse",
@@ -631,21 +631,21 @@
       "status": "online"
     },
     "ModifyAccountHost": {
-      "document": "修改账号主机",
+      "document": "本接口（ModifyAccountHost）用于修改账号主机。",
       "input": "ModifyAccountHostRequest",
       "name": "修改账号主机",
       "output": "ModifyAccountHostResponse",
       "status": "online"
     },
     "ModifyAccountParams": {
-      "document": "修改账号配置",
+      "document": "本接口（ModifyAccountParams）用于修改账号配置。",
       "input": "ModifyAccountParamsRequest",
       "name": "修改账号配置",
       "output": "ModifyAccountParamsResponse",
       "status": "online"
     },
     "ModifyAccountPrivileges": {
-      "document": "修改账号库表权限",
+      "document": "本接口（ModifyAccountPrivileges）用于修改账号库表权限。",
       "input": "ModifyAccountPrivilegesRequest",
       "name": "修改账号库表权限",
       "output": "ModifyAccountPrivilegesResponse",
@@ -708,7 +708,7 @@
       "status": "online"
     },
     "ModifyClusterParam": {
-      "document": "修改集群参数",
+      "document": "本接口（ModifyClusterParam）用于修改集群参数。",
       "input": "ModifyClusterParamRequest",
       "name": "修改集群参数",
       "output": "ModifyClusterParamResponse",
@@ -729,7 +729,7 @@
       "status": "online"
     },
     "ModifyClusterStorage": {
-      "document": "调整包年包月存储容量",
+      "document": "本接口（ModifyClusterStorage）用于调整包年包月存储容量。",
       "input": "ModifyClusterStorageRequest",
       "name": "调整包年包月存储容量",
       "output": "ModifyClusterStorageResponse",
@@ -778,14 +778,14 @@
       "status": "online"
     },
     "ModifyProxyDesc": {
-      "document": "修改数据库代理描述",
+      "document": "本接口（ModifyProxyDesc）用于修改数据库代理描述。",
       "input": "ModifyProxyDescRequest",
       "name": "修改数据库代理描述",
       "output": "ModifyProxyDescResponse",
       "status": "online"
     },
     "ModifyProxyRwSplit": {
-      "document": "配置数据库代理读写分离",
+      "document": "本接口（ModifyProxyRwSplit）用于配置数据库代理读写分离。",
       "input": "ModifyProxyRwSplitRequest",
       "name": "配置数据库代理读写分离",
       "output": "ModifyProxyRwSplitResponse",
@@ -820,7 +820,7 @@
       "status": "online"
     },
     "ModifyVipVport": {
-      "document": "修改实例组ip，端口",
+      "document": "本接口（ModifyVipVport）用于修改实例组ip，端口。",
       "input": "ModifyVipVportRequest",
       "name": "修改实例组ip，端口",
       "output": "ModifyVipVportResponse",
@@ -834,7 +834,7 @@
       "status": "online"
     },
     "OfflineInstance": {
-      "document": "销毁实例",
+      "document": "本接口（OfflineInstance）用于销毁实例。",
       "input": "OfflineInstanceRequest",
       "name": "销毁实例",
       "output": "OfflineInstanceResponse",
@@ -890,7 +890,7 @@
       "status": "online"
     },
     "ReloadBalanceProxyNode": {
-      "document": "负载均衡数据库代理",
+      "document": "本接口（ReloadBalanceProxyNode）用于负载均衡数据库代理。",
       "input": "ReloadBalanceProxyNodeRequest",
       "name": "负载均衡数据库代理",
       "output": "ReloadBalanceProxyNodeResponse",
@@ -911,14 +911,14 @@
       "status": "online"
     },
     "ResetAccountPassword": {
-      "document": "本接口(ResetAccountPassword)用于修改数据库账号密码",
+      "document": "本接口（ResetAccountPassword）用于修改数据库账号密码。",
       "input": "ResetAccountPasswordRequest",
       "name": "修改数据库账号密码",
       "output": "ResetAccountPasswordResponse",
       "status": "online"
     },
     "RestartInstance": {
-      "document": "重启实例",
+      "document": "本接口（RestartInstance）用于重启实例。",
       "input": "RestartInstanceRequest",
       "name": "重启实例",
       "output": "RestartInstanceResponse",
@@ -939,7 +939,7 @@
       "status": "online"
     },
     "RollBackCluster": {
-      "document": "本接口（RollBackCluster）用于集群回档",
+      "document": "本接口（RollBackCluster）用于集群回档。",
       "input": "RollBackClusterRequest",
       "name": "集群回档",
       "output": "RollBackClusterResponse",
@@ -960,14 +960,14 @@
       "status": "online"
     },
     "SearchClusterTables": {
-      "document": "本接口(SearchClusterTables)搜索集群数据表列表",
+      "document": "本接口（SearchClusterTables）用于搜索集群数据表列表。",
       "input": "SearchClusterTablesRequest",
       "name": "搜索集群数据表列表",
       "output": "SearchClusterTablesResponse",
       "status": "online"
     },
     "SetRenewFlag": {
-      "document": "SetRenewFlag设置实例的自动续费功能",
+      "document": "本接口（SetRenewFlag）用于设置实例的自动续费功能。",
       "input": "SetRenewFlagRequest",
       "name": "设置自动续费",
       "output": "SetRenewFlagResponse",
@@ -988,7 +988,7 @@
       "status": "online"
     },
     "SwitchClusterVpc": {
-      "document": "更换集群vpc",
+      "document": "本接口（SwitchClusterVpc）用于更换集群vpc。",
       "input": "SwitchClusterVpcRequest",
       "name": "更换集群vpc",
       "output": "SwitchClusterVpcResponse",
@@ -1002,7 +1002,7 @@
       "status": "online"
     },
     "SwitchProxyVpc": {
-      "document": "本接口(SwitchProxyVpc)更换数据库代理vpc",
+      "document": "本接口（SwitchProxyVpc）用于更换数据库代理vpc。",
       "input": "SwitchProxyVpcRequest",
       "name": "更换数据库代理vpc",
       "output": "SwitchProxyVpcResponse",
@@ -1037,7 +1037,7 @@
       "status": "online"
     },
     "UpgradeProxyVersion": {
-      "document": "升级数据库代理版本",
+      "document": "本接口（UpgradeProxyVersion）用于升级数据库代理版本。",
       "input": "UpgradeProxyVersionRequest",
       "name": "升级数据库代理版本",
       "output": "UpgradeProxyVersionResponse",
@@ -11134,7 +11134,17 @@
     },
     "DescribeProxySpecsRequest": {
       "document": "DescribeProxySpecs请求参数结构体",
-      "members": [],
+      "members": [
+        {
+          "disabled": false,
+          "document": "集群id",
+          "example": "cynosdbmysql-12xx4321",
+          "member": "string",
+          "name": "ClusterId",
+          "required": false,
+          "type": "string"
+        }
+      ],
       "type": "object"
     },
     "DescribeProxySpecsResponse": {
@@ -11146,6 +11156,7 @@
           "example": "无",
           "member": "ProxySpec",
           "name": "ProxySpecs",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },

tccli/services/cynosdb/v20190107/examples.json

@@ -747,8 +747,8 @@
     "ModifyAccountHost": [
       {
         "document": "修改账号主机",
-        "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountHost\n<公共请求参数>\n\n{\n    \"ClusterId\": \"abc\",\n    \"NewHost\": \"abc\",\n    \"Account\": {\n        \"AccountName\": \"abc\",\n        \"Host\": \"abc\"\n    }\n}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"128046\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountHost\n<公共请求参数>\n\n{\n    \"ClusterId\": \"cynosdbmysql-on5xw0ni\",\n    \"NewHost\": \"192.168.12.15\",\n    \"Account\": {\n        \"AccountName\": \"tomo1\",\n        \"Host\": \"%\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"3558f586-4f83-4f3b-aabc-49d20126f657\"\n    }\n}",
         "title": "修改账号主机"
       }
     ],

tccli/services/dbbrain/v20210527/api.json

@@ -3575,7 +3575,7 @@
           "example": "-",
           "member": "UserProfile",
           "name": "ProfileList",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": true
         },
@@ -3585,7 +3585,7 @@
           "example": "1",
           "member": "int64",
           "name": "TotalCount",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },

tccli/services/dbbrain/v20210527/examples.json

@@ -260,7 +260,7 @@
       {
         "document": "",
         "input": "https://dbbrain.tencentcloudapi.com/?Action=DescribeMailProfile\n&Product=mysql\n&ProfileType=scheduler_mail_configuration\n&Offset=0\n&Limit=20\n&<公共请求参数>",
-        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"RequestId\": \"c7324330-5fc8-11eb-a3f4-96666666\",\n        \"ProfileList\": [\n            {\n                \"ProfileId\": \"12345\",\n                \"ProfileType\": \"dbScan_mail_configuration\",\n                \"ProfileLevel\": \"User\",\n                \"ProfileName\": \"测试uin\",\n                \"ProfileInfo\": {\n                    \"MailConfiguration\": {\n                        \"HealthStatus\": [\n                            \"HEALTH\",\n                            \"SUB_HEALTH\",\n                            \"RISK\",\n                            \"HIGH_RISK\"\n                        ],\n                        \"Region\": [\n                            \"eu-moscow\"\n                        ],\n                        \"ContactGroup\": [],\n                        \"SendMail\": 0,\n                        \"ContactPerson\": [\n                            123\n                        ]\n                    },\n                    \"Language\": \"zh\"\n                }\n            }\n        ]\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"RequestId\": \"c7324330-5fc8-11eb-a3f4-96666666\",\n        \"ProfileList\": [\n            {\n                \"ProfileId\": \"12345\",\n                \"ProfileType\": \"dbScan_mail_configuration\",\n                \"ProfileLevel\": \"User\",\n                \"ProfileName\": \"测试uin\",\n                \"ProfileInfo\": {\n                    \"MailConfiguration\": {\n                        \"HealthStatus\": [\n                            \"HEALTH\",\n                            \"SUB_HEALTH\",\n                            \"RISK\",\n                            \"HIGH_RISK\"\n                        ],\n                        \"Region\": [\n                            \"ap-guangzhou\"\n                        ],\n                        \"ContactGroup\": [],\n                        \"SendMail\": 0,\n                        \"ContactPerson\": [\n                            123\n                        ]\n                    },\n                    \"Language\": \"zh\"\n                }\n            }\n        ]\n    }\n}",
         "title": "获取邮件配置"
       }
     ],

tccli/services/ecdn/v20191012/api.json

@@ -838,7 +838,7 @@
           "example": "无",
           "member": "DomainData",
           "name": "Data",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -848,7 +848,7 @@
           "example": "20",
           "member": "int64",
           "name": "TotalCount",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },

tccli/services/ecdn/v20191012/examples.json

@@ -52,7 +52,7 @@
       {
         "document": "",
         "input": "https://ecdn.tencentcloudapi.com/?Action=DescribeEcdnDomainStatistics\n&StartTime=2018-09-04 00:00:00\n&EndTime=2018-09-04 12:00:00\n&Metrics.0=flux\n&Metrics.1=delay\n&Metrics.2=request\n&Metrics.3=bandwidth\n&Domains.0=www.test.com\n&Projects.0=0\n&<公共请求参数>",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"13d41d37-546f-42ed-a3b9-ff82a51ecd0a\",\n        \"Data\": [\n            {\n                \"Resource\": \"stsdk.vivo.com.cn\",\n                \"DetailData\": [\n                    {\n                        \"Name\": \"request\",\n                        \"Value\": 5628872958\n                    },\n                    {\n                        \"Name\": \"flux\",\n                        \"Value\": 3535122082980\n                    },\n                    {\n                        \"Name\": \"delay\",\n                        \"Value\": 87\n                    },\n                    {\n                        \"Name\": \"bandwidth\",\n                        \"Value\": 825782981\n                    }\n                ]\n            }\n        ],\n        \"TotalCount\": 20\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"13d41d37-546f-42ed-a3b9-ff82a51ecd0a\",\n        \"Data\": [\n            {\n                \"Resource\": \"www.test.com\",\n                \"DetailData\": [\n                    {\n                        \"Name\": \"request\",\n                        \"Value\": 5628872958\n                    },\n                    {\n                        \"Name\": \"flux\",\n                        \"Value\": 3535122082980\n                    },\n                    {\n                        \"Name\": \"delay\",\n                        \"Value\": 87\n                    },\n                    {\n                        \"Name\": \"bandwidth\",\n                        \"Value\": 825782981\n                    }\n                ]\n            }\n        ],\n        \"TotalCount\": 20\n    }\n}",
         "title": "域名统计指标查询"
       }
     ],

tccli/services/emr/v20190103/api.json

@@ -239,9 +239,9 @@
       "status": "online"
     },
     "DescribeTrinoQueryInfo": {
-      "document": "获取trino查询结果",
+      "document": "查询Trino(PrestoSQL)查询信息",
       "input": "DescribeTrinoQueryInfoRequest",
-      "name": "获取trino查询信息",
+      "name": "查询Trino(PrestoSQL)查询信息",
       "output": "DescribeTrinoQueryInfoResponse",
       "status": "online"
     },

tccli/services/emr/v20190103/examples.json

@@ -277,7 +277,7 @@
         "document": "",
         "input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTrinoQueryInfo\n<公共请求参数>\n\n{\n    \"InstanceId\": \"emr-d82w3t9p\",\n    \"PageSize\": 10,\n    \"StartTime\": 1701792000,\n    \"EndTime\": 1701878399,\n    \"Page\": 1\n}",
         "output": "{\n    \"Response\": {\n        \"QueryInfoList\": [\n            {\n                \"Catalog\": \"hive\",\n                \"ClientIpAddr\": \"10.0.1.104\",\n                \"CompletedSplits\": \"\",\n                \"CpuTime\": 0,\n                \"CumulativeMemory\": 0,\n                \"DurationMillis\": 0,\n                \"EndTime\": 0,\n                \"Id\": \"20240708_111543_00007_lcmdbi8z\",\n                \"InternalNetworkBytes\": 0,\n                \"OutputBytes\": 0,\n                \"PeakUserMemoryBytes\": 0,\n                \"PhysicalInputBytes\": 0,\n                \"ProcessedInputBytes\": 0,\n                \"SqlCompileTime\": 0,\n                \"StartTime\": 0,\n                \"State\": \"QUEUED\",\n                \"Statement\": \"create table impala_ranger\",\n                \"User\": \"hadoop\",\n                \"WrittenBytes\": 0\n            }\n        ],\n        \"RequestId\": \"cfbbbe0f-5d30-4bf7-b87b-428b14ac3ws22\",\n        \"TotalCount\": 18\n    }\n}",
-        "title": "获取trino查询结果"
+        "title": "查询Trino(PrestoSQL)查询信息"
       }
     ],
     "DescribeUsersForUserManager": [

tccli/services/ess/v20201111/api.json

@@ -302,7 +302,7 @@
       "status": "online"
     },
     "CreateReleaseFlow": {
-      "document": "发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。\n解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。\n\n注意：\n<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>\n<li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>\n<li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>\n<li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>\n<li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>\n<li>在解除协议签署完毕后，原合同及解除协议均变为已解除状态。</li>\n<li>非原合同企业参与人发起解除协议时，需要有<code>解除合同的权限</code>。</li>\n</ul>\n\n![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)",
+      "document": "发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。\n解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。\n\n注意：\n<ul>\n<li><strong>完成原合同签署后方可发起解除协议：</strong>只有在原合同所有签署人完成签署后，才可以启动解除协议的流程。</li>\n<li><strong>原合同状态更新：</strong>解除协议一旦签署完毕，原合同及解除协议状态将更新为“已解除”。</li>\n<li><strong>解除协议的个人参与要求：</strong>原合同中的个人参与者必须直接参与解除协议，禁止替换为其他第三方个人。</li>\n<li><strong>企业参与人的代理权：</strong>若原合同的企业参与人无法亲自参与解除协议，可指派具有等同权限的企业员工代行。</li>\n<li><strong>解除协议的费用问题：</strong>发起解除协议将产生费用，其扣费标准与其他企业合同相同。</li>\n<li><strong>解除协议的发起资格：</strong>仅限原合同中的企业类型参与者发起解除协议，个人参与者无此权限。</li>\n<li><strong>非原合同企业参与者的权限：</strong>非原合同的企业参与者发起解除协议时，必须具备相应的解除权限。</li>\n<li><strong>自动签署：</strong>支持本企业的自动签署，不支持其他企业的自动签署（不能不动神色的把别人参与的合同作废了）</li>\n</ul>\n![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)",
       "input": "CreateReleaseFlowRequest",
       "name": "发起解除协议",
       "output": "CreateReleaseFlowResponse",
@@ -2683,6 +2683,24 @@
           "name": "FlowBatchUrlInfo",
           "required": false,
           "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "<b>只有在生成H5签署链接的情形下</b>（ 如调用<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口），该配置才会生效。  您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。  注意： 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。 3. 签署完成后，可以通过<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo\" target=\"_blank\">查询签署认证人脸视频</a>获取到当时的视频。",
+          "example": "无",
+          "member": "Intention",
+          "name": "Intention",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "是否开启缓存签署人信息",
+          "example": "无",
+          "member": "bool",
+          "name": "CacheApproverInfo",
+          "required": false,
+          "type": "bool"
         }
       ],
       "type": "object"

tccli/services/ess/v20201111/examples.json

@@ -192,6 +192,12 @@
         "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    \"FlowBatchUrlInfo\": {\n        \"FlowBatchApproverInfos\": [\n            {\n                \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n                \"RecipientId\": \"yDCmvUUckpup6xhwUxKRs1rIRejg254i\"\n            },\n            {\n                \"FlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n                \"RecipientId\": \"yDCmvUUckpup6xh1UxKRs1rwHjT5QyHH\"\n            }\n        ]\n    }\n}",
         "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}",
         "title": "发起合同后，获取C端签署人的H5批量领取链接"
+      },
+      {
+        "document": "1. 为个人用户生成合同组H5批量签署链接\n2. 使用默认的签名类型\n3. 使用默认的签署方式\n4. 默认跳转到合同列表页\n5.指定视频问答模式的认证方式",
+        "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    \"FlowGroupId\": \"yDSLcUUck****ysv1OQYIe9H\",\n    \"ApproverSignTypes\": [\n        1\n    ],\n    \"Intention\": {\n        \"IntentionType\": 1,\n        \"IntentionQuestions\": [\n            {\n                \"Question\": \"请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。\",\n                \"Answers\": [\n                    \"同意\",\n                    \"我同意\"\n                ]\n            }\n        ]\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowApproverUrlInfo\": {\n            \"ApproverMobile\": \"13200000000\",\n            \"ApproverName\": \"典子谦\",\n            \"ApproverType\": 1,\n            \"LongUrl\": \"https://quick.qian.tencent.cn/guide?Code=yDwi0U**xoK&CodeType=QUICK&shortKey=yDw**S2ATh95&token=Y9b**O\",\n            \"SignUrl\": \"https://essurl.cn/Y9b**O\"\n        },\n        \"RequestId\": \"s169**68\"\n    }\n}",
+        "title": "为个人用户，创建合同组批量签署链接,并且指定视频问答模式的认证方式"
       }
     ],
     "CreateBatchSignUrl": [

tccli/services/essbasic/v20210526/api.json

@@ -1692,6 +1692,24 @@
           "name": "FlowBatchUrlInfo",
           "required": false,
           "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "<b>只有在生成H5签署链接的情形下</b>（ 如调用<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl\" target=\"_blank\">获取H5签署链接</a>、<a href=\"https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl\" target=\"_blank\">获取H5批量签署链接</a>等接口），该配置才会生效。  您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。  注意： 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。 3. 签署完成后，可以通过<a href=\"https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo\" target=\"_blank\">查询签署认证人脸视频</a>获取到当时的视频。",
+          "example": "无",
+          "member": "Intention",
+          "name": "Intention",
+          "required": false,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "是否开启缓存签署人信息",
+          "example": "无",
+          "member": "bool",
+          "name": "CacheApproverInfo",
+          "required": false,
+          "type": "bool"
         }
       ],
       "type": "object"

tccli/services/essbasic/v20210526/examples.json

@@ -112,6 +112,12 @@
         "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    \"FlowBatchUrlInfo\": {\n        \"FlowBatchApproverInfos\": [\n            {\n                \"FlowId\": \"yDwFkUUckpstin4sUuZjBEY5Ia2XB7sz\",\n                \"RecipientId\": \"yDCmvUUckpup6xhwUxKRs1rIRejg254i\"\n            },\n            {\n                \"FlowId\": \"yDwFkUUckpstzjhfUugNAWf1KibXqS26\",\n                \"RecipientId\": \"yDCmvUUckpup6xh1UxKRs1rwHjT5QyHH\"\n            }\n        ]\n    }\n}",
         "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}",
         "title": "发起合同后，获取C端签署人的H5批量领取链接"
+      },
+      {
+        "document": "为个人用户生成合同组H5批量签署链接, 并且指定视频问答模式的认证方式",
+        "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    \"ApproverSignTypes\": [\n        1\n    ],\n    \"Intention\": {\n        \"IntentionType\": 1,\n        \"IntentionQuestions\": [\n            {\n                \"Question\": \"请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。\",\n                \"Answers\": [\n                    \"同意\",\n                    \"我同意\"\n                ]\n            }\n        ]\n    },\n    \"FlowGroupId\": \"yDSL9UUckpo*****jwSsug2y3cW\"\n}",
+        "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\": \"13200000000\",\n            \"Name\": \"典子谦\",\n            \"SignUrl\": \"https://test.essurl.cn/C**E\"\n        },\n        \"RequestId\": \"s16986**08\"\n    }\n}",
+        "title": "为个人用户生成合同组H5批量签署链接, 并且指定视频问答模式的认证方式"
       }
     ],
     "ChannelCreateBatchSignUrl": [