tccli 3.0.990.1__py2.py3-none-any.whl → 3.0.992.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/car/v20220110/DestroySession.md +1 -1
  3. tccli/examples/cls/v20201016/CheckFunction.md +25 -0
  4. tccli/examples/ess/v20201111/DescribeBillUsageDetail.md +108 -0
  5. tccli/examples/essbasic/v20210526/ChannelCreatePreparedPersonalEsign.md +92 -0
  6. tccli/examples/essbasic/v20210526/ChannelCreateReleaseFlow.md +94 -19
  7. tccli/examples/essbasic/v20210526/ChannelCreateSealPolicy.md +88 -0
  8. tccli/examples/essbasic/v20210526/ChannelDescribeEmployees.md +85 -45
  9. tccli/examples/essbasic/v20210526/DescribeBillUsageDetail.md +69 -0
  10. tccli/examples/essbasic/v20210526/SyncProxyOrganization.md +9 -9
  11. tccli/examples/mna/v20210119/GetNetMonitor.md +228 -0
  12. tccli/examples/ocr/v20181119/VatInvoiceVerifyNew.md +4 -0
  13. tccli/examples/tdmq/v20200217/DescribeRocketMQCluster.md +4 -4
  14. tccli/examples/teo/v20220901/BindSharedCNAME.md +48 -0
  15. tccli/examples/teo/v20220901/CreateSharedCNAME.md +4 -4
  16. tccli/examples/teo/v20220901/DeleteSharedCNAME.md +21 -0
  17. tccli/examples/waf/v20180125/DescribeCCRuleList.md +16 -2
  18. tccli/examples/waf/v20180125/DescribeModuleStatus.md +9 -1
  19. tccli/examples/waf/v20180125/ModifyModuleStatus.md +9 -1
  20. tccli/services/aiart/v20221229/api.json +2 -2
  21. tccli/services/car/v20220110/api.json +2 -2
  22. tccli/services/car/v20220110/examples.json +1 -1
  23. tccli/services/clb/v20180317/api.json +1 -1
  24. tccli/services/cls/cls_client.py +53 -0
  25. tccli/services/cls/v20201016/api.json +72 -0
  26. tccli/services/cls/v20201016/examples.json +8 -0
  27. tccli/services/ess/ess_client.py +53 -0
  28. tccli/services/ess/v20201111/api.json +228 -3
  29. tccli/services/ess/v20201111/examples.json +20 -0
  30. tccli/services/essbasic/v20210526/api.json +38 -29
  31. tccli/services/essbasic/v20210526/examples.json +51 -15
  32. tccli/services/mna/mna_client.py +53 -0
  33. tccli/services/mna/v20210119/api.json +142 -0
  34. tccli/services/mna/v20210119/examples.json +8 -0
  35. tccli/services/ocr/v20181119/api.json +65 -25
  36. tccli/services/ocr/v20181119/examples.json +1 -1
  37. tccli/services/tdmq/v20200217/api.json +107 -38
  38. tccli/services/tdmq/v20200217/examples.json +3 -3
  39. tccli/services/teo/teo_client.py +114 -8
  40. tccli/services/teo/v20220901/api.json +127 -4
  41. tccli/services/teo/v20220901/examples.json +26 -4
  42. tccli/services/waf/v20180125/api.json +194 -5
  43. tccli/services/waf/v20180125/examples.json +5 -5
  44. {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/METADATA +2 -2
  45. {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/RECORD +48 -42
  46. {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/WHEEL +0 -0
  47. {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/entry_points.txt +0 -0
  48. {tccli-3.0.990.1.dist-info → tccli-3.0.992.1.dist-info}/license_files/LICENSE +0 -0
@@ -14,6 +14,13 @@
14
14
  "output": "ApplyConfigToMachineGroupResponse",
15
15
  "status": "online"
16
16
  },
17
+ "CheckFunction": {
18
+ "document": "本接口用于数据加工DSL函数的语法校验。",
19
+ "input": "CheckFunctionRequest",
20
+ "name": "语法校验接口",
21
+ "output": "CheckFunctionResponse",
22
+ "status": "online"
23
+ },
17
24
  "CheckRechargeKafkaServer": {
18
25
  "document": "本接口用于校验Kafka服务集群是否可以正常访问",
19
26
  "input": "CheckRechargeKafkaServerRequest",
@@ -1432,6 +1439,71 @@
1432
1439
  ],
1433
1440
  "usage": "both"
1434
1441
  },
1442
+ "CheckFunctionRequest": {
1443
+ "document": "CheckFunction请求参数结构体",
1444
+ "members": [
1445
+ {
1446
+ "disabled": false,
1447
+ "document": "用户输入的加工语句",
1448
+ "example": "fields_set(\"my_field\",\"value\")",
1449
+ "member": "string",
1450
+ "name": "EtlContent",
1451
+ "required": true,
1452
+ "type": "string"
1453
+ },
1454
+ {
1455
+ "disabled": false,
1456
+ "document": "加工任务目的topic_id以及别名",
1457
+ "example": "topicid-1",
1458
+ "member": "DataTransformResouceInfo",
1459
+ "name": "DstResources",
1460
+ "required": false,
1461
+ "type": "list"
1462
+ },
1463
+ {
1464
+ "disabled": false,
1465
+ "document": "数据加工目标主题的类型. 1 固定主题 2动态创建",
1466
+ "example": "1",
1467
+ "member": "int64",
1468
+ "name": "FuncType",
1469
+ "required": false,
1470
+ "type": "int"
1471
+ }
1472
+ ],
1473
+ "type": "object"
1474
+ },
1475
+ "CheckFunctionResponse": {
1476
+ "document": "CheckFunction返回参数结构体",
1477
+ "members": [
1478
+ {
1479
+ "disabled": false,
1480
+ "document": "失败错误码",
1481
+ "example": "10001",
1482
+ "member": "int64",
1483
+ "name": "ErrorCode",
1484
+ "output_required": true,
1485
+ "type": "int",
1486
+ "value_allowed_null": false
1487
+ },
1488
+ {
1489
+ "disabled": false,
1490
+ "document": "失败错误信息",
1491
+ "example": "Invalid Params",
1492
+ "member": "string",
1493
+ "name": "ErrorMsg",
1494
+ "output_required": true,
1495
+ "type": "string",
1496
+ "value_allowed_null": false
1497
+ },
1498
+ {
1499
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1500
+ "member": "string",
1501
+ "name": "RequestId",
1502
+ "type": "string"
1503
+ }
1504
+ ],
1505
+ "type": "object"
1506
+ },
1435
1507
  "CheckRechargeKafkaServerRequest": {
1436
1508
  "document": "CheckRechargeKafkaServer请求参数结构体",
1437
1509
  "members": [
@@ -16,6 +16,14 @@
16
16
  "title": "应用采集配置到指定机器组"
17
17
  }
18
18
  ],
19
+ "CheckFunction": [
20
+ {
21
+ "document": "校验数据加工函数的语法",
22
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CheckFunction\n<公共请求参数>\n\n{\n \"EtlContent\": \"fields_set()\",\n \"DstResources\": [\n {\n \"TopicId\": \"x56493046-XXXX-4194-81f6-c2e75569b031\",\n \"Alias\": \"example\"\n }\n ],\n \"FuncType\": 1\n}",
23
+ "output": "{\n \"Response\": {\n \"ErrorCode\": 0,\n \"ErrorMsg\": \"\",\n \"RequestId\": \"x56493046-XXXX-4194-81f6-c2e75569b031\"\n }\n}",
24
+ "title": "校验数据加工函数语法"
25
+ }
26
+ ],
19
27
  "CheckRechargeKafkaServer": [
20
28
  {
21
29
  "document": "校验用户输入Kafka服务地址是否可访问",
@@ -3137,6 +3137,58 @@ def doCancelUserAutoSignEnableUrl(args, parsed_globals):
3137
3137
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
3138
3138
 
3139
3139
 
3140
+ def doDescribeBillUsageDetail(args, parsed_globals):
3141
+ g_param = parse_global_arg(parsed_globals)
3142
+
3143
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
3144
+ cred = credential.CVMRoleCredential()
3145
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
3146
+ cred = credential.STSAssumeRoleCredential(
3147
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
3148
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
3149
+ )
3150
+ 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):
3151
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
3152
+ else:
3153
+ cred = credential.Credential(
3154
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
3155
+ )
3156
+ http_profile = HttpProfile(
3157
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
3158
+ reqMethod="POST",
3159
+ endpoint=g_param[OptionsDefine.Endpoint],
3160
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
3161
+ )
3162
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
3163
+ if g_param[OptionsDefine.Language]:
3164
+ profile.language = g_param[OptionsDefine.Language]
3165
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
3166
+ client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
3167
+ client._sdkVersion += ("_CLI_" + __version__)
3168
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
3169
+ model = models.DescribeBillUsageDetailRequest()
3170
+ model.from_json_string(json.dumps(args))
3171
+ start_time = time.time()
3172
+ while True:
3173
+ rsp = client.DescribeBillUsageDetail(model)
3174
+ result = rsp.to_json_string()
3175
+ try:
3176
+ json_obj = json.loads(result)
3177
+ except TypeError as e:
3178
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
3179
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
3180
+ break
3181
+ cur_time = time.time()
3182
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
3183
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
3184
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
3185
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
3186
+ else:
3187
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
3188
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
3189
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
3190
+
3191
+
3140
3192
  def doDescribeIntegrationDepartments(args, parsed_globals):
3141
3193
  g_param = parse_global_arg(parsed_globals)
3142
3194
 
@@ -3572,6 +3624,7 @@ ACTION_MAP = {
3572
3624
  "DeleteIntegrationEmployees": doDeleteIntegrationEmployees,
3573
3625
  "CreateSchemeUrl": doCreateSchemeUrl,
3574
3626
  "CancelUserAutoSignEnableUrl": doCancelUserAutoSignEnableUrl,
3627
+ "DescribeBillUsageDetail": doDescribeBillUsageDetail,
3575
3628
  "DescribeIntegrationDepartments": doDescribeIntegrationDepartments,
3576
3629
  "CreateDocument": doCreateDocument,
3577
3630
  "CreateSealPolicy": doCreateSealPolicy,
@@ -294,6 +294,13 @@
294
294
  "output": "DeleteSealPoliciesResponse",
295
295
  "status": "online"
296
296
  },
297
+ "DescribeBillUsageDetail": {
298
+ "document": "查询企业使用情况",
299
+ "input": "DescribeBillUsageDetailRequest",
300
+ "name": "查询企业计费使用情况",
301
+ "output": "DescribeBillUsageDetailResponse",
302
+ "status": "online"
303
+ },
297
304
  "DescribeExtendedServiceAuthInfos": {
298
305
  "document": "查询企业扩展服务的开通和授权情况,当前支持查询以下内容:\n1. 企业自动签\n2. 企业与港澳台居民签署合同\n3. 使用手机号验证签署方身份\n4. 骑缝章\n5. 批量签署能力\n6. 拓宽签署方年龄限制",
299
306
  "input": "DescribeExtendedServiceAuthInfosRequest",
@@ -358,7 +365,7 @@
358
365
  "status": "online"
359
366
  },
360
367
  "DescribeIntegrationRoles": {
361
- "document": "此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。\n\n注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`",
368
+ "document": "此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。",
362
369
  "input": "DescribeIntegrationRolesRequest",
363
370
  "name": "查询企业角色列表",
364
371
  "output": "DescribeIntegrationRolesResponse",
@@ -973,6 +980,122 @@
973
980
  ],
974
981
  "usage": "in"
975
982
  },
983
+ "BillUsageDetail": {
984
+ "document": "用户计费使用情况详情",
985
+ "members": [
986
+ {
987
+ "disabled": false,
988
+ "document": "合同流程ID,为32位字符串。\n建议开发者妥善保存此流程ID,以便于顺利进行后续操作。\n可登录腾讯电子签控制台,在 \"合同\"->\"合同中心\" 中查看某个合同的FlowId(在页面中展示为合同ID)。\n注意:此字段可能返回 null,表示取不到有效值。",
989
+ "example": "ydxxxxxxxx",
990
+ "member": "string",
991
+ "name": "FlowId",
992
+ "output_required": false,
993
+ "type": "string",
994
+ "value_allowed_null": true
995
+ },
996
+ {
997
+ "disabled": false,
998
+ "document": "经办人名称\n注意:此字段可能返回 null,表示取不到有效值。",
999
+ "example": "张三",
1000
+ "member": "string",
1001
+ "name": "OperatorName",
1002
+ "output_required": false,
1003
+ "type": "string",
1004
+ "value_allowed_null": true
1005
+ },
1006
+ {
1007
+ "disabled": false,
1008
+ "document": "发起方组织机构名称\n注意:此字段可能返回 null,表示取不到有效值。",
1009
+ "example": "张三公司",
1010
+ "member": "string",
1011
+ "name": "CreateOrganizationName",
1012
+ "output_required": false,
1013
+ "type": "string",
1014
+ "value_allowed_null": true
1015
+ },
1016
+ {
1017
+ "disabled": false,
1018
+ "document": "合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。\n该名称还将用于合同签署完成后的下载文件名。\n注意:此字段可能返回 null,表示取不到有效值。",
1019
+ "example": "张三发起的合同",
1020
+ "member": "string",
1021
+ "name": "FlowName",
1022
+ "output_required": false,
1023
+ "type": "string",
1024
+ "value_allowed_null": true
1025
+ },
1026
+ {
1027
+ "disabled": false,
1028
+ "document": "0 还没有发起 1等待签署 2部分签署 3拒签 4已签署 5已过期 6已撤销 7还没有预发起 8等待填写 9部分填写 10拒填 11已解除\n注意:此字段可能返回 null,表示取不到有效值。",
1029
+ "example": "4",
1030
+ "member": "int64",
1031
+ "name": "Status",
1032
+ "output_required": false,
1033
+ "type": "int",
1034
+ "value_allowed_null": true
1035
+ },
1036
+ {
1037
+ "disabled": false,
1038
+ "document": "套餐类型\n注意:此字段可能返回 null,表示取不到有效值。",
1039
+ "example": "CloudEnterprise",
1040
+ "member": "string",
1041
+ "name": "QuotaType",
1042
+ "output_required": false,
1043
+ "type": "string",
1044
+ "value_allowed_null": true
1045
+ },
1046
+ {
1047
+ "disabled": false,
1048
+ "document": "合同使用量\n注意:此字段可能返回 null,表示取不到有效值。",
1049
+ "example": "1",
1050
+ "member": "int64",
1051
+ "name": "UseCount",
1052
+ "output_required": false,
1053
+ "type": "int",
1054
+ "value_allowed_null": true
1055
+ },
1056
+ {
1057
+ "disabled": false,
1058
+ "document": "消耗的时间戳\n注意:此字段可能返回 null,表示取不到有效值。",
1059
+ "example": "1680162193",
1060
+ "member": "int64",
1061
+ "name": "CostTime",
1062
+ "output_required": false,
1063
+ "type": "int",
1064
+ "value_allowed_null": true
1065
+ },
1066
+ {
1067
+ "disabled": false,
1068
+ "document": "套餐名称\n注意:此字段可能返回 null,表示取不到有效值。",
1069
+ "example": "企业版运营礼包",
1070
+ "member": "string",
1071
+ "name": "QuotaName",
1072
+ "output_required": false,
1073
+ "type": "string",
1074
+ "value_allowed_null": true
1075
+ },
1076
+ {
1077
+ "disabled": false,
1078
+ "document": " 消耗类型\t1.扣费 2.撤销返还\n注意:此字段可能返回 null,表示取不到有效值。",
1079
+ "example": "1",
1080
+ "member": "int64",
1081
+ "name": "CostType",
1082
+ "output_required": false,
1083
+ "type": "int",
1084
+ "value_allowed_null": true
1085
+ },
1086
+ {
1087
+ "disabled": false,
1088
+ "document": "备注\n注意:此字段可能返回 null,表示取不到有效值。",
1089
+ "example": "空",
1090
+ "member": "string",
1091
+ "name": "Remark",
1092
+ "output_required": false,
1093
+ "type": "string",
1094
+ "value_allowed_null": true
1095
+ }
1096
+ ],
1097
+ "usage": "out"
1098
+ },
976
1099
  "BindEmployeeUserIdWithClientOpenIdRequest": {
977
1100
  "document": "BindEmployeeUserIdWithClientOpenId请求参数结构体",
978
1101
  "members": [
@@ -4240,6 +4363,16 @@
4240
4363
  "type": "string",
4241
4364
  "value_allowed_null": false
4242
4365
  },
4366
+ {
4367
+ "disabled": false,
4368
+ "document": "创建的合同id(还未实际发起),每次调用会生成新的id,用户可以记录此字段对应后续页面发起的合同,若在页面上未成功发起,则此字段无效。",
4369
+ "example": "无",
4370
+ "member": "string",
4371
+ "name": "FlowId",
4372
+ "output_required": false,
4373
+ "type": "string",
4374
+ "value_allowed_null": false
4375
+ },
4243
4376
  {
4244
4377
  "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
4245
4378
  "member": "string",
@@ -4772,7 +4905,7 @@
4772
4905
  },
4773
4906
  {
4774
4907
  "disabled": false,
4775
- "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: (默认)公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 合财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n</ul>\n注: `同企业下只能有一个公章, 重复创建会报错`",
4908
+ "document": "电子印章类型 , 可选类型如下: \n<ul><li>**OFFICIAL**: (默认)公章</li>\n<li>**CONTRACT**: 合同专用章;</li>\n<li>**FINANCE**: 财务专用章;</li>\n<li>**PERSONNEL**: 人事专用章</li>\n</ul>\n注: `同企业下只能有一个公章, 重复创建会报错`",
4776
4909
  "example": "OFFICIAL",
4777
4910
  "member": "string",
4778
4911
  "name": "SealType",
@@ -5590,6 +5723,98 @@
5590
5723
  ],
5591
5724
  "usage": "both"
5592
5725
  },
5726
+ "DescribeBillUsageDetailRequest": {
5727
+ "document": "DescribeBillUsageDetail请求参数结构体",
5728
+ "members": [
5729
+ {
5730
+ "disabled": false,
5731
+ "document": "查询开始时间,时间跨度不能大于31天",
5732
+ "example": "20230101",
5733
+ "member": "string",
5734
+ "name": "StartTime",
5735
+ "required": true,
5736
+ "type": "string"
5737
+ },
5738
+ {
5739
+ "disabled": false,
5740
+ "document": "查询结束时间,时间跨度不能大于31天",
5741
+ "example": "20230105",
5742
+ "member": "string",
5743
+ "name": "EndTime",
5744
+ "required": true,
5745
+ "type": "string"
5746
+ },
5747
+ {
5748
+ "disabled": false,
5749
+ "document": "指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0",
5750
+ "example": "0",
5751
+ "member": "int64",
5752
+ "name": "Offset",
5753
+ "required": true,
5754
+ "type": "int"
5755
+ },
5756
+ {
5757
+ "disabled": false,
5758
+ "document": "指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。",
5759
+ "example": "50",
5760
+ "member": "int64",
5761
+ "name": "Limit",
5762
+ "required": false,
5763
+ "type": "int"
5764
+ },
5765
+ {
5766
+ "disabled": false,
5767
+ "document": "查询的套餐类型 (选填 )不传则查询所有套餐;\n对应关系如下\nCloudEnterprise-企业版合同\nSingleSignature-单方签章\nCloudProve-签署报告\nCloudOnlineSign-腾讯会议在线签约\nChannelWeCard-微工卡\nSignFlow-合同套餐\nSignFace-签署意愿(人脸识别)\nSignPassword-签署意愿(密码)\nSignSMS-签署意愿(短信)\nPersonalEssAuth-签署人实名(腾讯电子签认证)\nPersonalThirdAuth-签署人实名(信任第三方认证)\nOrgEssAuth-签署企业实名\nFlowNotify-短信通知\nAuthService-企业工商信息查询",
5768
+ "example": "CloudEnterprise",
5769
+ "member": "string",
5770
+ "name": "QuotaType",
5771
+ "required": false,
5772
+ "type": "string"
5773
+ },
5774
+ {
5775
+ "disabled": false,
5776
+ "document": "非必填,查询某个渠道企业的消耗情况。\n关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。",
5777
+ "example": "无",
5778
+ "member": "Agent",
5779
+ "name": "Agent",
5780
+ "required": false,
5781
+ "type": "object"
5782
+ }
5783
+ ],
5784
+ "type": "object"
5785
+ },
5786
+ "DescribeBillUsageDetailResponse": {
5787
+ "document": "DescribeBillUsageDetail返回参数结构体",
5788
+ "members": [
5789
+ {
5790
+ "disabled": false,
5791
+ "document": "总数",
5792
+ "example": "125",
5793
+ "member": "int64",
5794
+ "name": "Total",
5795
+ "output_required": false,
5796
+ "type": "int",
5797
+ "value_allowed_null": false
5798
+ },
5799
+ {
5800
+ "disabled": false,
5801
+ "document": "消耗详情",
5802
+ "example": "无",
5803
+ "member": "BillUsageDetail",
5804
+ "name": "Details",
5805
+ "output_required": false,
5806
+ "type": "list",
5807
+ "value_allowed_null": false
5808
+ },
5809
+ {
5810
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
5811
+ "member": "string",
5812
+ "name": "RequestId",
5813
+ "type": "string"
5814
+ }
5815
+ ],
5816
+ "type": "object"
5817
+ },
5593
5818
  "DescribeExtendedServiceAuthInfosRequest": {
5594
5819
  "document": "DescribeExtendedServiceAuthInfos请求参数结构体",
5595
5820
  "members": [
@@ -6283,7 +6508,7 @@
6283
6508
  },
6284
6509
  {
6285
6510
  "disabled": false,
6286
- "document": "查询的关键字段,支持Key-Values查询。可选键值如下:\n<ul>\n <li>Key:**\"Status\"**,根据实名状态查询员工,Values可选:\n <ul><li>**[\"IsVerified\"]**:查询已实名的员工</li><li>**[\"NotVerified\"]**:查询未实名的员工</li></ul></li>\n <li>Key:**\"DepartmentId\"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**[\"DepartmentId\"]**</li>\n <li>Key:**\"UserId\"**,根据用户ID查询员工,Values为指定的用户ID:**[\"UserId\"]**</li>\n <li>Key:**\"UserWeWorkOpenId\"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**[\"UserWeWorkOpenId\"]**</li>\n <li>Key:**\"StaffOpenId\"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**[\"OpenId1\",\"OpenId2\",...]**</li>\n</ul>",
6511
+ "document": "查询的关键字段,支持Key-Values查询。可选键值如下:\n<ul>\n <li>Key:**\"Status\"**,根据实名状态查询员工,Values可选:\n <ul><li>**[\"IsVerified\"]**:查询已实名的员工</li><li>**[\"NotVerified\"]**:查询未实名的员工</li></ul></li>\n <li>Key:**\"DepartmentId\"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**[\"DepartmentId\"]**</li>\n <li>Key:**\"UserId\"**,根据用户ID查询员工,Values为指定的用户ID:**[\"UserId\"]**</li>\n <li>Key:**\"UserWeWorkOpenId\"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**[\"UserWeWorkOpenId\"]**</li>\n <li>Key:**\"StaffOpenId\"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**[\"OpenId1\",\"OpenId2\",...]**</li>\n <li>Key:**\"RoleId\"**,根据电子签角色ID查询员工,Values为指定的角色ID,满足其中任意一个角色即可:**[\"RoleId1\",\"RoleId2\",...]**</li>\n</ul>",
6287
6512
  "example": "无",
6288
6513
  "member": "Filter",
6289
6514
  "name": "Filters",
@@ -912,6 +912,26 @@
912
912
  "title": "撤销印章授权"
913
913
  }
914
914
  ],
915
+ "DescribeBillUsageDetail": [
916
+ {
917
+ "document": "",
918
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBillUsageDetail\n<公共请求参数>\n\n{\n \"StartTime\": \"20230902\",\n \"EndTime\": \"20230930\",\n \"Offset\": 0,\n \"Limit\": 50\n}",
919
+ "output": "{\n \"Response\": {\n \"Details\": [\n {\n \"CostTime\": 1695037514,\n \"CostType\": 1,\n \"FlowId\": \"yDwJOU5e7ikveIUxMW0p2uJxxxxxxxxxx\",\n \"FlowName\": \"腾讯电子签xxxxx合同\",\n \"OperatorName\": \"张三;李斯\",\n \"QuotaName\": \"签署报告(出证服务)\",\n \"QuotaType\": \"CloudProve\",\n \"Remark\": \"\",\n \"Status\": 4,\n \"UseCount\": 1\n }\n ],\n \"RequestId\": \"s16992572741898xxxx\",\n \"Total\": 1\n }\n}",
920
+ "title": "查询全部消耗途径"
921
+ },
922
+ {
923
+ "document": "",
924
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBillUsageDetail\n<公共请求参数>\n\n{\n \"StartTime\": \"20230902\",\n \"EndTime\": \"20230930\",\n \"Offset\": 0,\n \"Limit\": 1000\n}",
925
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.Limit\",\n \"Message\": \"分页参数不合法\"\n },\n \"RequestId\": \"s169935778xxxxxxx\"\n }\n}",
926
+ "title": "查询失败样例"
927
+ },
928
+ {
929
+ "document": "",
930
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBillUsageDetail\n<公共请求参数>\n\n{\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"Offset\": 0,\n \"Limit\": 0,\n \"QuotaType\": \"abc\",\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\",\n \"ProxyOperator\": \"abc\"\n }\n}",
931
+ "output": "{\n \"Response\": {\n \"Details\": [\n {\n \"CostTime\": 1695037514,\n \"CostType\": 1,\n \"FlowId\": \"yDwJOU5e7ikveIUxMW0p2uJxxxxxxxxxx\",\n \"FlowName\": \"腾讯电子签xxxxx合同\",\n \"OperatorName\": \"张三;李斯\",\n \"QuotaName\": \"签署报告(出证服务)\",\n \"QuotaType\": \"CloudProve\",\n \"Remark\": \"\",\n \"Status\": 4,\n \"UseCount\": 1\n }\n ],\n \"RequestId\": \"s16992572741898xxxx\",\n \"Total\": 1\n }\n}",
932
+ "title": "查询渠道客户消耗"
933
+ }
934
+ ],
915
935
  "DescribeExtendedServiceAuthInfos": [
916
936
  {
917
937
  "document": "传入了不支持的特定扩展服务,返回错误",