tccli 3.0.1389.1__py2.py3-none-any.whl → 3.0.1391.1__py2.py3-none-any.whl

tccli/services/cls/v20201016/api.json

@@ -469,6 +469,20 @@
       "output": "DescribeKafkaConsumerResponse",
       "status": "online"
     },
+    "DescribeKafkaConsumerGroupDetail": {
+      "document": "获取Kafka协议消费组详情",
+      "input": "DescribeKafkaConsumerGroupDetailRequest",
+      "name": "获取Kafka协议消费组详情",
+      "output": "DescribeKafkaConsumerGroupDetailResponse",
+      "status": "online"
+    },
+    "DescribeKafkaConsumerGroupList": {
+      "document": "获取Kafka协议消费组信息列表",
+      "input": "DescribeKafkaConsumerGroupListRequest",
+      "name": "获取Kafka协议消费组列表",
+      "output": "DescribeKafkaConsumerGroupListResponse",
+      "status": "online"
+    },
     "DescribeKafkaRecharges": {
       "document": "本接口用于获取Kafka数据订阅任务",
       "input": "DescribeKafkaRechargesRequest",
@@ -672,6 +686,13 @@
       "output": "ModifyKafkaConsumerResponse",
       "status": "online"
     },
+    "ModifyKafkaConsumerGroupOffset": {
+      "document": "修改Kafka协议消费组点位",
+      "input": "ModifyKafkaConsumerGroupOffsetRequest",
+      "name": "修改Kafka协议消费组点位",
+      "output": "ModifyKafkaConsumerGroupOffsetResponse",
+      "status": "online"
+    },
     "ModifyKafkaRecharge": {
       "document": "本接口用于修改Kafka数据订阅任务",
       "input": "ModifyKafkaRechargeRequest",
@@ -3104,6 +3125,42 @@
       ],
       "usage": "both"
     },
+    "ConsumerGroup": {
+      "document": "kafka协议消费组信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "消费组名称",
+          "example": "消费组1",
+          "member": "string",
+          "name": "Group",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "状态。\n\n- Empty：组内没有成员，但存在已提交的偏移量。所有消费者都离开但保留了偏移量\n- Dead：组内没有成员，且没有已提交的偏移量。组被删除或长时间无活动\n- Stable：组内成员正常消费，分区分配平衡。正常运行状态\n- PreparingRebalance：组正在准备重新平衡。有新成员加入或现有成员离开\n- CompletingRebalance：组正在准备重新平衡。有新成员加入或现有成员离开\n",
+          "example": "Empty",
+          "member": "string",
+          "name": "State",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "分区分配策略均衡算法名称。\n\n- 常见均衡算法如下：\n    - range:按分区范围分配\n    - roundrobin:轮询式分配\n    - sticky:粘性分配（避免不必要的重平衡）",
+          "example": "roundrobin",
+          "member": "string",
+          "name": "ProtocolName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "ContainerFileInfo": {
       "document": "自建k8s-容器文件路径信息",
       "members": [
@@ -5240,7 +5297,7 @@
         },
         {
           "disabled": false,
-          "document": "日志集ID，格式为：用户自定义部分-用户appid，用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符，尾部需要使用-拼接用户appid",
+          "document": "日志集ID，格式为：用户自定义部分-用户APPID。未填写该参数时将自动生成ID。\n\n- 用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符。\n- 尾部需要使用-拼接用户APPID，APPID可在https://console.cloud.tencent.com/developer页面查询。\n- 如果指定该字段，需保证全地域唯一",
           "example": "user-diy-1254139626",
           "member": "string",
           "name": "LogsetId",
@@ -5839,7 +5896,7 @@
         },
         {
           "disabled": false,
-          "document": "主题自定义ID，格式为：用户自定义部分-APPID。未填写该参数时将自动生成ID。\n- 用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符\n- APPID可在https://console.cloud.tencent.com/developer页面查询",
+          "document": "主题自定义ID，格式为：用户自定义部分-用户APPID。未填写该参数时将自动生成ID。\n- 用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符\n- 尾部需要使用-拼接用户APPID，APPID可在https://console.cloud.tencent.com/developer页面查询。\n- 如果指定该字段，需保证全地域唯一",
           "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
           "member": "string",
           "name": "TopicId",
@@ -8451,6 +8508,176 @@
       ],
       "type": "object"
     },
+    "DescribeKafkaConsumerGroupDetailRequest": {
+      "document": "DescribeKafkaConsumerGroupDetail请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "日志主题id。\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
+          "example": "57f5808c-4a55-11eb-b378-0242ac130002",
+          "member": "string",
+          "name": "TopicId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "消费组名称",
+          "example": "消费组1",
+          "member": "string",
+          "name": "Group",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeKafkaConsumerGroupDetailResponse": {
+      "document": "DescribeKafkaConsumerGroupDetail返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "日志集id",
+          "example": "57f5808c-4a55-11eb-b378-0242ac130223",
+          "member": "string",
+          "name": "LogsetId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "消费组名称",
+          "example": "消费组1",
+          "member": "string",
+          "name": "Group",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "消费组信息列表",
+          "example": "无",
+          "member": "GroupPartitionInfo",
+          "name": "PartitionInfos",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Empty：组内没有成员，但存在已提交的偏移量。所有消费者都离开但保留了偏移量\nDead：组内没有成员，且没有已提交的偏移量。组被删除或长时间无活动\nStable：组内成员正常消费，分区分配平衡。正常运行状态\nPreparingRebalance：组正在准备重新平衡。有新成员加入或现有成员离开\nCompletingRebalance：组正在准备重新平衡。有新成员加入或现有成员离开",
+          "example": "Empty",
+          "member": "string",
+          "name": "State",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeKafkaConsumerGroupListRequest": {
+      "document": "DescribeKafkaConsumerGroupList请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "日志主题id。\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
+          "example": "57f5808c-4a55-11eb-b378-0242ac130002",
+          "member": "string",
+          "name": "TopicId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "- group\n按照【消费组名称】进行过滤。\n类型：String\n必选：否\n示例：消费组1\n\n每次请求的Filters的上限为10，Filter.Values的上限为10。",
+          "example": "无",
+          "member": "Filter",
+          "name": "Filters",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "分页的偏移量，默认值为0。",
+          "example": "0",
+          "member": "uint64",
+          "name": "Offset",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "分页单页限制数目，默认值为20，最大值100。",
+          "example": "10",
+          "member": "uint64",
+          "name": "Limit",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeKafkaConsumerGroupListResponse": {
+      "document": "DescribeKafkaConsumerGroupList返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "日志主题名称",
+          "example": "日志a主题",
+          "member": "string",
+          "name": "TopicName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "日志集id",
+          "example": "57f5808c-4a55-11eb-b378-0242ac130223",
+          "member": "string",
+          "name": "LogsetId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "总个数",
+          "example": "1",
+          "member": "uint64",
+          "name": "Total",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "消费组信息列表",
+          "example": "无",
+          "member": "ConsumerGroup",
+          "name": "Groups",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeKafkaConsumerRequest": {
       "document": "DescribeKafkaConsumer请求参数结构体",
       "members": [
@@ -10402,6 +10629,42 @@
       ],
       "type": "object"
     },
+    "GroupPartitionInfo": {
+      "document": "kafka协议消费组区分信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "分区id",
+          "example": "1",
+          "member": "int64",
+          "name": "PartitionId",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "分区最新数据时间戳，单位：s",
+          "example": "2",
+          "member": "int64",
+          "name": "CommitTimestamp",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "消费者",
+          "example": "app_as",
+          "member": "string",
+          "name": "Consumer",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "GroupTriggerConditionInfo": {
       "document": "分组触发条件",
       "members": [
@@ -12935,6 +13198,33 @@
       ],
       "type": "object"
     },
+    "ModifyKafkaConsumerGroupOffsetRequest": {
+      "document": "ModifyKafkaConsumerGroupOffset请求参数结构体",
+      "members": [],
+      "type": "object"
+    },
+    "ModifyKafkaConsumerGroupOffsetResponse": {
+      "document": "ModifyKafkaConsumerGroupOffset返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "状态码。0：成功，-1：失败",
+          "example": "0",
+          "member": "int64",
+          "name": "Code",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "ModifyKafkaConsumerRequest": {
       "document": "ModifyKafkaConsumer请求参数结构体",
       "members": [

tccli/services/cls/v20201016/examples.json

@@ -572,6 +572,22 @@
         "title": "获取Kakfa协议消费信息"
       }
     ],
+    "DescribeKafkaConsumerGroupDetail": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKafkaConsumerGroupDetail\n<公共请求参数>\n\n{\n    \"TopicId\": \"5023192e-1254139626\",\n    \"Group\": \"same_group_id\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Group\": \"same_group_id\",\n        \"LogsetId\": \"a8248746-c989-468e-b931-a9bf6c999c89\",\n        \"PartitionInfos\": [\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 0\n            },\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 1\n            },\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 2\n            },\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 3\n            },\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 4\n            },\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 5\n            },\n            {\n                \"CommitTimestamp\": 3223609680,\n                \"Consumer\": \"\",\n                \"PartitionId\": 6\n            }\n        ],\n        \"RequestId\": \"b4a11979-760c-42e2-92b8-5945eb93ee98\",\n        \"State\": \"Empty\"\n    }\n}",
+        "title": "获取Kafka协议消费组详情"
+      }
+    ],
+    "DescribeKafkaConsumerGroupList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKafkaConsumerGroupList\n<公共请求参数>\n\n{\n    \"TopicId\": \"5023192e-1254139626\",\n    \"Offset\": 0,\n    \"Limit\": 1\n}",
+        "output": "{\n    \"Response\": {\n        \"Groups\": [\n            {\n                \"Group\": \"same_group_id\",\n                \"ProtocolName\": \"\",\n                \"State\": \"Empty\"\n            }\n        ],\n        \"LogsetId\": \"a8248746-c989-468e-b931-a9bf6c999c89\",\n        \"RequestId\": \"53ac1397-336a-4d4b-87ff-a2a16ff97519\",\n        \"TopicName\": \"1254139626-5023192e\",\n        \"Total\": 2\n    }\n}",
+        "title": "获取Kafka协议消费组详情"
+      }
+    ],
     "DescribeKafkaRecharges": [
       {
         "document": "获取Kafka导入配置信息",
@@ -816,6 +832,14 @@
         "title": "修改Kafka协议消费信息"
       }
     ],
+    "ModifyKafkaConsumerGroupOffset": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyKafkaConsumerGroupOffset\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"Code\": 0,\n        \"RequestId\": \"c3ae291d-8ffd-4a26-b5ae-00b6863cdf44\"\n    }\n}",
+        "title": "修改Kafka协议消费组点位"
+      }
+    ],
     "ModifyKafkaRecharge": [
       {
         "document": "修改Kafka导入配置",

tccli/services/dts/v20211206/api.json

@@ -1564,7 +1564,7 @@
         },
         {
           "disabled": false,
-          "document": "源端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。",
+          "document": "源端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。",
           "example": "无",
           "member": "SyncDBEndpointInfos",
           "name": "SrcInfos",
@@ -1591,7 +1591,7 @@
         },
         {
           "disabled": false,
-          "document": "目标端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。",
+          "document": "目标端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。",
           "example": "无",
           "member": "SyncDBEndpointInfos",
           "name": "DstInfos",
@@ -6818,7 +6818,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "投递到kafka的数据类型，如Avro,Json,canal-pb,canal-json",
+          "document": "投递到kafka的数据类型，如Avro,Json,canal-pb,canal-json,debezium",
           "example": "Avro,Json",
           "member": "string",
           "name": "DataType",
@@ -7066,14 +7066,14 @@
         },
         {
           "disabled": false,
-          "document": "数据一致性校验选项， 默认为不开启一致性校验",
+          "document": "数据一致性校验选项， 默认为不开启一致性校验\n注意：此字段可能返回 null，表示取不到有效值。",
           "example": "无",
           "member": "ConsistencyOption",
           "name": "Consistency",
-          "output_required": true,
+          "output_required": false,
           "required": false,
           "type": "object",
-          "value_allowed_null": false
+          "value_allowed_null": true
         },
         {
           "disabled": false,
@@ -7110,7 +7110,7 @@
         },
         {
           "disabled": false,
-          "document": "其他附加信息，对于特定库可设置额外参数，Redis可定义如下的参数: \n[\"DstWriteMode\":normal, \t目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样，不做额外动作) \t\"IsDstReadOnly\":true, \t是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) \t\"ClientOutputBufferHardLimit\":512, \t从机缓冲区的硬性容量限制(MB) \t\"ClientOutputBufferSoftLimit\":512, \t从机缓冲区的软性容量限制(MB) \t\"ClientOutputBufferPersistTime\":60, 从机缓冲区的软性限制持续时间(秒) \t\"ReplBacklogSize\":512, \t环形缓冲区容量限制(MB) \t\"ReplTimeout\":120，\t\t复制超时时间(秒) \t\"IsExpireKey\":\"true\",过期key自动淘汰]",
+          "document": "其他附加信息，对于特定库可设置额外参数，Redis可定义如下的参数: \n[\"DstWriteMode\":normal, \t目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(要求目标端为空，否则校验不通过) ，不显示指定默认以覆盖写的方式执行任务\t\"IsDstReadOnly\":true, \t是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) \t\"ClientOutputBufferHardLimit\":512, \t从机缓冲区的硬性容量限制(MB) \t\"ClientOutputBufferSoftLimit\":512, \t从机缓冲区的软性容量限制(MB) \t\"ClientOutputBufferPersistTime\":60, 从机缓冲区的软性限制持续时间(秒) \t\"ReplBacklogSize\":512, \t环形缓冲区容量限制(MB) \t\"ReplTimeout\":120，\t\t复制超时时间(秒) \t\"IsExpireKey\":\"true\",过期key自动淘汰]",
           "example": "无",
           "member": "KeyValuePairOption",
           "name": "ExtraAttr",
@@ -8081,7 +8081,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)",
+          "document": "同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。",
           "example": "Full",
           "member": "string",
           "name": "InitType",
@@ -8137,7 +8137,7 @@
         {
           "disabled": false,
           "document": "冲突处理的详细选项，如条件覆盖中的条件行和条件操作",
-          "example": "ConflictHandleOption",
+          "example": "无",
           "member": "ConflictHandleOption",
           "name": "ConflictHandleOption",
           "output_required": true,
@@ -8148,7 +8148,7 @@
         {
           "disabled": false,
           "document": "DDL同步选项，具体描述要同步哪些DDL\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "DdlOption",
+          "example": "无",
           "member": "DdlOption",
           "name": "DdlOptions",
           "output_required": true,
@@ -8159,7 +8159,7 @@
         {
           "disabled": false,
           "document": "kafka同步选项",
-          "example": "KafkaOption",
+          "example": "无",
           "member": "KafkaOption",
           "name": "KafkaOption",
           "output_required": true,
@@ -8170,7 +8170,7 @@
         {
           "disabled": false,
           "document": "任务限速信息",
-          "example": "RateLimitOption",
+          "example": "无",
           "member": "RateLimitOption",
           "name": "RateLimitOption",
           "output_required": true,
@@ -10253,7 +10253,7 @@
         {
           "disabled": false,
           "document": "支持的所有操作",
-          "example": "[\"pause\",\"stop\",\"limitRate\",\"view\",\"resize\",\"isolate\",\"postPay2prePay\",\"configureOptObj\"]",
+          "example": "[\"pause\",\"stop\",\"limitRate\",\"view\",\"resize\",\"isolate\",\"postPay2prePay\",\"configureOptObj\",\"modifyPosition\"]",
           "member": "string",
           "name": "AllActions",
           "output_required": true,
@@ -10362,7 +10362,7 @@
         },
         {
           "disabled": false,
-          "document": "源端信息，多节点数据库使用",
+          "document": "源端信息，若SrcNodeType=cluster，则源端信息在这个字段里，mongodb链路使用此参数透传。",
           "example": "无",
           "member": "SyncDBEndpointInfos",
           "name": "SrcInfos",
@@ -10422,7 +10422,7 @@
         },
         {
           "disabled": false,
-          "document": "目标端信息，多节点数据库使用",
+          "document": "目标端信息，若SrcNodeType=cluster，则源端信息在这个字段里，mongodb链路使用此参数透传。",
           "example": "无",
           "member": "SyncDBEndpointInfos",
           "name": "DstInfos",

tccli/services/dts/v20211206/examples.json

@@ -416,7 +416,7 @@
       {
         "document": "修改任务全量导出线程数成功",
         "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifySyncRateLimit\n<公共请求参数>\n\n{\n    \"JobId\": \"sync-asasdasa\",\n    \"DumpThread\": 12,\n    \"DumpRps\": 0,\n    \"LoadThread\": 0,\n    \"SinkerThread\": 0,\n    \"LoadRps\": 0\n}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"abc\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"be20a600-66e5-11f0-b22f-efb8dc978dd0\"\n    }\n}",
         "title": "修改任务全量导出线程数"
       }
     ],