tccli 3.0.1369.1__py2.py3-none-any.whl → 3.0.1371.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 (39) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/autoscaling/v20180419/api.json +4 -3
  3. tccli/services/cfs/cfs_client.py +61 -8
  4. tccli/services/cfs/v20190719/api.json +71 -0
  5. tccli/services/cfs/v20190719/examples.json +8 -0
  6. tccli/services/cls/v20201016/api.json +27 -27
  7. tccli/services/cls/v20201016/examples.json +4 -4
  8. tccli/services/ctem/v20231128/api.json +8 -8
  9. tccli/services/ctem/v20231128/examples.json +2 -2
  10. tccli/services/dcdb/v20180411/api.json +31 -2
  11. tccli/services/dcdb/v20180411/examples.json +1 -1
  12. tccli/services/dlc/v20210125/api.json +17 -7
  13. tccli/services/dsgc/v20190723/api.json +8 -8
  14. tccli/services/dsgc/v20190723/examples.json +1 -1
  15. tccli/services/es/v20180416/examples.json +3 -3
  16. tccli/services/ess/v20201111/api.json +30 -6
  17. tccli/services/ess/v20201111/examples.json +1 -1
  18. tccli/services/essbasic/v20210526/api.json +24 -0
  19. tccli/services/faceid/v20180301/api.json +42 -2
  20. tccli/services/faceid/v20180301/examples.json +2 -2
  21. tccli/services/lighthouse/v20200324/api.json +1 -1
  22. tccli/services/lke/v20231130/api.json +3 -3
  23. tccli/services/mariadb/v20170312/api.json +30 -1
  24. tccli/services/mariadb/v20170312/examples.json +1 -1
  25. tccli/services/mongodb/v20180408/api.json +1 -1
  26. tccli/services/mongodb/v20190725/api.json +1 -1
  27. tccli/services/organization/organization_client.py +53 -0
  28. tccli/services/organization/v20210331/api.json +175 -0
  29. tccli/services/organization/v20210331/examples.json +8 -0
  30. tccli/services/privatedns/v20201028/api.json +7 -7
  31. tccli/services/sqlserver/v20180328/api.json +11 -9
  32. tccli/services/tione/v20211111/api.json +1 -1
  33. tccli/services/trocket/v20230308/api.json +9 -0
  34. tccli/services/tsf/v20180326/api.json +6 -6
  35. {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/METADATA +2 -2
  36. {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/RECORD +39 -39
  37. {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/WHEEL +0 -0
  38. {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/entry_points.txt +0 -0
  39. {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/license_files/LICENSE +0 -0
tccli/__init__.py CHANGED
@@ -1 +1 @@
1
- __version__ = '3.0.1369.1'
1
+ __version__ = '3.0.1371.1'
@@ -6967,7 +6967,7 @@
6967
6967
  "members": [
6968
6968
  {
6969
6969
  "disabled": false,
6970
- "document": "伸缩组ID",
6970
+ "document": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID:\n<li>通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。</li>\n<li>通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。</li>",
6971
6971
  "example": "asg-12yqet78",
6972
6972
  "member": "string",
6973
6973
  "name": "AutoScalingGroupId",
@@ -6976,7 +6976,7 @@
6976
6976
  },
6977
6977
  {
6978
6978
  "disabled": false,
6979
- "document": "希望扩容的实例数量。",
6979
+ "document": "希望扩容的实例数量。该参数的静态取值范围是 [1,2000],同时该参数不得大于期望数与最大值的差值。例如伸缩组期望数为 20,最大值为 100,此时可取值范围为 [1,80]。",
6980
6980
  "example": "1",
6981
6981
  "member": "uint64",
6982
6982
  "name": "ScaleOutNumber",
@@ -6995,6 +6995,7 @@
6995
6995
  "example": "asa-n6w01f6m",
6996
6996
  "member": "string",
6997
6997
  "name": "ActivityId",
6998
+ "output_required": true,
6998
6999
  "type": "string",
6999
7000
  "value_allowed_null": false
7000
7001
  },
@@ -7511,7 +7512,7 @@
7511
7512
  "members": [
7512
7513
  {
7513
7514
  "disabled": false,
7514
- "document": "伸缩组ID。",
7515
+ "document": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。",
7515
7516
  "example": "asg-12yqet78",
7516
7517
  "member": "string",
7517
7518
  "name": "AutoScalingGroupId",
@@ -17,6 +17,58 @@ from tencentcloud.cfs.v20190719 import models as models_v20190719
17
17
  from jmespath import search
18
18
  import time
19
19
 
20
+ def doDoDirectoryOperation(args, parsed_globals):
21
+ g_param = parse_global_arg(parsed_globals)
22
+
23
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
24
+ cred = credential.CVMRoleCredential()
25
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
26
+ cred = credential.STSAssumeRoleCredential(
27
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
28
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
29
+ )
30
+ 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):
31
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
32
+ else:
33
+ cred = credential.Credential(
34
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
35
+ )
36
+ http_profile = HttpProfile(
37
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
38
+ reqMethod="POST",
39
+ endpoint=g_param[OptionsDefine.Endpoint],
40
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
41
+ )
42
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
43
+ if g_param[OptionsDefine.Language]:
44
+ profile.language = g_param[OptionsDefine.Language]
45
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
46
+ client = mod.CfsClient(cred, g_param[OptionsDefine.Region], profile)
47
+ client._sdkVersion += ("_CLI_" + __version__)
48
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
49
+ model = models.DoDirectoryOperationRequest()
50
+ model.from_json_string(json.dumps(args))
51
+ start_time = time.time()
52
+ while True:
53
+ rsp = client.DoDirectoryOperation(model)
54
+ result = rsp.to_json_string()
55
+ try:
56
+ json_obj = json.loads(result)
57
+ except TypeError as e:
58
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
59
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
60
+ break
61
+ cur_time = time.time()
62
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
63
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
64
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
65
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
66
+ else:
67
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
68
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
69
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
70
+
71
+
20
72
  def doDescribeCfsRules(args, parsed_globals):
21
73
  g_param = parse_global_arg(parsed_globals)
22
74
 
@@ -2513,7 +2565,7 @@ def doStopLifecycleDataTask(args, parsed_globals):
2513
2565
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
2514
2566
 
2515
2567
 
2516
- def doCreateCfsSnapshot(args, parsed_globals):
2568
+ def doUnbindAutoSnapshotPolicy(args, parsed_globals):
2517
2569
  g_param = parse_global_arg(parsed_globals)
2518
2570
 
2519
2571
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -2542,11 +2594,11 @@ def doCreateCfsSnapshot(args, parsed_globals):
2542
2594
  client = mod.CfsClient(cred, g_param[OptionsDefine.Region], profile)
2543
2595
  client._sdkVersion += ("_CLI_" + __version__)
2544
2596
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
2545
- model = models.CreateCfsSnapshotRequest()
2597
+ model = models.UnbindAutoSnapshotPolicyRequest()
2546
2598
  model.from_json_string(json.dumps(args))
2547
2599
  start_time = time.time()
2548
2600
  while True:
2549
- rsp = client.CreateCfsSnapshot(model)
2601
+ rsp = client.UnbindAutoSnapshotPolicy(model)
2550
2602
  result = rsp.to_json_string()
2551
2603
  try:
2552
2604
  json_obj = json.loads(result)
@@ -2617,7 +2669,7 @@ def doUpdateAutoSnapshotPolicy(args, parsed_globals):
2617
2669
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
2618
2670
 
2619
2671
 
2620
- def doUnbindAutoSnapshotPolicy(args, parsed_globals):
2672
+ def doCreateCfsSnapshot(args, parsed_globals):
2621
2673
  g_param = parse_global_arg(parsed_globals)
2622
2674
 
2623
2675
  if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -2646,11 +2698,11 @@ def doUnbindAutoSnapshotPolicy(args, parsed_globals):
2646
2698
  client = mod.CfsClient(cred, g_param[OptionsDefine.Region], profile)
2647
2699
  client._sdkVersion += ("_CLI_" + __version__)
2648
2700
  models = MODELS_MAP[g_param[OptionsDefine.Version]]
2649
- model = models.UnbindAutoSnapshotPolicyRequest()
2701
+ model = models.CreateCfsSnapshotRequest()
2650
2702
  model.from_json_string(json.dumps(args))
2651
2703
  start_time = time.time()
2652
2704
  while True:
2653
- rsp = client.UnbindAutoSnapshotPolicy(model)
2705
+ rsp = client.CreateCfsSnapshot(model)
2654
2706
  result = rsp.to_json_string()
2655
2707
  try:
2656
2708
  json_obj = json.loads(result)
@@ -2992,6 +3044,7 @@ MODELS_MAP = {
2992
3044
  }
2993
3045
 
2994
3046
  ACTION_MAP = {
3047
+ "DoDirectoryOperation": doDoDirectoryOperation,
2995
3048
  "DescribeCfsRules": doDescribeCfsRules,
2996
3049
  "UpdateCfsFileSystemPGroup": doUpdateCfsFileSystemPGroup,
2997
3050
  "DescribeLifecycleDataTask": doDescribeLifecycleDataTask,
@@ -3040,9 +3093,9 @@ ACTION_MAP = {
3040
3093
  "DescribeAutoSnapshotPolicies": doDescribeAutoSnapshotPolicies,
3041
3094
  "DeleteAutoSnapshotPolicy": doDeleteAutoSnapshotPolicy,
3042
3095
  "StopLifecycleDataTask": doStopLifecycleDataTask,
3043
- "CreateCfsSnapshot": doCreateCfsSnapshot,
3044
- "UpdateAutoSnapshotPolicy": doUpdateAutoSnapshotPolicy,
3045
3096
  "UnbindAutoSnapshotPolicy": doUnbindAutoSnapshotPolicy,
3097
+ "UpdateAutoSnapshotPolicy": doUpdateAutoSnapshotPolicy,
3098
+ "CreateCfsSnapshot": doCreateCfsSnapshot,
3046
3099
  "DescribeSnapshotOperationLogs": doDescribeSnapshotOperationLogs,
3047
3100
  "UpdateCfsFileSystemName": doUpdateCfsFileSystemName,
3048
3101
  "DescribeDataFlow": doDescribeDataFlow,
@@ -280,6 +280,13 @@
280
280
  "output": "DescribeUserQuotaResponse",
281
281
  "status": "online"
282
282
  },
283
+ "DoDirectoryOperation": {
284
+ "document": "文件系统目录操作接口",
285
+ "input": "DoDirectoryOperationRequest",
286
+ "name": "目录操作接口",
287
+ "output": "DoDirectoryOperationResponse",
288
+ "status": "online"
289
+ },
283
290
  "ModifyDataFlow": {
284
291
  "document": "修改数据流动相关参数",
285
292
  "input": "ModifyDataFlowRequest",
@@ -3637,6 +3644,70 @@
3637
3644
  ],
3638
3645
  "type": "object"
3639
3646
  },
3647
+ "DoDirectoryOperationRequest": {
3648
+ "document": "DoDirectoryOperation请求参数结构体",
3649
+ "members": [
3650
+ {
3651
+ "disabled": false,
3652
+ "document": "文件系统Id",
3653
+ "example": "cfs-5xxxyyyzz",
3654
+ "member": "string",
3655
+ "name": "FileSystemId",
3656
+ "required": true,
3657
+ "type": "string"
3658
+ },
3659
+ {
3660
+ "disabled": false,
3661
+ "document": "create:创建目录 check:确认目录是否存在",
3662
+ "example": "check",
3663
+ "member": "string",
3664
+ "name": "OpetationType",
3665
+ "required": true,
3666
+ "type": "string"
3667
+ },
3668
+ {
3669
+ "disabled": false,
3670
+ "document": "目录的绝对路径 默认递归创建(即如果目录中有子目录不存在,则先创建出对应子目录)",
3671
+ "example": "/user1/dir2/",
3672
+ "member": "string",
3673
+ "name": "DirectoryPath",
3674
+ "required": true,
3675
+ "type": "string"
3676
+ },
3677
+ {
3678
+ "disabled": false,
3679
+ "document": "创建目录的权限,若不传,默认为0755 若Operation Type为check,此值无实际意义",
3680
+ "example": "0777",
3681
+ "member": "string",
3682
+ "name": "Mode",
3683
+ "required": false,
3684
+ "type": "string"
3685
+ }
3686
+ ],
3687
+ "type": "object"
3688
+ },
3689
+ "DoDirectoryOperationResponse": {
3690
+ "document": "DoDirectoryOperation返回参数结构体",
3691
+ "members": [
3692
+ {
3693
+ "disabled": false,
3694
+ "document": "1:成功 0:失败 创建目录的操作,1表示创建成功,0表示创建失败。 确认目录是否存在的操作,1表示目录存在,0表示目录不存在。 说明:创建目录操作若目录已存在,也会返回创建成功。",
3695
+ "example": "1",
3696
+ "member": "int64",
3697
+ "name": "Result",
3698
+ "output_required": false,
3699
+ "type": "int",
3700
+ "value_allowed_null": false
3701
+ },
3702
+ {
3703
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3704
+ "member": "string",
3705
+ "name": "RequestId",
3706
+ "type": "string"
3707
+ }
3708
+ ],
3709
+ "type": "object"
3710
+ },
3640
3711
  "ExstraPerformanceInfo": {
3641
3712
  "document": "购买完额外性能之后的值",
3642
3713
  "members": [
@@ -320,6 +320,14 @@
320
320
  "title": "查询文件系统配额"
321
321
  }
322
322
  ],
323
+ "DoDirectoryOperation": [
324
+ {
325
+ "document": "用于部分类型的文件系统目录操作",
326
+ "input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetUserQuota\n<公共请求参数>\n\n{\n \"FileSystemId\": \"cfs-12345\",\n \"OpetationType\": \"create\",\n \"DirectoryPath\": \"/user1/dir1/\",\n \"Mode\": \"0644\"\n}",
327
+ "output": "{\n \"Response\": {\n \"RequestId\": \"fjo8aejo-fjei-32eu-2je9-fhue83nd81\",\n \"Result\": 1\n }\n}",
328
+ "title": "文件系统目录操作接口"
329
+ }
330
+ ],
323
331
  "ModifyDataFlow": [
324
332
  {
325
333
  "document": "",
@@ -2049,7 +2049,7 @@
2049
2049
  },
2050
2050
  {
2051
2051
  "disabled": false,
2052
- "document": "腾讯云CKafka实例ID。\nKafkaType为0时,KafkaInstance必填",
2052
+ "document": "腾讯云CKafka实例ID。\nKafkaType为0时,KafkaInstance必填\n\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。",
2053
2053
  "example": "ckafka-5kysm8",
2054
2054
  "member": "string",
2055
2055
  "name": "KafkaInstance",
@@ -2091,7 +2091,7 @@
2091
2091
  "members": [
2092
2092
  {
2093
2093
  "disabled": false,
2094
- "document": "Kafka集群可访问状态,0:可正常访问 ...",
2094
+ "document": "Kafka集群可访问状态。\n\n- 0:可正常访问 \n- -1:broker 连接失败\n- -2:sasl 鉴权失败\n- -3:ckafka 角色未授权\n- -4:topic 列表不存在\n- -5:topic 内暂无数据\n- -6:用户没有 ckafka 权限\n- -7:消费组已经存在\n- -8:kafka 实例不存在或已销毁\n- -9:Broker 列表为空\n- -10:Broker 地址格式不正确\n- -11:Broker 端口非整型",
2095
2095
  "example": "0",
2096
2096
  "member": "int64",
2097
2097
  "name": "Status",
@@ -3204,7 +3204,7 @@
3204
3204
  "members": [
3205
3205
  {
3206
3206
  "disabled": false,
3207
- "document": "工作负载的类型",
3207
+ "document": "工作负载的类型,支持\n- deployment\n- statefulset\n- daemonset\n- job\n- cronjob",
3208
3208
  "example": "daemonset",
3209
3209
  "member": "string",
3210
3210
  "name": "Kind",
@@ -6852,7 +6852,7 @@
6852
6852
  "members": [
6853
6853
  {
6854
6854
  "disabled": false,
6855
- "document": "Kafka导入配置ID",
6855
+ "document": "Kafka导入配置Id。\n\n- 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。\n- 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。",
6856
6856
  "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0895",
6857
6857
  "member": "string",
6858
6858
  "name": "Id",
@@ -6861,7 +6861,7 @@
6861
6861
  },
6862
6862
  {
6863
6863
  "disabled": false,
6864
- "document": "导入CLS目标topic ID",
6864
+ "document": "导入CLS目标日志主题Id。\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
6865
6865
  "example": "1014cc79-f006-48e4-8820-1dc727054111",
6866
6866
  "member": "string",
6867
6867
  "name": "TopicId",
@@ -9396,7 +9396,7 @@
9396
9396
  "members": [
9397
9397
  {
9398
9398
  "disabled": false,
9399
- "document": "事件通道,支持ApplicationSecuritySetupSystemALL\n",
9399
+ "document": "事件通道,支持\n- Application 应用日志\n- Security 安全日志\n- Setup 启动日志\n- System 系统日志\n- ALL 所有日志\n",
9400
9400
  "example": "Application",
9401
9401
  "member": "string",
9402
9402
  "name": "EventChannel",
@@ -9418,7 +9418,7 @@
9418
9418
  },
9419
9419
  {
9420
9420
  "disabled": false,
9421
- "document": "时间,用户选择自定义时间类型时,需要指定时间",
9421
+ "document": "时间,用户选择自定义时间类型时,需要指定时间,单位秒",
9422
9422
  "example": "12345675",
9423
9423
  "member": "uint64",
9424
9424
  "name": "Timestamp",
@@ -9430,7 +9430,7 @@
9430
9430
  {
9431
9431
  "disabled": false,
9432
9432
  "document": "事件ID过滤列表\n\t\n选填,为空表示不做过滤\n支持正向过滤单个值(例:20)或范围(例:0-20),也支持反向过滤单个值(例:-20)\n多个过滤项之间可由逗号隔开,例:1-200,-100表示采集1-200范围内除了100以外的事件日志",
9433
- "example": "1-200,-100",
9433
+ "example": "[\"1\",\"-100\"]",
9434
9434
  "member": "string",
9435
9435
  "name": "EventIDs",
9436
9436
  "output_required": true,
@@ -10462,7 +10462,7 @@
10462
10462
  {
10463
10463
  "disabled": false,
10464
10464
  "document": "服务地址",
10465
- "example": "kafkaconsumer-ap-chongqing.aaa.com:1234",
10465
+ "example": "kafkaconsumer-ap-chongqing.aaa.com:1534",
10466
10466
  "member": "string",
10467
10467
  "name": "ServerAddr",
10468
10468
  "output_required": true,
@@ -10492,7 +10492,7 @@
10492
10492
  {
10493
10493
  "disabled": false,
10494
10494
  "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开",
10495
- "example": "1256238147-f3061593-cd5b-4321-1234-3ba507d43301",
10495
+ "example": "1256238147-f3061593-cd5b-4321-1254-3ba507d43301",
10496
10496
  "member": "string",
10497
10497
  "name": "UserKafkaTopics",
10498
10498
  "output_required": true,
@@ -10531,7 +10531,7 @@
10531
10531
  },
10532
10532
  {
10533
10533
  "disabled": false,
10534
- "document": "创建时间",
10534
+ "document": "创建时间。格式`YYYY-MM-DD HH:MM:SS`",
10535
10535
  "example": "2021-11-08 14:40:22",
10536
10536
  "member": "string",
10537
10537
  "name": "CreateTime",
@@ -10541,7 +10541,7 @@
10541
10541
  },
10542
10542
  {
10543
10543
  "disabled": false,
10544
- "document": "更新时间",
10544
+ "document": "更新时间。格式`YYYY-MM-DD HH:MM:SS`",
10545
10545
  "example": "2021-11-08 14:40:22",
10546
10546
  "member": "string",
10547
10547
  "name": "UpdateTime",
@@ -11964,7 +11964,7 @@
11964
11964
  "members": [
11965
11965
  {
11966
11966
  "disabled": false,
11967
- "document": "采集配置扩展信息id",
11967
+ "document": "采集配置扩展信息id\n- 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)获取采集配置扩展信息id。",
11968
11968
  "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
11969
11969
  "member": "string",
11970
11970
  "name": "ConfigExtraId",
@@ -11974,7 +11974,7 @@
11974
11974
  {
11975
11975
  "disabled": false,
11976
11976
  "document": "采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾",
11977
- "example": "table-xxx1",
11977
+ "example": "table-config1",
11978
11978
  "member": "string",
11979
11979
  "name": "Name",
11980
11980
  "required": false,
@@ -11982,7 +11982,7 @@
11982
11982
  },
11983
11983
  {
11984
11984
  "disabled": false,
11985
- "document": "日志主题id",
11985
+ "document": "日志主题id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
11986
11986
  "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
11987
11987
  "member": "string",
11988
11988
  "name": "TopicId",
@@ -11991,7 +11991,7 @@
11991
11991
  },
11992
11992
  {
11993
11993
  "disabled": false,
11994
- "document": "节点文件配置信息",
11994
+ "document": "自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo",
11995
11995
  "example": "无",
11996
11996
  "member": "HostFileInfo",
11997
11997
  "name": "HostFile",
@@ -12009,7 +12009,7 @@
12009
12009
  },
12010
12010
  {
12011
12011
  "disabled": false,
12012
- "document": "容器标准输出信息",
12012
+ "document": "自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo",
12013
12013
  "example": "无",
12014
12014
  "member": "ContainerStdoutInfo",
12015
12015
  "name": "ContainerStdout",
@@ -12063,7 +12063,7 @@
12063
12063
  },
12064
12064
  {
12065
12065
  "disabled": false,
12066
- "document": "类型:container_stdoutcontainer_filehost_file",
12066
+ "document": "容器场景,日志采集输入类型,支持以下三种类型\n- container_stdout 标准输出\n- container_file 容器文件\n- host_file 主机节点文件",
12067
12067
  "example": "container_stdout",
12068
12068
  "member": "string",
12069
12069
  "name": "Type",
@@ -12072,7 +12072,7 @@
12072
12072
  },
12073
12073
  {
12074
12074
  "disabled": false,
12075
- "document": "机器组ID",
12075
+ "document": "机器组ID\n- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。",
12076
12076
  "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
12077
12077
  "member": "string",
12078
12078
  "name": "GroupId",
@@ -12090,7 +12090,7 @@
12090
12090
  },
12091
12091
  {
12092
12092
  "disabled": false,
12093
- "document": "日志集ID",
12093
+ "document": "日志集ID\n- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。",
12094
12094
  "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
12095
12095
  "member": "string",
12096
12096
  "name": "LogsetId",
@@ -12099,7 +12099,7 @@
12099
12099
  },
12100
12100
  {
12101
12101
  "disabled": false,
12102
- "document": "日志集name",
12102
+ "document": "日志集名称\n- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。",
12103
12103
  "example": "test-logset",
12104
12104
  "member": "string",
12105
12105
  "name": "LogsetName",
@@ -12108,7 +12108,7 @@
12108
12108
  },
12109
12109
  {
12110
12110
  "disabled": false,
12111
- "document": "日志主题name",
12111
+ "document": "日志主题名称\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。",
12112
12112
  "example": "test-topic",
12113
12113
  "member": "string",
12114
12114
  "name": "TopicName",
@@ -14157,7 +14157,7 @@
14157
14157
  },
14158
14158
  {
14159
14159
  "disabled": false,
14160
- "document": "腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。",
14160
+ "document": "腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。",
14161
14161
  "example": "ckafka-k9m5vj11",
14162
14162
  "member": "string",
14163
14163
  "name": "KafkaInstance",
@@ -14193,8 +14193,8 @@
14193
14193
  },
14194
14194
  {
14195
14195
  "disabled": false,
14196
- "document": "用户Kafka消费组",
14197
- "example": "cls-xxxxx",
14196
+ "document": "用户Kafka消费组。\n\n- 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。",
14197
+ "example": "webevent_log-group",
14198
14198
  "member": "string",
14199
14199
  "name": "ConsumerGroupName",
14200
14200
  "required": false,
@@ -16090,7 +16090,7 @@
16090
16090
  "members": [
16091
16091
  {
16092
16092
  "disabled": false,
16093
- "document": "主题id",
16093
+ "document": "日志主题id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
16094
16094
  "example": "f6c4fa6f-xxxx-xxxx-8289-1ff6f77ed975",
16095
16095
  "member": "string",
16096
16096
  "name": "TopicId",
@@ -16108,7 +16108,7 @@
16108
16108
  },
16109
16109
  {
16110
16110
  "disabled": false,
16111
- "document": "压缩方法",
16111
+ "document": "压缩方法,目前支持\n- lz4\n- zstd",
16112
16112
  "example": "lz4",
16113
16113
  "member": "string",
16114
16114
  "name": "CompressType",
@@ -27,7 +27,7 @@
27
27
  "CheckRechargeKafkaServer": [
28
28
  {
29
29
  "document": "校验用户输入Kafka服务地址是否可访问",
30
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCosRecharge\n<公共请求参数>\n\n{\n \"KafkaType\": 1,\n \"ServerAddr\": \"est.cls.tencentyun.com:9095\",\n \"IsEncryptionAddr\": false\n}",
30
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCosRecharge\n<公共请求参数>\n\n{\n \"KafkaType\": 1,\n \"ServerAddr\": \"test.cls.tencentyun.com:9095\",\n \"IsEncryptionAddr\": false\n}",
31
31
  "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"Status\": 0\n }\n}",
32
32
  "title": "校验用户输入Kafka服务地址是否可访问"
33
33
  }
@@ -743,7 +743,7 @@
743
743
  "ModifyConfigExtra": [
744
744
  {
745
745
  "document": "修改特殊采集配置任务",
746
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConfigExtra\n<公共请求参数>\n\n{\n \"ConfigExtraId\": \"6ef60bec-0242-43af-bb20-270359fb54a8\",\n \"Name\": \"testname\",\n \"TopicId\": \"6ef60bec-0242-43af-bb20-270359fb54a8\",\n \"Type\": \"host_file\",\n \"HostFile\": {\n \"LogPath\": \"/var/log/tmep\",\n \"FilePattern\": \"*.log\",\n \"CustomLabels\": [\n \"key1=value1\",\n \"key=value2\"\n ]\n },\n \"LogType\": \"minimalist_log\",\n \"ExtractRule\": {\n \"TimeKey\": \"date\",\n \"TimeFormat\": \"%Y-%m-%d %H:%M:%S\",\n \"Delimiter\": \"|\",\n \"LogRegex\": \".*\",\n \"BeginRegex\": \"^\",\n \"Keys\": [\n \"date\",\n \"\",\n \"content\"\n ],\n \"FilterKeyRegex\": [\n {\n \"Key\": \"xxx-xxx\",\n \"Regex\": \"ssss\"\n }\n ],\n \"UnMatchLogKey\": \"testlog\",\n \"UnMatchUpLoadSwitch\": true,\n \"Backtracking\": -1\n },\n \"ExcludePaths\": [\n {\n \"Type\": \"xxx-xxx\",\n \"Value\": \"xxx-xxx\"\n }\n ],\n \"UserDefineRule\": \"xxx-xxx\"\n}",
746
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConfigExtra\n<公共请求参数>\n\n{\n \"ConfigExtraId\": \"6ef60bec-0242-43af-bb20-270359fb54a8\",\n \"Name\": \"testname\",\n \"TopicId\": \"6ef60bec-0242-43af-bb20-270359fb54a8\",\n \"Type\": \"host_file\",\n \"HostFile\": {\n \"LogPath\": \"/var/log/tmep\",\n \"FilePattern\": \"*.log\",\n \"CustomLabels\": [\n \"key1=value1\",\n \"key=value2\"\n ]\n },\n \"LogType\": \"minimalist_log\",\n \"ExtractRule\": {\n \"TimeKey\": \"date\",\n \"TimeFormat\": \"%Y-%m-%d %H:%M:%S\",\n \"Delimiter\": \"|\",\n \"LogRegex\": \".*\",\n \"BeginRegex\": \"^\",\n \"Keys\": [\n \"date\",\n \"\",\n \"content\"\n ],\n \"FilterKeyRegex\": [\n {\n \"Key\": \"test-key\",\n \"Regex\": \"ssss\"\n }\n ],\n \"UnMatchLogKey\": \"testlog\",\n \"UnMatchUpLoadSwitch\": true,\n \"Backtracking\": -1\n },\n \"ExcludePaths\": [\n {\n \"Type\": \"path\",\n \"Value\": \"/var/log\"\n }\n ]\n}",
747
747
  "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60bec-0242-43af-bb20-270359fb54a8\"\n }\n}",
748
748
  "title": "修改特殊采集配置任务"
749
749
  }
@@ -893,13 +893,13 @@
893
893
  "document": "源数据预览",
894
894
  "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}",
895
895
  "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"LogData\": \"rmap[AvailIndexTraffic:0 AvailStore:0 ClusterAvailableTrafficCapacity:0...\",\n \"LogSample\": \"\"\n }\n}",
896
- "title": "Kafka导入数据预览"
896
+ "title": "Kafka导入数据预览-源数据预览"
897
897
  },
898
898
  {
899
899
  "document": "导出结果预览",
900
900
  "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}",
901
901
  "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}",
902
- "title": "Kafaka导入数据预览"
902
+ "title": "Kafka导入数据预览-导出结果预览"
903
903
  }
904
904
  ],
905
905
  "QueryMetric": [
@@ -416,7 +416,7 @@
416
416
  {
417
417
  "disabled": false,
418
418
  "document": "企业ID",
419
- "example": "",
419
+ "example": "1001",
420
420
  "member": "int64",
421
421
  "name": "CustomerId",
422
422
  "required": true,
@@ -858,7 +858,7 @@
858
858
  {
859
859
  "disabled": false,
860
860
  "document": "移动资产数组",
861
- "example": "[ ]",
861
+ "example": "",
862
862
  "member": "DisplayApp",
863
863
  "name": "List",
864
864
  "output_required": false,
@@ -7804,7 +7804,7 @@
7804
7804
  {
7805
7805
  "disabled": false,
7806
7806
  "document": "授权文件id",
7807
- "example": "11111111111",
7807
+ "example": "0cf85f4d362c10027acc6046035417fa",
7808
7808
  "member": "string",
7809
7809
  "name": "AuthFile",
7810
7810
  "required": false,
@@ -7822,7 +7822,7 @@
7822
7822
  {
7823
7823
  "disabled": false,
7824
7824
  "document": "企业图标",
7825
- "example": "",
7825
+ "example": "0cf85f4d362c10027acc6046035417fa",
7826
7826
  "member": "string",
7827
7827
  "name": "Icon",
7828
7828
  "required": false,
@@ -7840,7 +7840,7 @@
7840
7840
  {
7841
7841
  "disabled": false,
7842
7842
  "document": "子公司拓展层次",
7843
- "example": "",
7843
+ "example": "0",
7844
7844
  "member": "int64",
7845
7845
  "name": "SubCompanyLevel",
7846
7846
  "required": false,
@@ -7849,7 +7849,7 @@
7849
7849
  {
7850
7850
  "disabled": false,
7851
7851
  "document": "是否包含完整的扫描",
7852
- "example": "",
7852
+ "example": "false",
7853
7853
  "member": "bool",
7854
7854
  "name": "IsIncludeFullScan",
7855
7855
  "required": false,
@@ -7967,7 +7967,7 @@
7967
7967
  {
7968
7968
  "disabled": false,
7969
7969
  "document": "企业ID",
7970
- "example": "",
7970
+ "example": "1001",
7971
7971
  "member": "int64",
7972
7972
  "name": "CustomerId",
7973
7973
  "required": false,
@@ -7976,7 +7976,7 @@
7976
7976
  {
7977
7977
  "disabled": false,
7978
7978
  "document": "任务ID",
7979
- "example": "",
7979
+ "example": "100",
7980
7980
  "member": "int64",
7981
7981
  "name": "JobRecordId",
7982
7982
  "required": false,
@@ -3,7 +3,7 @@
3
3
  "CreateCustomer": [
4
4
  {
5
5
  "document": "添加企业",
6
- "input": "POST / HTTP/1.1\nHost: ctem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCustomer\n<公共请求参数>\n\n{\n \"Name\": \"测试\",\n \"ScanType\": \"资产收集\",\n \"Percent\": 55\n}",
6
+ "input": "POST / HTTP/1.1\nHost: ctem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCustomer\n<公共请求参数>\n\n{\n \"Name\": \"流云测试\",\n \"ScanType\": \"资产收集\",\n \"Percent\": 55\n}",
7
7
  "output": "{\n \"Response\": {\n \"RequestId\": \"c5458985-ef27-455e-a417-62e8001a4bd6\"\n }\n}",
8
8
  "title": "添加企业"
9
9
  }
@@ -20,7 +20,7 @@
20
20
  {
21
21
  "document": "查看移动端资产",
22
22
  "input": "POST / HTTP/1.1\nHost: ctem.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApps\n<公共请求参数>\n\n{}",
23
- "output": "{\n \"Response\": {\n \"List\": [\n {\n \"AppVersion\": \"v1.1.1\",\n \"Description\": \"\",\n \"Developer\": \"tester\",\n \"DisplayToolCommon\": {\n \"CreateAt\": \"2024-06-06 17:30:23\",\n \"CustomerId\": 100081,\n \"CustomerName\": \"5555\",\n \"Detail\": \"test\",\n \"EnterpriseName\": \"\",\n \"EnterpriseUid\": \"\",\n \"Ignored\": false,\n \"JobId\": 0,\n \"JobRecordId\": 0,\n \"JobStageId\": 0,\n \"Md5\": \"b5c10af2a904da1ce896da2800e4933b\",\n \"UpdateAt\": \"2024-06-06 17:30:23\"\n },\n \"DownloadUrl\": \"http://a.test.com\",\n \"Id\": 11,\n \"Logo\": \"\",\n \"Name\": \"test\",\n \"PackageName\": \"com.test\",\n \"Platform\": \"android\",\n \"ServerUrl\": \"http://test.com\"\n }\n ],\n \"RequestId\": \"922257b7-c750-4d0c-8e74-3f4119551fee\",\n \"Total\": 1\n }\n}",
23
+ "output": "{\n \"Response\": {\n \"List\": [\n {\n \"AppVersion\": \"v1.1.1\",\n \"Description\": \"\",\n \"Developer\": \"tester\",\n \"DisplayToolCommon\": {\n \"CreateAt\": \"2024-06-06 17:30:23\",\n \"CustomerId\": 100081,\n \"CustomerName\": \"5555\",\n \"Detail\": \"测试资产\",\n \"EnterpriseName\": \"\",\n \"EnterpriseUid\": \"\",\n \"Ignored\": false,\n \"JobId\": 0,\n \"JobRecordId\": 0,\n \"JobStageId\": 0,\n \"Md5\": \"b5c10af2a904da1ce896da2800e4933b\",\n \"UpdateAt\": \"2024-06-06 17:30:23\"\n },\n \"DownloadUrl\": \"http://a.test.com\",\n \"Id\": 11,\n \"Logo\": \"\",\n \"Name\": \"com.test\",\n \"PackageName\": \"com.test\",\n \"Platform\": \"android\",\n \"ServerUrl\": \"http://test.com\"\n }\n ],\n \"RequestId\": \"922257b7-c750-4d0c-8e74-3f4119551fee\",\n \"Total\": 1\n }\n}",
24
24
  "title": "查看移动端资产"
25
25
  }
26
26
  ],