tccli 3.0.1386.1__py2.py3-none-any.whl → 3.0.1388.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 (47) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/apm/v20210622/api.json +20 -10
  3. tccli/services/apm/v20210622/examples.json +2 -2
  4. tccli/services/asr/v20190614/api.json +2 -2
  5. tccli/services/bh/v20230418/api.json +9 -0
  6. tccli/services/ccc/ccc_client.py +134 -28
  7. tccli/services/ccc/v20200210/api.json +514 -0
  8. tccli/services/ccc/v20200210/examples.json +16 -0
  9. tccli/services/cdwpg/v20201230/api.json +22 -4
  10. tccli/services/ckafka/v20190819/api.json +83 -85
  11. tccli/services/ckafka/v20190819/examples.json +6 -6
  12. tccli/services/cls/v20201016/api.json +1 -1
  13. tccli/services/csip/v20221121/api.json +66 -16
  14. tccli/services/cynosdb/v20190107/api.json +36 -36
  15. tccli/services/dlc/v20210125/api.json +342 -1
  16. tccli/services/dlc/v20210125/examples.json +8 -2
  17. tccli/services/dnspod/v20210323/api.json +22 -12
  18. tccli/services/es/v20180416/api.json +7 -7
  19. tccli/services/faceid/v20180301/api.json +12 -2
  20. tccli/services/gs/gs_client.py +57 -4
  21. tccli/services/gs/v20191118/api.json +34 -0
  22. tccli/services/gs/v20191118/examples.json +8 -0
  23. tccli/services/ioa/ioa_client.py +267 -55
  24. tccli/services/ioa/v20220601/api.json +963 -98
  25. tccli/services/ioa/v20220601/examples.json +39 -1
  26. tccli/services/iotexplorer/v20190423/api.json +154 -2
  27. tccli/services/lke/v20231130/api.json +57 -19
  28. tccli/services/mongodb/mongodb_client.py +53 -0
  29. tccli/services/mongodb/v20190725/api.json +46 -2
  30. tccli/services/mongodb/v20190725/examples.json +8 -0
  31. tccli/services/ocr/v20181119/api.json +25 -25
  32. tccli/services/ocr/v20181119/examples.json +2 -2
  33. tccli/services/omics/v20221128/api.json +163 -13
  34. tccli/services/redis/v20180412/api.json +124 -42
  35. tccli/services/redis/v20180412/examples.json +6 -6
  36. tccli/services/tcaplusdb/v20190823/api.json +23 -3
  37. tccli/services/tione/v20211111/api.json +65 -15
  38. tccli/services/tione/v20211111/examples.json +1 -1
  39. tccli/services/trtc/v20190722/api.json +97 -14
  40. tccli/services/vdb/v20230616/api.json +2 -2
  41. tccli/services/vpc/v20170312/api.json +39 -10
  42. tccli/services/vpc/v20170312/examples.json +2 -2
  43. {tccli-3.0.1386.1.dist-info → tccli-3.0.1388.1.dist-info}/METADATA +2 -2
  44. {tccli-3.0.1386.1.dist-info → tccli-3.0.1388.1.dist-info}/RECORD +47 -47
  45. {tccli-3.0.1386.1.dist-info → tccli-3.0.1388.1.dist-info}/WHEEL +0 -0
  46. {tccli-3.0.1386.1.dist-info → tccli-3.0.1388.1.dist-info}/entry_points.txt +0 -0
  47. {tccli-3.0.1386.1.dist-info → tccli-3.0.1388.1.dist-info}/license_files/LICENSE +0 -0
@@ -2222,8 +2222,8 @@
2222
2222
  "members": [
2223
2223
  {
2224
2224
  "disabled": false,
2225
- "document": "消息保留时间",
2226
- "example": "1",
2225
+ "document": "消息保留时间,单位ms。",
2226
+ "example": "3600000",
2227
2227
  "member": "int64",
2228
2228
  "name": "Retention",
2229
2229
  "output_required": false,
@@ -2252,8 +2252,8 @@
2252
2252
  },
2253
2253
  {
2254
2254
  "disabled": false,
2255
- "document": "Segment 分片滚动的时长\n注意:此字段可能返回 null,表示取不到有效值。",
2256
- "example": "1",
2255
+ "document": "Segment 分片滚动的时长,单位ms。\n注意:此字段可能返回 null,表示取不到有效值。",
2256
+ "example": "86400000",
2257
2257
  "member": "int64",
2258
2258
  "name": "SegmentMs",
2259
2259
  "output_required": false,
@@ -2272,8 +2272,8 @@
2272
2272
  },
2273
2273
  {
2274
2274
  "disabled": false,
2275
- "document": "Segment 分片滚动的字节数\n注意:此字段可能返回 null,表示取不到有效值。",
2276
- "example": "1",
2275
+ "document": "Segment 分片滚动的字节数,单位bytes\n注意:此字段可能返回 null,表示取不到有效值。",
2276
+ "example": "104857600",
2277
2277
  "member": "int64",
2278
2278
  "name": "SegmentBytes",
2279
2279
  "output_required": false,
@@ -2282,8 +2282,8 @@
2282
2282
  },
2283
2283
  {
2284
2284
  "disabled": false,
2285
- "document": "最大消息字节数\n注意:此字段可能返回 null,表示取不到有效值。",
2286
- "example": "1",
2285
+ "document": "最大消息字节数,单位bytes\n注意:此字段可能返回 null,表示取不到有效值。",
2286
+ "example": "1024",
2287
2287
  "member": "int64",
2288
2288
  "name": "MaxMessageBytes",
2289
2289
  "output_required": false,
@@ -2292,8 +2292,8 @@
2292
2292
  },
2293
2293
  {
2294
2294
  "disabled": false,
2295
- "document": "消息保留文件大小\n注意:此字段可能返回 null,表示取不到有效值。",
2296
- "example": "107374",
2295
+ "document": "消息保留文件大小,单位Bytes\n注意:此字段可能返回 null,表示取不到有效值。",
2296
+ "example": "1073741824",
2297
2297
  "member": "int64",
2298
2298
  "name": "RetentionBytes",
2299
2299
  "output_required": false,
@@ -2302,7 +2302,7 @@
2302
2302
  },
2303
2303
  {
2304
2304
  "disabled": false,
2305
- "document": "消息保存的时间类型\n注意:此字段可能返回 null,表示取不到有效值。",
2305
+ "document": "消息保存的时间类型,CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。\n注意:此字段可能返回 null,表示取不到有效值。",
2306
2306
  "example": "LogAppendTime",
2307
2307
  "member": "string",
2308
2308
  "name": "LogMsgTimestampType",
@@ -3594,7 +3594,7 @@
3594
3594
  },
3595
3595
  {
3596
3596
  "disabled": false,
3597
- "document": "预付费购买时长,例如 \"1m\",就是一个月",
3597
+ "document": "预付费购买时长,例如 \"1m\",就是一个月,取值范围 1m~36m",
3598
3598
  "example": "1m",
3599
3599
  "member": "string",
3600
3600
  "name": "Period",
@@ -3658,7 +3658,7 @@
3658
3658
  {
3659
3659
  "disabled": false,
3660
3660
  "document": "CKafka版本号[2.4.1, 2.4.2, 2.8.1, 3.2.3], 默认取值是2.4.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。",
3661
- "example": "1.1.1",
3661
+ "example": "2.4.2",
3662
3662
  "member": "string",
3663
3663
  "name": "KafkaVersion",
3664
3664
  "required": false,
@@ -4202,7 +4202,7 @@
4202
4202
  },
4203
4203
  {
4204
4204
  "disabled": false,
4205
- "document": "访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0",
4205
+ "document": "访问类型:0-plaintext;1-sasl_plaintext;3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512 默认为0\nvipType=3,支持 0,1,3,4,5\nvipType=7,支持0,1,3\nvipType=1,支持1,3\n",
4206
4206
  "example": "1",
4207
4207
  "member": "int64",
4208
4208
  "name": "AccessType",
@@ -4376,7 +4376,7 @@
4376
4376
  "members": [
4377
4377
  {
4378
4378
  "disabled": false,
4379
- "document": "实例Id",
4379
+ "document": "实例Id,可通过DescribeInstances接口获取。",
4380
4380
  "example": "ckafka-test",
4381
4381
  "member": "string",
4382
4382
  "name": "InstanceId",
@@ -4439,7 +4439,7 @@
4439
4439
  },
4440
4440
  {
4441
4441
  "disabled": false,
4442
- "document": "主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)",
4442
+ "document": "主题备注,是一个不超过 64 个字符的字符串,可以用字母和数字为首字符,剩余部分可以包含字母、数字和横划线(-)",
4443
4443
  "example": "note",
4444
4444
  "member": "string",
4445
4445
  "name": "Note",
@@ -4448,7 +4448,7 @@
4448
4448
  },
4449
4449
  {
4450
4450
  "disabled": false,
4451
- "document": "默认为1",
4451
+ "document": "最小同步副本数,默认为1",
4452
4452
  "example": "2",
4453
4453
  "member": "int64",
4454
4454
  "name": "MinInsyncReplicas",
@@ -4457,7 +4457,7 @@
4457
4457
  },
4458
4458
  {
4459
4459
  "disabled": false,
4460
- "document": "是否允许未同步的副本选为leader,false:不允许,true:允许,默认不允许",
4460
+ "document": "是否允许未同步的副本选为leader,0:不允许,1:允许,默认不允许",
4461
4461
  "example": "1",
4462
4462
  "member": "int64",
4463
4463
  "name": "UncleanLeaderElectionEnable",
@@ -4466,7 +4466,7 @@
4466
4466
  },
4467
4467
  {
4468
4468
  "disabled": false,
4469
- "document": "可选参数。消息保留时间,单位ms,当前最小值为60000ms",
4469
+ "document": "可选参数。消息保留时间,单位ms,当前最小值为60000。默认值为7200000ms(2小时),最大值为7776000000 ms(90天)。",
4470
4470
  "example": "60000",
4471
4471
  "member": "int64",
4472
4472
  "name": "RetentionMs",
@@ -4475,8 +4475,8 @@
4475
4475
  },
4476
4476
  {
4477
4477
  "disabled": false,
4478
- "document": "Segment分片滚动的时长,单位ms,当前最小为3600000ms",
4479
- "example": "360000",
4478
+ "document": "Segment分片滚动的时长,单位ms,最小值为86400000ms(1天)。",
4479
+ "example": "86400000",
4480
4480
  "member": "int64",
4481
4481
  "name": "SegmentMs",
4482
4482
  "required": false,
@@ -4484,7 +4484,7 @@
4484
4484
  },
4485
4485
  {
4486
4486
  "disabled": false,
4487
- "document": "主题消息最大值,单位为 Byte,最小值1024Byte(即1KB),最大值为12582912Byte(即12MB)",
4487
+ "document": "主题消息最大值,单位为 Byte,最小值1024Bytes(即1KB),最大值为12582912Bytes(即12MB)",
4488
4488
  "example": "1024",
4489
4489
  "member": "int64",
4490
4490
  "name": "MaxMessageBytes",
@@ -4511,8 +4511,8 @@
4511
4511
  },
4512
4512
  {
4513
4513
  "disabled": false,
4514
- "document": "可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B",
4515
- "example": "-1",
4514
+ "document": "可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。",
4515
+ "example": "1073741824",
4516
4516
  "member": "int64",
4517
4517
  "name": "RetentionBytes",
4518
4518
  "required": false,
@@ -4521,7 +4521,7 @@
4521
4521
  {
4522
4522
  "disabled": false,
4523
4523
  "document": "标签列表",
4524
- "example": "[{\"TagKey\":\"tagkey-test\",\"TagValue\":\"tagvalue-test\"}]\t",
4524
+ "example": "",
4525
4525
  "member": "Tag",
4526
4526
  "name": "Tags",
4527
4527
  "required": false,
@@ -4552,7 +4552,7 @@
4552
4552
  {
4553
4553
  "disabled": false,
4554
4554
  "document": "返回创建结果",
4555
- "example": "{\"TopicId\":\"topic-crb21z3o\"}",
4555
+ "example": "",
4556
4556
  "member": "CreateTopicResp",
4557
4557
  "name": "Result",
4558
4558
  "output_required": true,
@@ -6706,7 +6706,7 @@
6706
6706
  "members": [
6707
6707
  {
6708
6708
  "disabled": false,
6709
- "document": "连接源的Id",
6709
+ "document": "连接源数据信息",
6710
6710
  "example": "无",
6711
6711
  "member": "DescribeConnectResourceResp",
6712
6712
  "name": "Result",
@@ -6737,7 +6737,7 @@
6737
6737
  },
6738
6738
  {
6739
6739
  "disabled": false,
6740
- "document": "连接源名称的关键字查询",
6740
+ "document": "连接源名称的关键字查询,支持模糊匹配",
6741
6741
  "example": "search-test",
6742
6742
  "member": "string",
6743
6743
  "name": "SearchWord",
@@ -6755,7 +6755,7 @@
6755
6755
  },
6756
6756
  {
6757
6757
  "disabled": false,
6758
- "document": "返回数量,默认为20,最大值为100",
6758
+ "document": "返回数量,默认为20,最大值为1000 (超过1000,则限制为1000)",
6759
6759
  "example": "20",
6760
6760
  "member": "int64",
6761
6761
  "name": "Limit",
@@ -6806,7 +6806,7 @@
6806
6806
  {
6807
6807
  "disabled": false,
6808
6808
  "document": "连接源列表",
6809
- "example": "{\"TotalCount\":1,\"ConnectResourceList\":[{\"ResourceId\":\"resource-test\",\"ResourceName\":\"resource-test\"]}",
6809
+ "example": "",
6810
6810
  "member": "DescribeConnectResourcesResp",
6811
6811
  "name": "Result",
6812
6812
  "output_required": true,
@@ -6827,7 +6827,7 @@
6827
6827
  "members": [
6828
6828
  {
6829
6829
  "disabled": false,
6830
- "document": "ckafka集群实例Id",
6830
+ "document": "ckafka集群实例Id,通过DescribeInstances接口获取",
6831
6831
  "example": "ckafka-test",
6832
6832
  "member": "string",
6833
6833
  "name": "InstanceId",
@@ -6836,7 +6836,7 @@
6836
6836
  },
6837
6837
  {
6838
6838
  "disabled": false,
6839
- "document": "可选,用户需要查询的group名称。",
6839
+ "document": "用户需要查询的group名称。",
6840
6840
  "example": " group-test",
6841
6841
  "member": "string",
6842
6842
  "name": "GroupName",
@@ -6845,7 +6845,7 @@
6845
6845
  },
6846
6846
  {
6847
6847
  "disabled": false,
6848
- "document": "可选,用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。",
6848
+ "document": "用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。",
6849
6849
  "example": " topic-test",
6850
6850
  "member": "string",
6851
6851
  "name": "TopicName",
@@ -6854,7 +6854,7 @@
6854
6854
  },
6855
6855
  {
6856
6856
  "disabled": false,
6857
- "document": "本次返回个数限制,最大支持50",
6857
+ "document": "返回消费组的限制数量,最大支持50",
6858
6858
  "example": "20",
6859
6859
  "member": "int64",
6860
6860
  "name": "Limit",
@@ -6863,7 +6863,7 @@
6863
6863
  },
6864
6864
  {
6865
6865
  "disabled": false,
6866
- "document": "偏移位置",
6866
+ "document": "消费组列表的起始偏移量",
6867
6867
  "example": "0",
6868
6868
  "member": "int64",
6869
6869
  "name": "Offset",
@@ -6879,7 +6879,7 @@
6879
6879
  {
6880
6880
  "disabled": false,
6881
6881
  "document": "返回的消费分组信息",
6882
- "example": "{\"TotalCount\":1,\"TopicList\":[{\"TopicId\":\"topic-test\",\"TopicName\":\"topic-test\"}],\"GroupList\":[{\"ConsumerGroupName\":\"group-test\",\"SubscribedInfo\":[{\"TopicName\":\"topic-test\",\"PartitionOffset\":[{\"Partition\":\"0\",\"Offset\":966186803},{\"Partition\":\"1\",\"Offset\":968552882},{\"Partition\":\"2\",\"Offset\":957792934}]}]}],\"TotalPartition\":3,\"PartitionListForMonitor\":[],\"TotalTopic\":1,\"TopicListForMonitor\":[{\"TopicId\":\"topic-test\",\"TopicName\":\"topic-test\"}],\"GroupListForMonitor\":[{\"GroupName\":\"group-test\"}]}",
6882
+ "example": "",
6883
6883
  "member": "ConsumerGroupResponse",
6884
6884
  "name": "Result",
6885
6885
  "output_required": true,
@@ -7223,7 +7223,7 @@
7223
7223
  "members": [
7224
7224
  {
7225
7225
  "disabled": false,
7226
- "document": "返回数量,默认为20,最大值为100",
7226
+ "document": "返回数量,默认为20,最大值为100 (超过100限制为100)",
7227
7227
  "example": "20",
7228
7228
  "member": "int64",
7229
7229
  "name": "Limit",
@@ -7319,7 +7319,7 @@
7319
7319
  {
7320
7320
  "disabled": false,
7321
7321
  "document": "返回任务查询结果",
7322
- "example": "{\"TotalCount\":1,\"TaskList\":[{\"Status\":1,\"TaskId\":\"task-test\",\"TaskName\":\"task测试\",\"TaskType\":\"SINK\",\"SourceResource\":{\"Type\":\"KAFKA\",\"KafkaParam\":{\"SelfBuilt\":false,\"Resource\":\"ckafka-test\",\"Topic\":\"topic-test\",\"OffsetType\":\"timestamp\",\"StartTime\":1635339533,\"ResourceName\":\"resourceName-test\",\"ZoneId\":100003}},\"TargetResource\":{\"Type\":\"EB\",\"EventBusParam\":{\"Type\":\"COS\",\"SelfBuilt\":false,\"Resource\":\"resource-test\",\"Namespace\":\"default\",\"FunctionName\":\"functionName-test\",\"Qualifier\":\"$LATEST\"}}}]}",
7322
+ "example": "",
7323
7323
  "member": "DescribeDatahubTasksRes",
7324
7324
  "name": "Result",
7325
7325
  "output_required": true,
@@ -7617,7 +7617,7 @@
7617
7617
  "members": [
7618
7618
  {
7619
7619
  "disabled": false,
7620
- "document": "ckafka集群实例Id",
7620
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取",
7621
7621
  "example": "ckafka-test",
7622
7622
  "member": "string",
7623
7623
  "name": "InstanceId",
@@ -7626,7 +7626,7 @@
7626
7626
  },
7627
7627
  {
7628
7628
  "disabled": false,
7629
- "document": "Kafka 消费分组列表",
7629
+ "document": "Kafka 消费分组列表,可通过DescribeConsumerGroup接口获取",
7630
7630
  "example": "[\"group-test\"]",
7631
7631
  "member": "string",
7632
7632
  "name": "GroupList",
@@ -7642,7 +7642,7 @@
7642
7642
  {
7643
7643
  "disabled": false,
7644
7644
  "document": "返回的结果",
7645
- "example": "[{\"ErrorCode\":\"0\",\"Group\":\"group-test\",\"Members\":[],\"Protocol\":\"\",\"ProtocolType\":\"consumer\",\"State\":\"Empty\"}]",
7645
+ "example": "",
7646
7646
  "member": "GroupInfoResponse",
7647
7647
  "name": "Result",
7648
7648
  "output_required": true,
@@ -7818,7 +7818,7 @@
7818
7818
  "members": [
7819
7819
  {
7820
7820
  "disabled": false,
7821
- "document": "ckafka集群实例Id",
7821
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取",
7822
7822
  "example": "ckafka-test",
7823
7823
  "member": "string",
7824
7824
  "name": "InstanceId",
@@ -7834,7 +7834,7 @@
7834
7834
  {
7835
7835
  "disabled": false,
7836
7836
  "document": "实例属性返回结果对象。",
7837
- "example": "{\"Bandwidth\":800,\"ClusterType\":\"CLOUD_EKS_TSE\",\"Config\":{\"AutoCreateTopicsEnable\":false,\"DefaultNumPartitions\":1,\"DefaultReplicationFactor\":2},\"CreateTime\":1732245392,\"CreatedPartitions\":60,\"CreatedTopics\":6,\"CustomCertId\":null,\"Cvm\":1,\"DeleteRouteTimestamp\":\"\",\"DiskSize\":1000,\"DynamicDiskConfig\":{\"DiskQuotaPercentage\":null,\"Enable\":null,\"MaxDiskSpace\":null,\"StepForwardPercentage\":null},\"ElasticFloatBandwidth\":240,\"ExpireTime\":1734837392,\"Features\":[\"FEATURE_SUBNET_ACL\",\"FEATURE_SASL_SSL\",\"FEATURE_MULIT_SASL_PLAINTEXT\",\"FEATURE_SASL_SCRAM_512\",\"FEATURE_TOPIC_QUOTA\",\"CLOUD_EKS_TSE\",\"CLOUD_EKS_CROS_ZONE\",\"FEATURE_SASL_SCRAM\"],\"FreePartitionNumber\":1200,\"Healthy\":1,\"HealthyMessage\":\"\",\"InstanceChargeType\":\"PREPAID\",\"InstanceId\":\"ckafka-wdvgwwx2\",\"InstanceName\":\"test-public-network\",\"InstanceType\":\"profession\",\"MaxConnection\":50000,\"MaxGroupNum\":500,\"MsgRetentionTime\":4320,\"PublicNetwork\":3,\"RemainderPartitions\":1140,\"RemainderTopics\":594,\"RemainingPartitions\":1140,\"RemainingTopics\":594,\"RetentionTimeConfig\":{\"BottomRetention\":null,\"DiskQuotaPercentage\":null,\"Enable\":null,\"StepForwardPercentage\":null},\"Status\":1,\"SubnetId\":\"subnet-5rhipsse\",\"Tags\":[],\"Version\":\"2.8.1\",\"Vip\":\"10.0.1.17\",\"VipList\":[{\"Vip\":\"10.0.1.17\",\"Vport\":\"9092\"}],\"VpcId\":\"vpc-ks7w9y0b\",\"Vport\":\"9092\",\"ZoneId\":100006,\"ZoneIds\":[100006,100007]}",
7837
+ "example": "",
7838
7838
  "member": "InstanceAttributesResponse",
7839
7839
  "name": "Result",
7840
7840
  "output_required": true,
@@ -8190,7 +8190,7 @@
8190
8190
  {
8191
8191
  "disabled": false,
8192
8192
  "document": "返回的路由信息结果集",
8193
- "example": "{\"Routers\":[{\"AccessType\":0,\"RouteId\":301,\"VipType\":3,\"VipList\":[{\"Vip\":\"1.0.0.5\",\"Vport\":\"9092\"}],\"Domain\":\"\",\"DomainPort\":0,\"DeleteTimestamp\":1566144000,\"InternalFlag\":0,\"UsedFor\":\"\",\"Subnet\":\"subnet-test\",\"BrokerVipList\":[{\"Vip\":\"1.0.0.5\",\"Vport\":\"9093\"},{\"Vip\":\"1.0.0.5\",\"Vport\":\"9094\"},{\"Vip\":\"1.0.0.5\",\"Vport\":\"9095\"}],\"Processing\":1,\"VpcId\":\"vpc-test\"}]}",
8193
+ "example": "",
8194
8194
  "member": "RouteResponse",
8195
8195
  "name": "Result",
8196
8196
  "output_required": true,
@@ -8321,7 +8321,7 @@
8321
8321
  "members": [
8322
8322
  {
8323
8323
  "disabled": false,
8324
- "document": "ckafka集群实例Id",
8324
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取。",
8325
8325
  "example": "ckafka-test",
8326
8326
  "member": "string",
8327
8327
  "name": "InstanceId",
@@ -8330,7 +8330,7 @@
8330
8330
  },
8331
8331
  {
8332
8332
  "disabled": false,
8333
- "document": "主题名称",
8333
+ "document": "主题名称,可通过DescribeTopic接口获取。",
8334
8334
  "example": "topic-test",
8335
8335
  "member": "string",
8336
8336
  "name": "TopicName",
@@ -8346,7 +8346,7 @@
8346
8346
  {
8347
8347
  "disabled": false,
8348
8348
  "document": "返回的结果对象",
8349
- "example": "{\"TopicId\":\"topic-test\",\"CreateTime\":1566144000,\"Note\":\"note-test\",\"PartitionNum\":20,\"EnableWhiteList\":0,\"IpWhiteList\":[\"10.0.0.5\"],\"Config\":{\"Retention\":60000,\"MinInsyncReplicas\":1,\"CleanUpPolicy\":\"delete\",\"SegmentMs\":60000,\"UncleanLeaderElectionEnable\":0,\"SegmentBytes\":1048576,\"MaxMessageBytes\":1048576,\"RetentionBytes\":1048576},\"Partitions\":[{\"Partition\":0,\"LeaderStatus\":0,\"IsrNum\":2,\"ReplicaNum\":2}],\"EnableAclRule\":0,\"AclRuleList\":[],\"QuotaConfig\":{\"QuotaProducerByteRate\":50,\"QuotaConsumerByteRate\":50},\"ReplicaNum\":2}",
8349
+ "example": "",
8350
8350
  "member": "TopicAttributesResponse",
8351
8351
  "name": "Result",
8352
8352
  "output_required": true,
@@ -8367,7 +8367,7 @@
8367
8367
  "members": [
8368
8368
  {
8369
8369
  "disabled": false,
8370
- "document": "ckafka集群实例Id",
8370
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取。",
8371
8371
  "example": "ckafka-test",
8372
8372
  "member": "string",
8373
8373
  "name": "InstanceId",
@@ -8394,7 +8394,7 @@
8394
8394
  },
8395
8395
  {
8396
8396
  "disabled": false,
8397
- "document": "返回数量,不填则默认 10,最大值20,取值要大于0",
8397
+ "document": "返回数量,不填则默认 20,取值要大于0",
8398
8398
  "example": "10",
8399
8399
  "member": "int64",
8400
8400
  "name": "Limit",
@@ -8412,7 +8412,7 @@
8412
8412
  },
8413
8413
  {
8414
8414
  "disabled": false,
8415
- "document": "根据特定的属性排序(目前支持PartitionNum/CreateTime)",
8415
+ "document": "根据特定的属性排序(目前支持PartitionNum/CreateTime),默认值为CreateTime。",
8416
8416
  "example": "PartitionNum/CreateTime",
8417
8417
  "member": "string",
8418
8418
  "name": "OrderBy",
@@ -8421,7 +8421,7 @@
8421
8421
  },
8422
8422
  {
8423
8423
  "disabled": false,
8424
- "document": "0-顺序、1-倒序",
8424
+ "document": "0-顺序、1-倒序,默认值为0。",
8425
8425
  "example": "0",
8426
8426
  "member": "int64",
8427
8427
  "name": "OrderType",
@@ -8431,7 +8431,7 @@
8431
8431
  {
8432
8432
  "disabled": false,
8433
8433
  "document": "目前支持 ReplicaNum (副本数)筛选",
8434
- "example": "[{\"Name\":\"filtername-test\",\"TagValue\":[\"filtervalue-test\"]}]",
8434
+ "example": "",
8435
8435
  "member": "Filter",
8436
8436
  "name": "Filters",
8437
8437
  "required": false,
@@ -8446,7 +8446,7 @@
8446
8446
  {
8447
8447
  "disabled": false,
8448
8448
  "document": "返回的主题详情实体",
8449
- "example": "{\"TopicList\":[{\"TopicName\":\"topic-test\",\"TopicId\":\"topic-test\",\"PartitionNum\":1,\"ReplicaNum\":2,\"Note\":\"note-test\",\"CreateTime\":1566144000,\"EnableWhiteList\":true,\"IpWhiteListCount\":0,\"ForwardCosBucket\":\"\",\"ForwardStatus\":0,\"ForwardInterval\":0,\"Config\":{\"Retention\":60000,\"MinInsyncReplicas\":0,\"CleanUpPolicy\":\"delete\",\"SegmentMs\":3600000,\"UncleanLeaderElectionEnable\":0,\"SegmentBytes\":1048576,\"MaxMessageBytes\":1048576,\"RetentionBytes\":1048576},\"Status\":0,\"Tags\":[{\"TagKey\":\"tagkey-test\",\"TagValue\":\"tagvalue-test\"}]}],\"TotalCount\":1}",
8449
+ "example": "",
8450
8450
  "member": "TopicDetailResponse",
8451
8451
  "name": "Result",
8452
8452
  "output_required": true,
@@ -8467,7 +8467,7 @@
8467
8467
  "members": [
8468
8468
  {
8469
8469
  "disabled": false,
8470
- "document": "ckafka集群实例Id",
8470
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取。",
8471
8471
  "example": "ckafka-test",
8472
8472
  "member": "string",
8473
8473
  "name": "InstanceId",
@@ -8519,7 +8519,7 @@
8519
8519
  {
8520
8520
  "disabled": false,
8521
8521
  "document": "流量排行返回结果",
8522
- "example": "{\"BrokerIp\":[\"10.0.0.14\",\"10.0.0.15\",\"10.0.0.16\",\"10.0.0.17\"],\"BrokerTopicData\":[],\"BrokerTopicFlowData\":[],\"ConsumeSpeed\":[{\"ConsumerGroupName\":\"group-test\",\"Speed\":0}],\"TopicFlow\":[{\"MessageHeap\":0,\"PartitionNum\":3,\"ReplicaNum\":2,\"TopicId\":\"topic-test\",\"TopicName\":\"topic-test\",\"TopicTraffic\":\"0.00\"}],\"TopicMessageHeap\":[{\"MessageHeap\":0,\"PartitionNum\":3,\"ReplicaNum\":2,\"TopicId\":\"topic-test\",\"TopicName\":\"topic-test\",\"TopicTraffic\":\"0.00\"}]}",
8522
+ "example": "",
8523
8523
  "member": "TopicFlowRankingResult",
8524
8524
  "name": "Result",
8525
8525
  "output_required": true,
@@ -8540,7 +8540,7 @@
8540
8540
  "members": [
8541
8541
  {
8542
8542
  "disabled": false,
8543
- "document": "ckafka集群实例Id",
8543
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取。",
8544
8544
  "example": "ckafka-test",
8545
8545
  "member": "string",
8546
8546
  "name": "InstanceId",
@@ -8549,7 +8549,7 @@
8549
8549
  },
8550
8550
  {
8551
8551
  "disabled": false,
8552
- "document": "主题名",
8552
+ "document": "主题名,可通过DescribeTopic接口获取。",
8553
8553
  "example": "topic-test",
8554
8554
  "member": "string",
8555
8555
  "name": "TopicName",
@@ -8565,7 +8565,7 @@
8565
8565
  {
8566
8566
  "disabled": false,
8567
8567
  "document": "链接信息返回结果集",
8568
- "example": "[{\"IpAddr\":\"10.0.0.30\",\"Time\":\"2019-08-19 00:00:00\",\"IsUnSupportVersion\":true}]",
8568
+ "example": "",
8569
8569
  "member": "DescribeConnectInfoResultDTO",
8570
8570
  "name": "Result",
8571
8571
  "output_required": true,
@@ -8750,7 +8750,7 @@
8750
8750
  },
8751
8751
  {
8752
8752
  "disabled": false,
8753
- "document": "返回数量,不填则默认10,最大值20。",
8753
+ "document": "返回数量,默认值为20,必须大于0。",
8754
8754
  "example": "10",
8755
8755
  "member": "int64",
8756
8756
  "name": "Limit",
@@ -8775,7 +8775,7 @@
8775
8775
  {
8776
8776
  "disabled": false,
8777
8777
  "document": "返回topic 副本详情",
8778
- "example": "{\"TopicInSyncReplicaList\":[{\"BeginOffset\":0,\"EndOffset\":1,\"InSyncReplica\":\"1\",\"Leader\":1,\"MessageCount\":0,\"OutOfSyncReplica\":\"2\",\"Partition\":\"0\",\"Replica\":\"2,1\"}],\"TotalCount\":1}",
8778
+ "example": "",
8779
8779
  "member": "TopicInSyncReplicaResult",
8780
8780
  "name": "Result",
8781
8781
  "output_required": true,
@@ -11014,7 +11014,7 @@
11014
11014
  {
11015
11015
  "disabled": false,
11016
11016
  "document": "购买实例分区数, 单位个 (购买时必填,专业版/高级版询价时带宽信息必填)\n分区上限 最大值: 40000,步长: 100\n可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563\n",
11017
- "example": "40",
11017
+ "example": "400",
11018
11018
  "member": "int64",
11019
11019
  "name": "Partition",
11020
11020
  "required": false,
@@ -11298,18 +11298,16 @@
11298
11298
  "member": "string",
11299
11299
  "name": "DiskType",
11300
11300
  "required": false,
11301
- "type": "string",
11302
- "value_allowed_null": false
11301
+ "type": "string"
11303
11302
  },
11304
11303
  {
11305
11304
  "disabled": false,
11306
11305
  "document": "购买硬盘大小: 单位GB",
11307
- "example": "1",
11306
+ "example": "400",
11308
11307
  "member": "int64",
11309
11308
  "name": "DiskSize",
11310
11309
  "required": false,
11311
- "type": "int",
11312
- "value_allowed_null": false
11310
+ "type": "int"
11313
11311
  }
11314
11312
  ],
11315
11313
  "usage": "in"
@@ -12490,7 +12488,7 @@
12490
12488
  {
12491
12489
  "disabled": false,
12492
12490
  "document": "分区上限 最大值: 40000, 步长: 100\n可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563\n",
12493
- "example": "60",
12491
+ "example": "400",
12494
12492
  "member": "int64",
12495
12493
  "name": "Partition",
12496
12494
  "required": false,
@@ -13547,7 +13545,7 @@
13547
13545
  {
13548
13546
  "disabled": false,
13549
13547
  "document": "消息保留时间,单位:ms,当前最小值为60000ms。",
13550
- "example": "1000",
13548
+ "example": "360000",
13551
13549
  "member": "int64",
13552
13550
  "name": "RetentionMs",
13553
13551
  "required": true,
@@ -13565,7 +13563,7 @@
13565
13563
  {
13566
13564
  "disabled": false,
13567
13565
  "document": "标签列表",
13568
- "example": "1",
13566
+ "example": "",
13569
13567
  "member": "Tag",
13570
13568
  "name": "Tags",
13571
13569
  "required": false,
@@ -13580,7 +13578,7 @@
13580
13578
  {
13581
13579
  "disabled": false,
13582
13580
  "document": "返回结果集",
13583
- "example": "{\"ReturnCode\":\"0\",\"ReturnMessage\":\"success\"}",
13581
+ "example": "",
13584
13582
  "member": "JgwOperateResponse",
13585
13583
  "name": "Result",
13586
13584
  "output_required": true,
@@ -13601,7 +13599,7 @@
13601
13599
  "members": [
13602
13600
  {
13603
13601
  "disabled": false,
13604
- "document": "ckafka集群实例Id",
13602
+ "document": "ckafka集群实例Id,可通过DescribeInstances接口获取",
13605
13603
  "example": "ckafka-test",
13606
13604
  "member": "string",
13607
13605
  "name": "InstanceId",
@@ -13610,7 +13608,7 @@
13610
13608
  },
13611
13609
  {
13612
13610
  "disabled": false,
13613
- "document": "消费分组名称",
13611
+ "document": "消费分组名称,可通过DescribeConsumerGroup接口获取",
13614
13612
  "example": "group-test",
13615
13613
  "member": "string",
13616
13614
  "name": "Group",
@@ -13619,7 +13617,7 @@
13619
13617
  },
13620
13618
  {
13621
13619
  "disabled": false,
13622
- "document": "重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置",
13620
+ "document": "重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置",
13623
13621
  "example": "1",
13624
13622
  "member": "int64",
13625
13623
  "name": "Strategy",
@@ -13628,7 +13626,7 @@
13628
13626
  },
13629
13627
  {
13630
13628
  "disabled": false,
13631
- "document": "需要重置的主题名列表, 不填表示全部",
13629
+ "document": "需要重置的主题名列表",
13632
13630
  "example": "[\"topic-test\"]",
13633
13631
  "member": "string",
13634
13632
  "name": "Topics",
@@ -13646,7 +13644,7 @@
13646
13644
  },
13647
13645
  {
13648
13646
  "disabled": false,
13649
- "document": "单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的时,如果指定的时间不存在消息,则获取最末尾的offset。",
13647
+ "document": "单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的是,如果指定的时间不存在消息,则获取最末尾的offset。",
13650
13648
  "example": "13589015901000",
13651
13649
  "member": "int64",
13652
13650
  "name": "ShiftTimestamp",
@@ -13680,7 +13678,7 @@
13680
13678
  {
13681
13679
  "disabled": false,
13682
13680
  "document": "返回结果",
13683
- "example": "{\"Data\":null,\"ReturnCode\":\"0\",\"ReturnMessage\":\"SUCCESS\"}",
13681
+ "example": "",
13684
13682
  "member": "JgwOperateResponse",
13685
13683
  "name": "Result",
13686
13684
  "output_required": true,
@@ -13889,7 +13887,7 @@
13889
13887
  {
13890
13888
  "disabled": false,
13891
13889
  "document": "分区上限 最大值: 40000, 步长: 100\n可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563",
13892
- "example": "100",
13890
+ "example": "400",
13893
13891
  "member": "int64",
13894
13892
  "name": "Partition",
13895
13893
  "required": false,
@@ -14188,7 +14186,7 @@
14188
14186
  },
14189
14187
  {
14190
14188
  "disabled": false,
14191
- "document": "Segment 分片滚动的时长,单位:ms,当前最小为300000ms。",
14189
+ "document": "Segment 分片滚动的时长,单位:ms,当前最小值86400000ms。",
14192
14190
  "example": "86400000",
14193
14191
  "member": "int64",
14194
14192
  "name": "SegmentMs",
@@ -14243,7 +14241,7 @@
14243
14241
  {
14244
14242
  "disabled": false,
14245
14243
  "document": "标签列表",
14246
- "example": "[{\"TagKey\":\"tagkey-test\",\"TagValue\":\"tagvalue-test\"}]",
14244
+ "example": "",
14247
14245
  "member": "Tag",
14248
14246
  "name": "Tags",
14249
14247
  "required": false,
@@ -14285,7 +14283,7 @@
14285
14283
  {
14286
14284
  "disabled": false,
14287
14285
  "document": "返回结果",
14288
- "example": "{\"Data\":null,\"ReturnCode\":\"0\",\"ReturnMessage\":\"ok[apply success]\"}",
14286
+ "example": "",
14289
14287
  "member": "JgwOperateResponse",
14290
14288
  "name": "Result",
14291
14289
  "output_required": true,
@@ -17384,8 +17382,8 @@
17384
17382
  },
17385
17383
  {
17386
17384
  "disabled": false,
17387
- "document": "创建时间",
17388
- "example": "2021-7-26 4:16:58",
17385
+ "document": "创建时间的秒级时间戳",
17386
+ "example": "1753056925",
17389
17387
  "member": "int64",
17390
17388
  "name": "CreateTime",
17391
17389
  "output_required": true,
@@ -17435,7 +17433,7 @@
17435
17433
  {
17436
17434
  "disabled": false,
17437
17435
  "document": "topic 配置数组",
17438
- "example": "{\"Retention\":86400000,\"MinInsyncReplicas\":1,\"CleanUpPolicy\":\"delete\",\"SegmentMs\":null,\"UncleanLeaderElectionEnable\":1,\"SegmentBytes\":null,\"MaxMessageBytes\":8388608,\"RetentionBytes\":null}",
17436
+ "example": "",
17439
17437
  "member": "Config",
17440
17438
  "name": "Config",
17441
17439
  "output_required": true,
@@ -17445,7 +17443,7 @@
17445
17443
  {
17446
17444
  "disabled": false,
17447
17445
  "document": "分区详情",
17448
- "example": "[{\"Partition\":0,\"LeaderStatus\":0,\"IsrNum\":2,\"ReplicaNum\":2}]",
17446
+ "example": "",
17449
17447
  "member": "TopicPartitionDO",
17450
17448
  "name": "Partitions",
17451
17449
  "output_required": true,
@@ -17475,7 +17473,7 @@
17475
17473
  {
17476
17474
  "disabled": false,
17477
17475
  "document": "topic 限流策略",
17478
- "example": "{\"QuotaProducerByteRate\":30,\"QuotaConsumerByteRate\":30}",
17476
+ "example": "",
17479
17477
  "member": "InstanceQuotaConfigResp",
17480
17478
  "name": "QuotaConfig",
17481
17479
  "output_required": true,