tccli 3.0.1095.1__py2.py3-none-any.whl → 3.0.1097.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/aiart/v20221229/QueryDrawPortraitJob.md +30 -0
  3. tccli/examples/aiart/v20221229/QueryTrainPortraitModelJob.md +24 -0
  4. tccli/examples/aiart/v20221229/SubmitDrawPortraitJob.md +23 -0
  5. tccli/examples/aiart/v20221229/SubmitTrainPortraitModelJob.md +20 -0
  6. tccli/examples/aiart/v20221229/UploadTrainPortraitImages.md +25 -0
  7. tccli/examples/ccc/v20200210/ModifyStaffPassword.md +22 -0
  8. tccli/examples/cls/v20201016/DeleteKafkaRecharge.md +3 -3
  9. tccli/examples/cls/v20201016/ModifyKafkaRecharge.md +23 -13
  10. tccli/examples/cls/v20201016/PreviewKafkaRecharge.md +47 -15
  11. tccli/examples/csip/v20221121/DescribeAlertList.md +176 -0
  12. tccli/examples/cynosdb/v20190107/AddClusterSlaveZone.md +2 -1
  13. tccli/examples/cynosdb/v20190107/DescribeClusterDetail.md +9 -2
  14. tccli/examples/cynosdb/v20190107/DescribeTasks.md +12 -0
  15. tccli/examples/cynosdb/v20190107/ModifyClusterSlaveZone.md +2 -1
  16. tccli/examples/cynosdb/v20190107/ModifyInstanceUpgradeLimitDays.md +22 -0
  17. tccli/examples/dcdb/v20180411/DescribeDCDBInstances.md +4 -3
  18. tccli/examples/dlc/v20210125/DescribeNotebookSessionStatementSqlResult.md +3 -1
  19. tccli/examples/lke/v20231130/GetEmbedding.md +4 -1
  20. tccli/examples/lke/v20231130/QueryParseDocResult.md +4 -1
  21. tccli/examples/lke/v20231130/QueryRewrite.md +6 -1
  22. tccli/examples/mariadb/v20170312/DescribeDBInstanceDetail.md +2 -1
  23. tccli/examples/mariadb/v20170312/DescribeDBInstances.md +4 -3
  24. tccli/examples/mps/v20190612/CreateAdaptiveDynamicStreamingTemplate.md +1 -1
  25. tccli/examples/mps/v20190612/ModifyAdaptiveDynamicStreamingTemplate.md +1 -1
  26. tccli/examples/organization/v20210331/DescribeEffectivePolicy.md +25 -0
  27. tccli/examples/organization/v20210331/ListNonCompliantResource.md +43 -0
  28. tccli/examples/ssl/v20191205/DescribeDeleteCertificatesTaskResult.md +72 -0
  29. tccli/examples/tdmq/v20200217/DescribeRabbitMQQueueDetail.md +25 -22
  30. tccli/examples/trocket/v20230308/DescribeMQTTClient.md +57 -49
  31. tccli/examples/trocket/v20230308/DescribeMQTTInsPublicEndpoints.md +38 -6
  32. tccli/examples/trocket/v20230308/DescribeMQTTInsVPCEndpoints.md +14 -12
  33. tccli/examples/trocket/v20230308/DescribeMQTTInstanceList.md +1 -121
  34. tccli/examples/trocket/v20230308/DescribeMQTTProductSKUList.md +0 -47
  35. tccli/examples/trocket/v20230308/DescribeMQTTUserList.md +1 -1
  36. tccli/examples/vpc/v20170312/DisableVpnGatewaySslClientCert.md +2 -2
  37. tccli/services/aiart/aiart_client.py +269 -4
  38. tccli/services/aiart/v20221229/api.json +405 -1
  39. tccli/services/aiart/v20221229/examples.json +40 -0
  40. tccli/services/billing/v20180709/api.json +30 -0
  41. tccli/services/bma/v20221115/api.json +4 -6
  42. tccli/services/ccc/ccc_client.py +53 -0
  43. tccli/services/ccc/v20200210/api.json +57 -5
  44. tccli/services/ccc/v20200210/examples.json +8 -0
  45. tccli/services/cdb/v20170320/api.json +9 -0
  46. tccli/services/cdn/v20180606/api.json +1 -1
  47. tccli/services/cls/v20201016/api.json +49 -49
  48. tccli/services/cls/v20201016/examples.json +13 -7
  49. tccli/services/csip/csip_client.py +53 -0
  50. tccli/services/csip/v20221121/api.json +1468 -7
  51. tccli/services/csip/v20221121/examples.json +8 -0
  52. tccli/services/cynosdb/cynosdb_client.py +53 -0
  53. tccli/services/cynosdb/v20190107/api.json +126 -0
  54. tccli/services/cynosdb/v20190107/examples.json +12 -4
  55. tccli/services/dcdb/v20180411/api.json +45 -3
  56. tccli/services/dcdb/v20180411/examples.json +1 -1
  57. tccli/services/dlc/v20210125/api.json +30 -0
  58. tccli/services/dlc/v20210125/examples.json +1 -1
  59. tccli/services/essbasic/v20210526/api.json +9 -0
  60. tccli/services/faceid/v20180301/api.json +22 -3
  61. tccli/services/hunyuan/v20230901/api.json +14 -14
  62. tccli/services/iotexplorer/v20190423/api.json +1 -1
  63. tccli/services/lighthouse/v20200324/api.json +2 -2
  64. tccli/services/live/v20180801/api.json +16 -7
  65. tccli/services/lke/v20231130/api.json +82 -6
  66. tccli/services/lke/v20231130/examples.json +3 -3
  67. tccli/services/mariadb/v20170312/api.json +45 -2
  68. tccli/services/mariadb/v20170312/examples.json +2 -2
  69. tccli/services/mps/v20190612/api.json +172 -92
  70. tccli/services/mps/v20190612/examples.json +2 -2
  71. tccli/services/ocr/v20181119/api.json +1 -1
  72. tccli/services/omics/v20221128/api.json +20 -2
  73. tccli/services/organization/organization_client.py +106 -0
  74. tccli/services/organization/v20210331/api.json +258 -0
  75. tccli/services/organization/v20210331/examples.json +16 -0
  76. tccli/services/ssl/ssl_client.py +53 -0
  77. tccli/services/ssl/v20191205/api.json +160 -9
  78. tccli/services/ssl/v20191205/examples.json +8 -0
  79. tccli/services/ssm/v20190923/api.json +1 -1
  80. tccli/services/tdmq/v20200217/api.json +65 -26
  81. tccli/services/tdmq/v20200217/examples.json +2 -2
  82. tccli/services/trocket/v20230308/api.json +226 -108
  83. tccli/services/trocket/v20230308/examples.json +13 -25
  84. tccli/services/trtc/v20190722/api.json +34 -15
  85. tccli/services/vpc/v20170312/api.json +20 -5
  86. tccli/services/vpc/v20170312/examples.json +2 -2
  87. tccli/services/weilingwith/v20230427/api.json +11 -11
  88. {tccli-3.0.1095.1.dist-info → tccli-3.0.1097.1.dist-info}/METADATA +2 -2
  89. {tccli-3.0.1095.1.dist-info → tccli-3.0.1097.1.dist-info}/RECORD +92 -81
  90. {tccli-3.0.1095.1.dist-info → tccli-3.0.1097.1.dist-info}/WHEEL +0 -0
  91. {tccli-3.0.1095.1.dist-info → tccli-3.0.1097.1.dist-info}/entry_points.txt +0 -0
  92. {tccli-3.0.1095.1.dist-info → tccli-3.0.1097.1.dist-info}/license_files/LICENSE +0 -0
@@ -1889,6 +1889,58 @@ def doUnbindStaffSkillGroupList(args, parsed_globals):
1889
1889
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1890
1890
 
1891
1891
 
1892
+ def doModifyStaffPassword(args, parsed_globals):
1893
+ g_param = parse_global_arg(parsed_globals)
1894
+
1895
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
1896
+ cred = credential.CVMRoleCredential()
1897
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
1898
+ cred = credential.STSAssumeRoleCredential(
1899
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
1900
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
1901
+ )
1902
+ 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):
1903
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
1904
+ else:
1905
+ cred = credential.Credential(
1906
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
1907
+ )
1908
+ http_profile = HttpProfile(
1909
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
1910
+ reqMethod="POST",
1911
+ endpoint=g_param[OptionsDefine.Endpoint],
1912
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
1913
+ )
1914
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
1915
+ if g_param[OptionsDefine.Language]:
1916
+ profile.language = g_param[OptionsDefine.Language]
1917
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
1918
+ client = mod.CccClient(cred, g_param[OptionsDefine.Region], profile)
1919
+ client._sdkVersion += ("_CLI_" + __version__)
1920
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
1921
+ model = models.ModifyStaffPasswordRequest()
1922
+ model.from_json_string(json.dumps(args))
1923
+ start_time = time.time()
1924
+ while True:
1925
+ rsp = client.ModifyStaffPassword(model)
1926
+ result = rsp.to_json_string()
1927
+ try:
1928
+ json_obj = json.loads(result)
1929
+ except TypeError as e:
1930
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
1931
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
1932
+ break
1933
+ cur_time = time.time()
1934
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
1935
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
1936
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
1937
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
1938
+ else:
1939
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
1940
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
1941
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1942
+
1943
+
1892
1944
  def doDisableCCCPhoneNumber(args, parsed_globals):
1893
1945
  g_param = parse_global_arg(parsed_globals)
1894
1946
 
@@ -2976,6 +3028,7 @@ ACTION_MAP = {
2976
3028
  "DescribeCarrierPrivilegeNumberApplicants": doDescribeCarrierPrivilegeNumberApplicants,
2977
3029
  "CreateCCCSkillGroup": doCreateCCCSkillGroup,
2978
3030
  "UnbindStaffSkillGroupList": doUnbindStaffSkillGroupList,
3031
+ "ModifyStaffPassword": doModifyStaffPassword,
2979
3032
  "DisableCCCPhoneNumber": doDisableCCCPhoneNumber,
2980
3033
  "DescribeStaffStatusMetrics": doDescribeStaffStatusMetrics,
2981
3034
  "DescribeTelCallInfo": doDescribeTelCallInfo,
@@ -134,9 +134,9 @@
134
134
  "status": "online"
135
135
  },
136
136
  "DescribeAutoCalloutTasks": {
137
- "document": "批量查询自动任务外呼",
137
+ "document": "批量查询自动外呼任务",
138
138
  "input": "DescribeAutoCalloutTasksRequest",
139
- "name": "批量查询自动任务外呼",
139
+ "name": "批量查询自动外呼任务",
140
140
  "output": "DescribeAutoCalloutTasksResponse",
141
141
  "status": "online"
142
142
  },
@@ -164,7 +164,7 @@
164
164
  "DescribeChatMessages": {
165
165
  "document": "获取指定服务记录文本聊天内容,需要先使用查询在线客服记录(DescribeIMCdrs) API 获取服务记录 SessionId。\n\n文本聊天记录只保存了 1 年内的,1 年之前会自动清理。",
166
166
  "input": "DescribeChatMessagesRequest",
167
- "name": "查询服务的聊天记录",
167
+ "name": "查询指定会话(SessionId)的聊天记录",
168
168
  "output": "DescribeChatMessagesResponse",
169
169
  "status": "online"
170
170
  },
@@ -329,6 +329,13 @@
329
329
  "output": "ModifyStaffResponse",
330
330
  "status": "online"
331
331
  },
332
+ "ModifyStaffPassword": {
333
+ "document": "修改座席的密码",
334
+ "input": "ModifyStaffPasswordRequest",
335
+ "name": "修改座席密码",
336
+ "output": "ModifyStaffPasswordResponse",
337
+ "status": "online"
338
+ },
332
339
  "PausePredictiveDialingCampaign": {
333
340
  "document": "暂停预测式外呼任务",
334
341
  "input": "PausePredictiveDialingCampaignRequest",
@@ -2800,7 +2807,7 @@
2800
2807
  "type": "int"
2801
2808
  },
2802
2809
  {
2803
- "disabled": false,
2810
+ "disabled": true,
2804
2811
  "document": "服务记录ID(废弃)",
2805
2812
  "example": "13503",
2806
2813
  "member": "string",
@@ -2837,7 +2844,7 @@
2837
2844
  },
2838
2845
  {
2839
2846
  "disabled": false,
2840
- "document": "服务记录 SessionID(必填)",
2847
+ "document": "服务记录 SessionID",
2841
2848
  "example": "d6253538-7c28-477b-998a-919059801899",
2842
2849
  "member": "string",
2843
2850
  "name": "SessionId",
@@ -5182,6 +5189,51 @@
5182
5189
  ],
5183
5190
  "type": "object"
5184
5191
  },
5192
+ "ModifyStaffPasswordRequest": {
5193
+ "document": "ModifyStaffPassword请求参数结构体",
5194
+ "members": [
5195
+ {
5196
+ "disabled": false,
5197
+ "document": "应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc",
5198
+ "example": "16000000",
5199
+ "member": "uint64",
5200
+ "name": "SdkAppId",
5201
+ "required": true,
5202
+ "type": "int"
5203
+ },
5204
+ {
5205
+ "disabled": false,
5206
+ "document": "座席邮箱",
5207
+ "example": "a@qq.com",
5208
+ "member": "string",
5209
+ "name": "Email",
5210
+ "required": true,
5211
+ "type": "string"
5212
+ },
5213
+ {
5214
+ "disabled": false,
5215
+ "document": "设置的密码",
5216
+ "example": "abcdefg",
5217
+ "member": "string",
5218
+ "name": "Password",
5219
+ "required": true,
5220
+ "type": "string"
5221
+ }
5222
+ ],
5223
+ "type": "object"
5224
+ },
5225
+ "ModifyStaffPasswordResponse": {
5226
+ "document": "ModifyStaffPassword返回参数结构体",
5227
+ "members": [
5228
+ {
5229
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
5230
+ "member": "string",
5231
+ "name": "RequestId",
5232
+ "type": "string"
5233
+ }
5234
+ ],
5235
+ "type": "object"
5236
+ },
5185
5237
  "ModifyStaffRequest": {
5186
5238
  "document": "ModifyStaff请求参数结构体",
5187
5239
  "members": [
@@ -376,6 +376,14 @@
376
376
  "title": "修改客服示例"
377
377
  }
378
378
  ],
379
+ "ModifyStaffPassword": [
380
+ {
381
+ "document": "",
382
+ "input": "POST / HTTP/1.1\nHost: ccc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyStaffPassword\n<公共请求参数>\n\n{\n \"SdkAppId\": 1600000000,\n \"Email\": \"a@qq.com\",\n \"Password\": \"foobar\"\n}",
383
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
384
+ "title": "修改密码"
385
+ }
386
+ ],
379
387
  "PausePredictiveDialingCampaign": [
380
388
  {
381
389
  "document": "暂停预测式外呼任务",
@@ -4969,6 +4969,15 @@
4969
4969
  "name": "ConnectionPoolLimit",
4970
4970
  "required": false,
4971
4971
  "type": "int"
4972
+ },
4973
+ {
4974
+ "disabled": false,
4975
+ "document": "指定要购买的 proxy 内核版本。不填则默认发货最新版本的 proxy。",
4976
+ "example": "1.4.1",
4977
+ "member": "string",
4978
+ "name": "ProxyVersion",
4979
+ "required": false,
4980
+ "type": "string"
4972
4981
  }
4973
4982
  ],
4974
4983
  "type": "object"
@@ -463,7 +463,7 @@
463
463
  "status": "online"
464
464
  },
465
465
  "ModifyDomainConfig": {
466
- "document": "ModifyDomainConfig 用于修改内容分发网络加速域名配置信息\n注意:\nRoute 字段,使用点分隔,最后一段称为叶子节点,非叶子节点配置保持不变;\nValue 字段,使用 json 进行序列化,其中固定 update 作为 key,配置路径值参考 https://cloud.tencent.com/document/product/228/41116 接口各配置项复杂类型,为配置路径对应复杂类型下的节点。\n云审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到云审计。",
466
+ "document": "ModifyDomainConfig 用于修改内容分发网络加速域名配置信息\n注意:\nRoute 字段,使用点分隔,最后一段称为叶子节点,非叶子节点配置保持不变;\nValue 字段,使用 json 进行序列化,其中固定 update 作为 key,配置路径值参考 https://cloud.tencent.com/document/product/228/41116 接口各配置项复杂类型,为配置路径对应复杂类型下的节点。\n操作审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到操作审计。",
467
467
  "input": "ModifyDomainConfigRequest",
468
468
  "name": "变更加速域名配置",
469
469
  "output": "ModifyDomainConfigResponse",
@@ -1695,7 +1695,7 @@
1695
1695
  "members": [
1696
1696
  {
1697
1697
  "disabled": false,
1698
- "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
1698
+ "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
1699
1699
  "example": "0",
1700
1700
  "member": "uint64",
1701
1701
  "name": "KafkaType",
@@ -1722,7 +1722,7 @@
1722
1722
  },
1723
1723
  {
1724
1724
  "disabled": false,
1725
- "document": "ServerAddr是否为加密连接",
1725
+ "document": "ServerAddr是否为加密连接,默认值false。当KafkaType为1用户自建kafka时生效。",
1726
1726
  "example": "true",
1727
1727
  "member": "bool",
1728
1728
  "name": "IsEncryptionAddr",
@@ -1731,7 +1731,7 @@
1731
1731
  },
1732
1732
  {
1733
1733
  "disabled": false,
1734
- "document": "加密访问协议。IsEncryptionAddr参数为true时必填",
1734
+ "document": "加密访问协议。KafkaType参数为1并且IsEncryptionAddr参数为true时必填。",
1735
1735
  "example": "无",
1736
1736
  "member": "KafkaProtocolInfo",
1737
1737
  "name": "Protocol",
@@ -4023,8 +4023,8 @@
4023
4023
  },
4024
4024
  {
4025
4025
  "disabled": false,
4026
- "document": "腾讯云CKafka实例ID,KafkaType为0时必填",
4027
- "example": "",
4026
+ "document": "腾讯云CKafka实例ID,KafkaType为0时必填。",
4027
+ "example": "ckafka-2vrgxbxa",
4028
4028
  "member": "string",
4029
4029
  "name": "KafkaInstance",
4030
4030
  "required": false,
@@ -4032,7 +4032,7 @@
4032
4032
  },
4033
4033
  {
4034
4034
  "disabled": false,
4035
- "document": "服务地址,KafkaType为1时必填",
4035
+ "document": "服务地址,KafkaType为1时必填。",
4036
4036
  "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095",
4037
4037
  "member": "string",
4038
4038
  "name": "ServerAddr",
@@ -4041,7 +4041,7 @@
4041
4041
  },
4042
4042
  {
4043
4043
  "disabled": false,
4044
- "document": "ServerAddr是否为加密连接,KafkaType为1时必填",
4044
+ "document": "ServerAddr是否为加密连接,KafkaType为1时必填。",
4045
4045
  "example": "true",
4046
4046
  "member": "bool",
4047
4047
  "name": "IsEncryptionAddr",
@@ -4050,7 +4050,7 @@
4050
4050
  },
4051
4051
  {
4052
4052
  "disabled": false,
4053
- "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填",
4053
+ "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填。",
4054
4054
  "example": "无",
4055
4055
  "member": "KafkaProtocolInfo",
4056
4056
  "name": "Protocol",
@@ -4075,7 +4075,7 @@
4075
4075
  {
4076
4076
  "disabled": false,
4077
4077
  "document": "Kafka导入配置ID",
4078
- "example": "xxx-xxx-xxx",
4078
+ "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111",
4079
4079
  "member": "string",
4080
4080
  "name": "Id",
4081
4081
  "output_required": true,
@@ -4413,8 +4413,8 @@
4413
4413
  },
4414
4414
  {
4415
4415
  "disabled": false,
4416
- "document": "创建的投递规则投递的bucket",
4417
- "example": "bucketName-appid",
4416
+ "document": "COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。",
4417
+ "example": "examplebucket-1250000000",
4418
4418
  "member": "string",
4419
4419
  "name": "Bucket",
4420
4420
  "required": true,
@@ -4422,8 +4422,8 @@
4422
4422
  },
4423
4423
  {
4424
4424
  "disabled": false,
4425
- "document": "创建的投递规则投递目录的前缀",
4426
- "example": "",
4425
+ "document": "投递规则投递的新的目录前缀。\n- 仅支持0-9A-Za-z-_/\n- 最大支持256个字符",
4426
+ "example": "var/xxx",
4427
4427
  "member": "string",
4428
4428
  "name": "Prefix",
4429
4429
  "required": true,
@@ -4441,7 +4441,7 @@
4441
4441
  {
4442
4442
  "disabled": false,
4443
4443
  "document": "投递的时间间隔,单位 秒,默认300,范围 300-900",
4444
- "example": "60",
4444
+ "example": "300",
4445
4445
  "member": "uint64",
4446
4446
  "name": "Interval",
4447
4447
  "required": false,
@@ -4503,8 +4503,8 @@
4503
4503
  },
4504
4504
  {
4505
4505
  "disabled": false,
4506
- "document": "投递数据范围的开始时间点,不能超出日志主题的生命周期起点。如果用户不填写,默认为用户新建投递任务的时间。",
4507
- "example": "0",
4506
+ "document": "投递数据范围的开始时间点(秒级时间戳),不能超出日志主题的生命周期起点。\n如果用户不填写,默认为用户新建投递任务的时间。",
4507
+ "example": "1713410880",
4508
4508
  "member": "int64",
4509
4509
  "name": "StartTime",
4510
4510
  "required": false,
@@ -4512,8 +4512,8 @@
4512
4512
  },
4513
4513
  {
4514
4514
  "disabled": false,
4515
- "document": "投递数据范围的结束时间点,不能填写未来时间。如果用户不填写,默认为持续投递,即无限。",
4516
- "example": "0",
4515
+ "document": "投递数据范围的结束时间点(秒级时间戳),不能填写未来时间。\n如果用户不填写,默认为持续投递,即无限。",
4516
+ "example": "1713497280",
4517
4517
  "member": "int64",
4518
4518
  "name": "EndTime",
4519
4519
  "required": false,
@@ -4521,7 +4521,7 @@
4521
4521
  },
4522
4522
  {
4523
4523
  "disabled": false,
4524
- "document": "cos桶存储类型",
4524
+ "document": "cos桶存储类型。支持:STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。\n\n1. STANDARD_IA:低频存储;\n2. ARCHIVE:归档存储;\n3. DEEP_ARCHIVE:深度归档存储;\n4. STANDARD:标准存储;\n5. MAZ_STANDARD:标准存储(多 AZ);\n6. MAZ_STANDARD_IA:低频存储(多 AZ);\n7. INTELLIGENT_TIERING:智能分层存储。",
4525
4525
  "example": "STANDARD",
4526
4526
  "member": "string",
4527
4527
  "name": "StorageType",
@@ -5334,7 +5334,7 @@
5334
5334
  {
5335
5335
  "disabled": false,
5336
5336
  "document": "Kafka导入配置ID",
5337
- "example": "",
5337
+ "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0895",
5338
5338
  "member": "string",
5339
5339
  "name": "Id",
5340
5340
  "required": true,
@@ -5343,7 +5343,7 @@
5343
5343
  {
5344
5344
  "disabled": false,
5345
5345
  "document": "导入CLS目标topic ID",
5346
- "example": "",
5346
+ "example": "1014cc79-f006-48e4-8820-1dc727054111",
5347
5347
  "member": "string",
5348
5348
  "name": "TopicId",
5349
5349
  "required": true,
@@ -10334,7 +10334,7 @@
10334
10334
  {
10335
10335
  "disabled": false,
10336
10336
  "document": "Kafka导入配置ID",
10337
- "example": "",
10337
+ "example": "1014cc79-f006-48e4-8820-1dc7270540c0",
10338
10338
  "member": "string",
10339
10339
  "name": "Id",
10340
10340
  "required": true,
@@ -10343,7 +10343,7 @@
10343
10343
  {
10344
10344
  "disabled": false,
10345
10345
  "document": "导入CLS目标topic ID",
10346
- "example": "",
10346
+ "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111",
10347
10347
  "member": "string",
10348
10348
  "name": "TopicId",
10349
10349
  "required": true,
@@ -10360,7 +10360,7 @@
10360
10360
  },
10361
10361
  {
10362
10362
  "disabled": false,
10363
- "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
10363
+ "document": "导入Kafka类型,0:腾讯云CKafka1:用户自建Kafka",
10364
10364
  "example": "0",
10365
10365
  "member": "uint64",
10366
10366
  "name": "KafkaType",
@@ -10369,8 +10369,8 @@
10369
10369
  },
10370
10370
  {
10371
10371
  "disabled": false,
10372
- "document": "腾讯云CKafka实例ID,KafkaType为0时必填",
10373
- "example": "",
10372
+ "document": "腾讯云CKafka实例ID,KafkaType为0时必填。",
10373
+ "example": "ckafka-2vrgxbxa",
10374
10374
  "member": "string",
10375
10375
  "name": "KafkaInstance",
10376
10376
  "required": false,
@@ -10378,7 +10378,7 @@
10378
10378
  },
10379
10379
  {
10380
10380
  "disabled": false,
10381
- "document": "服务地址",
10381
+ "document": "服务地址,KafkaType为1时必填。",
10382
10382
  "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095",
10383
10383
  "member": "string",
10384
10384
  "name": "ServerAddr",
@@ -10387,7 +10387,7 @@
10387
10387
  },
10388
10388
  {
10389
10389
  "disabled": false,
10390
- "document": "ServerAddr是否为加密连接",
10390
+ "document": "ServerAddr是否为加密连接,KafkaType为1时必填。",
10391
10391
  "example": "true",
10392
10392
  "member": "bool",
10393
10393
  "name": "IsEncryptionAddr",
@@ -10396,7 +10396,7 @@
10396
10396
  },
10397
10397
  {
10398
10398
  "disabled": false,
10399
- "document": "加密访问协议,IsEncryptionAddr参数为true时必填",
10399
+ "document": "加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。",
10400
10400
  "example": "无",
10401
10401
  "member": "KafkaProtocolInfo",
10402
10402
  "name": "Protocol",
@@ -10406,7 +10406,7 @@
10406
10406
  {
10407
10407
  "disabled": false,
10408
10408
  "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开",
10409
- "example": "topic1,topic2",
10409
+ "example": "topic-subs-0px4qkvu32-cdb-5zi7jf11",
10410
10410
  "member": "string",
10411
10411
  "name": "UserKafkaTopics",
10412
10412
  "required": false,
@@ -10432,8 +10432,8 @@
10432
10432
  },
10433
10433
  {
10434
10434
  "disabled": false,
10435
- "document": "导入控制,1:暂停,2:继续",
10436
- "example": "",
10435
+ "document": "导入控制,1:暂停;2:继续。",
10436
+ "example": "1",
10437
10437
  "member": "uint64",
10438
10438
  "name": "StatusControl",
10439
10439
  "required": false,
@@ -10738,8 +10738,8 @@
10738
10738
  },
10739
10739
  {
10740
10740
  "disabled": false,
10741
- "document": "投递规则投递的新的bucket",
10742
- "example": "bucketName-appid",
10741
+ "document": "COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。",
10742
+ "example": "examplebucket-1250000000",
10743
10743
  "member": "string",
10744
10744
  "name": "Bucket",
10745
10745
  "required": false,
@@ -10747,8 +10747,8 @@
10747
10747
  },
10748
10748
  {
10749
10749
  "disabled": false,
10750
- "document": "投递规则投递的新的目录前缀",
10751
- "example": "",
10750
+ "document": "投递规则投递的新的目录前缀。\n- 仅支持0-9A-Za-z-_/\n- 最大支持256个字符",
10751
+ "example": "var/xxx",
10752
10752
  "member": "string",
10753
10753
  "name": "Prefix",
10754
10754
  "required": false,
@@ -10756,7 +10756,7 @@
10756
10756
  },
10757
10757
  {
10758
10758
  "disabled": false,
10759
- "document": "投递规则的开关状态",
10759
+ "document": "投递规则的开关状态。true:开启投递任务;false:关闭投递任务。",
10760
10760
  "example": "true",
10761
10761
  "member": "bool",
10762
10762
  "name": "Status",
@@ -10828,7 +10828,7 @@
10828
10828
  },
10829
10829
  {
10830
10830
  "disabled": false,
10831
- "document": "投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名)",
10831
+ "document": "投递文件命名配置,0:随机数命名,1:投递时间命名。",
10832
10832
  "example": "0",
10833
10833
  "member": "uint64",
10834
10834
  "name": "FilenameMode",
@@ -10837,7 +10837,7 @@
10837
10837
  },
10838
10838
  {
10839
10839
  "disabled": false,
10840
- "document": "cos桶类型",
10840
+ "document": "cos桶存储类型。支持:STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。\n\n1. STANDARD_IA:低频存储;\n2. ARCHIVE:归档存储;\n3. DEEP_ARCHIVE:深度归档存储;\n4. STANDARD:标准存储;\n5. MAZ_STANDARD:标准存储(多 AZ);\n6. MAZ_STANDARD_IA:低频存储(多 AZ);\n7. INTELLIGENT_TIERING:智能分层存储。",
10841
10841
  "example": "STANDARD",
10842
10842
  "member": "string",
10843
10843
  "name": "StorageType",
@@ -11336,7 +11336,7 @@
11336
11336
  "members": [
11337
11337
  {
11338
11338
  "disabled": false,
11339
- "document": "预览类型,1:源数据预览,2:导出结果预览",
11339
+ "document": "预览类型,1:源数据预览;2:导出结果预览。",
11340
11340
  "example": "1",
11341
11341
  "member": "uint64",
11342
11342
  "name": "PreviewType",
@@ -11345,8 +11345,8 @@
11345
11345
  },
11346
11346
  {
11347
11347
  "disabled": false,
11348
- "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
11349
- "example": "",
11348
+ "document": "导入Kafka类型,0:腾讯云CKafka1:用户自建Kafka",
11349
+ "example": "1",
11350
11350
  "member": "uint64",
11351
11351
  "name": "KafkaType",
11352
11352
  "required": true,
@@ -11354,8 +11354,8 @@
11354
11354
  },
11355
11355
  {
11356
11356
  "disabled": false,
11357
- "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。最多支持100个。",
11358
- "example": "topic1,topic2",
11357
+ "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。\n最多支持100个。",
11358
+ "example": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111",
11359
11359
  "member": "string",
11360
11360
  "name": "UserKafkaTopics",
11361
11361
  "required": true,
@@ -11363,7 +11363,7 @@
11363
11363
  },
11364
11364
  {
11365
11365
  "disabled": false,
11366
- "document": "导入数据位置,-2:最早(默认),-1:最晚",
11366
+ "document": "导入数据位置,-2:最早;-1:最晚。",
11367
11367
  "example": "-1",
11368
11368
  "member": "int64",
11369
11369
  "name": "Offset",
@@ -11372,8 +11372,8 @@
11372
11372
  },
11373
11373
  {
11374
11374
  "disabled": false,
11375
- "document": "腾讯云CKafka实例ID。\nKafkaType为0KafkaInstance必填",
11376
- "example": "",
11375
+ "document": "腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。",
11376
+ "example": "ckafka-k9m5vj11",
11377
11377
  "member": "string",
11378
11378
  "name": "KafkaInstance",
11379
11379
  "required": false,
@@ -11381,7 +11381,7 @@
11381
11381
  },
11382
11382
  {
11383
11383
  "disabled": false,
11384
- "document": "服务地址。\nKafkaType为1时ServerAddr必填",
11384
+ "document": "服务地址。\nKafkaType为1时ServerAddr必填。",
11385
11385
  "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095",
11386
11386
  "member": "string",
11387
11387
  "name": "ServerAddr",
@@ -11399,7 +11399,7 @@
11399
11399
  },
11400
11400
  {
11401
11401
  "disabled": false,
11402
- "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填",
11402
+ "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填。",
11403
11403
  "example": "无",
11404
11404
  "member": "KafkaProtocolInfo",
11405
11405
  "name": "Protocol",
@@ -277,8 +277,8 @@
277
277
  "DeleteKafkaRecharge": [
278
278
  {
279
279
  "document": "删除Kafka导入配置",
280
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"abc\",\n \"TopicId\": \"abc\"\n}",
281
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
280
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"06bdb6f6-ae6e-41f6-9e7b-fcab91cb0895\",\n \"TopicId\": \"1014cc79-f006-48e4-8820-1dc727054111\"\n}",
281
+ "output": "{\n \"Response\": {\n \"RequestId\": \"00a1e648-bea8-4f85-8a7c-71f84169f207\"\n }\n}",
282
282
  "title": "删除Kafka导入配置"
283
283
  }
284
284
  ],
@@ -649,8 +649,8 @@
649
649
  "ModifyKafkaRecharge": [
650
650
  {
651
651
  "document": "修改Kafka导入配置",
652
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"xxx-xxx-xx\",\n \"TopicId\": \"abc\",\n \"Name\": \"abc\",\n \"ServerAddr\": \"abc\",\n \"IsEncryptionAddr\": true,\n \"UserKafkaTopics\": \"abc\",\n \"ConsumerGroupName\": \"abc\",\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"DefaultTimeSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0\n }\n}",
653
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
652
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"1014cc79-f006-48e4-8820-1dc7270540c0\",\n \"TopicId\": \"06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111\",\n \"KafkaType\": 0,\n \"KafkaInstance\": \"ckafka-2vrgxbxa\",\n \"ServerAddr\": \"\",\n \"IsEncryptionAddr\": false,\n \"Protocol\": {\n \"Protocol\": \"\",\n \"Mechanism\": \"\",\n \"UserName\": \"\",\n \"Password\": \"\"\n },\n \"UserKafkaTopics\": \"topic-subs-0px4qkvu32-cdb-5zi7jf11\",\n \"ConsumerGroupName\": \"\",\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"LogRegex\": \"\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"LogParseFailure\",\n \"UnMatchLogTimeSrc\": 0,\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true,\n \"DefaultTimeSrc\": 1,\n \"TimeKey\": \"\",\n \"TimeRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeZone\": \"UTC+08:00\",\n \"Metadata\": [\n \"kafka_topic\",\n \"kafka_partition\",\n \"kafka_offset\",\n \"kafka_timestamp\"\n ],\n \"Keys\": []\n }\n}",
653
+ "output": "{\n \"Response\": {\n \"RequestId\": \"0813f2a8-666f-47d4-886b-bf63bdcbc8d3\"\n }\n}",
654
654
  "title": "修改Kafka导入配置"
655
655
  }
656
656
  ],
@@ -704,10 +704,16 @@
704
704
  ],
705
705
  "PreviewKafkaRecharge": [
706
706
  {
707
- "document": "Kafka导入数据预览",
708
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCosRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 1,\n \"KafkaType\": 1,\n \"ServerAddr\": \"test.cls.tencentyun.com:9095\",\n \"IsEncryptionAddr\": false,\n \"UserKafkaTopics\": \"topic1,topic2\",\n \"Offset\": -1,\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true\n }\n}",
709
- "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"LogData\": \"xxxxxxx\",\n \"LogSample\": \"abc\"\n }\n}",
707
+ "document": "源数据预览",
708
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PreviewKafkaRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 1,\n \"KafkaType\": 0,\n \"KafkaInstance\": \"ckafka-k9m5vj75\",\n \"UserKafkaTopics\": \"topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111\",\n \"ConsumerGroupName\": \"\",\n \"Offset\": -1\n}",
709
+ "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"LogData\": \"rmap[AvailIndexTraffic:0 AvailStore:0 ClusterAvailableTrafficCapacity:0...\",\n \"LogSample\": \"\"\n }\n}",
710
710
  "title": "Kafka导入数据预览"
711
+ },
712
+ {
713
+ "document": "导出结果预览",
714
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PreviewKafkaRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 2,\n \"KafkaType\": 0,\n \"KafkaInstance\": \"ckafka-l4rped7z\",\n \"UserKafkaTopics\": \"topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111\",\n \"ConsumerGroupName\": \"\",\n \"Offset\": -2,\n \"LogRechargeRule\": {\n \"RechargeType\": \"minimalist_log\",\n \"LogRegex\": \"\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"LogParseFailure\",\n \"UnMatchLogTimeSrc\": 0,\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true,\n \"DefaultTimeSrc\": 0,\n \"TimeKey\": \"\",\n \"TimeRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeZone\": \"UTC+08:00\",\n \"Metadata\": [\n \"kafka_topic\",\n \"kafka_partition\",\n \"kafka_offset\",\n \"kafka_timestamp\"\n ],\n \"Keys\": []\n }\n}",
715
+ "output": "{\n \"Response\": {\n \"LogSample\": \"{\\\"x-intranet-proxy-region\\\":\\\"sh\\\",\\\"x-intranet-proxy-socket-local-address\\\":\\\"::ffff:11.179.111.111\\\",\\\"x-intranet-proxy-socket-local-port\\\":\\\"8443\\\"\",\n \"LogData\": \"{\\\"__CONTENT__\\\":\\\"{\\\\\\\"x-intranet-proxy-region\\\\\\\":\\\\\\\"sh\\\\\\\",\\\\\\\"x-intranet-proxy-socket-local-address\\\\\\\":\\\\\\\"::ffff:11.179.111.111\\\\\\\",\\\\\\\"x-intranet-proxy-socket-local-port\\\\\\\":\\\\\\\"8443\\\\\\\"\",\n \"RequestId\": \"d3218ba6-4d98-480a-a97b-8db0ae87ef31\"\n }\n}",
716
+ "title": "Kafaka导入数据预览"
711
717
  }
712
718
  ],
713
719
  "QueryMetric": [