tccli 3.0.1300.3__py2.py3-none-any.whl → 3.0.1302.1__py2.py3-none-any.whl

tccli/services/trocket/v20230308/examples.json

@@ -1,5 +1,13 @@
 {
   "actions": {
+    "ChangeMigratingTopicToNextStage": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChangeMigratingTopicToNextStage\n<公共请求参数>\n\n{\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n    \"TopicNameList\": [\n        \"TopicTest\"\n    ],\n    \"NamespaceList\": []\n}",
+        "output": "{\n    \"Response\": {\n        \"Results\": [\n            {\n                \"TopicName\": \"TopicTest\",\n                \"Success\": true,\n                \"Namespace\": \"\"\n            }\n        ],\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "修改迁移主题进入下一个迁移阶段"
+      }
+    ],
     "CreateConsumerGroup": [
       {
         "document": "创建消费组成功",
@@ -120,6 +128,14 @@
         "title": "删除角色"
       }
     ],
+    "DeleteSmoothMigrationTask": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteSmoothMigrationTask\n<公共请求参数>\n\n{\n    \"TaskId\": \"taskid-123\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"requestId\"\n    }\n}",
+        "title": "删除平滑迁移任务"
+      }
+    ],
     "DeleteTopic": [
       {
         "document": "删除主题",
@@ -310,6 +326,30 @@
         "title": "查询延迟消息的轨迹"
       }
     ],
+    "DescribeMigratingGroupStats": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingGroupStats\n<公共请求参数>\n\n{\n    \"TaskId\": \"taskId\",\n    \"GroupName\": \"group-a\",\n    \"Namespace\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"SourceConsumeLag\": 0,\n        \"TargetConsumeLag\": 0,\n        \"SourceConsumerClients\": [\n            {\n                \"ClientId\": \"client-a\",\n                \"ClientAddr\": \"1.1.1.1\",\n                \"Language\": \"JAVA\",\n                \"Version\": \"5\",\n                \"ConsumerLag\": 0\n            }\n        ],\n        \"TargetConsumerClients\": [\n            {\n                \"ClientId\": \"client-b\",\n                \"ClientAddr\": \"2.2.2.2\",\n                \"Language\": \"JAVA\",\n                \"Version\": \"5.0\",\n                \"ConsumerLag\": 0\n            }\n        ],\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "查看迁移消费组的实时信息"
+      }
+    ],
+    "DescribeMigratingTopicList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicList\n<公共请求参数>\n\n{\n    \"Filters\": [],\n    \"Offset\": 0,\n    \"Limit\": 10,\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 10,\n        \"MigrateTopics\": [\n            {\n                \"TopicName\": \"topic-a\",\n                \"MigrationStatus\": \"S_RW_D_NA\",\n                \"HealthCheckPassed\": true,\n                \"HealthCheckError\": \"\",\n                \"Namespace\": \"\"\n            }\n        ],\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "查询迁移主题列表"
+      }
+    ],
+    "DescribeMigratingTopicStats": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicStats\n<公共请求参数>\n\n{\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n    \"TopicName\": \"TopicTest\",\n    \"Namespace\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"SourceClusterConsumerCount\": 0,\n        \"TargetClusterConsumerCount\": 0,\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "查询迁移主题实时数据"
+      }
+    ],
     "DescribeProductSKUs": [
       {
         "document": "获取产品规格信息",
@@ -326,6 +366,14 @@
         "title": "查询角色列表"
       }
     ],
+    "DescribeSourceClusterGroupList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSourceClusterGroupList\n<公共请求参数>\n\n{\n    \"Filters\": [],\n    \"Offset\": 0,\n    \"Limit\": 10,\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 10,\n        \"Groups\": [\n            {\n                \"GroupName\": \"Test\",\n                \"Remark\": \"remark\",\n                \"Imported\": true,\n                \"Namespace\": \"\",\n                \"ImportStatus\": \"Success\"\n            }\n        ],\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "查询源集群消费组列表"
+      }
+    ],
     "DescribeTopic": [
       {
         "document": "查询主题详情",
@@ -350,6 +398,14 @@
         "title": "查询消费组订阅的主题列表"
       }
     ],
+    "DoHealthCheckOnMigratingTopic": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DoHealthCheckOnMigratingTopic\n<公共请求参数>\n\n{\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n    \"TopicName\": \"Test\",\n    \"IgnoreCheck\": true,\n    \"Namespace\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Passed\": true,\n        \"Reason\": \"\",\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "迁移主题安全检查"
+      }
+    ],
     "ImportSourceClusterConsumerGroups": [
       {
         "document": "",
@@ -446,6 +502,14 @@
         "title": "修改主题属性"
       }
     ],
+    "RemoveMigratingTopic": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RemoveMigratingTopic\n<公共请求参数>\n\n{\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n    \"Namespace\": \"\",\n    \"TopicName\": \"topic-a\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "将主题移出迁移任务"
+      }
+    ],
     "ResendDeadLetterMessage": [
       {
         "document": "",
@@ -461,6 +525,14 @@
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"707a78e5-019d-41f6-80fc-15743d99c81a\"\n    }\n}",
         "title": "重置消费位点"
       }
+    ],
+    "RollbackMigratingTopicStage": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollbackMigratingTopicStage\n<公共请求参数>\n\n{\n    \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n    \"TopicName\": \"TopicTest\",\n    \"Namespace\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n    }\n}",
+        "title": "回滚迁移主题的切流状态"
+      }
     ]
   },
   "version": "1.0"

tccli/services/trtc/v20190722/api.json

@@ -288,7 +288,7 @@
       "status": "online"
     },
     "StartAITranscription": {
-      "document": "启动转录机器人，后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。\n转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：\n- 拉取全房间的流。\n- 拉取特定用户的流。\n\n服务端通过TRTC的自定义消息实时下发字幕以及转录消息，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。其他客户端比如安卓、Web等同样可在该链接处找到。",
+      "document": "启动转录机器人，后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。\n转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：\n- 拉取全房间的流。\n- 拉取特定用户的流。\n\n服务端通过TRTC的自定义消息实时下发字幕以及转录消息，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。其他客户端比如安卓、Web等同样可在该链接处找到。\n\n\n**注意：**\nTranscriptionMode为0时，需要保证一个房间内只发起一个任务，如果发起多个任务，则机器人之间会相互订阅，除非主动停止任务，否则只有10小时后任务才会超时退出，这种情况下建议填写SessionId，保证后续重复发起的任务失败。",
       "input": "StartAITranscriptionRequest",
       "name": "开始AI转录任务",
       "output": "StartAITranscriptionResponse",
@@ -3359,7 +3359,7 @@
         {
           "disabled": false,
           "document": "TRTC的SDKAppId。",
-          "example": "1400188366",
+          "example": "1400***366",
           "member": "uint64",
           "name": "SdkAppId",
           "required": true,
@@ -5664,7 +5664,7 @@
         {
           "disabled": false,
           "document": "TRTC的SDKAppId。",
-          "example": "1400000001",
+          "example": "1400***366",
           "member": "uint64",
           "name": "SdkAppId",
           "required": true,
@@ -6310,7 +6310,7 @@
         },
         {
           "disabled": false,
-          "document": "调用方传入的唯一Id，服务端用来去重。\n注意：\n如果传入该参数，服务端优先使用该参数来去重。\n如果不传该参数，服务端的去重策略如下：\n- 如果TranscriptionMode字段是0，则一个房间只能开启一个任务\n- 如果TranscriptionMode字段是1，则一个TargetUserId只能开启一个任务",
+          "document": "调用方传入的唯一Id，服务端用来任务去重，重复的任务会发起失败。服务端固定使用SdkAppId+RoomId+RoomIdType+RobotUserId来去重，如果传入了SessionId，也会使用SessionId去重。\n注意：\nTranscriptionMode为0时，需要保证一个房间内只发起一个任务，如果发起多个任务，则机器人之间会相互订阅，除非主动停止任务，否则只有10小时后任务才会超时退出，这种情况下建议填写SessionId，保证后续重复发起的任务失败。",
           "example": "无",
           "member": "string",
           "name": "SessionId",
@@ -6972,7 +6972,7 @@
         {
           "disabled": false,
           "document": "TRTC的SDKAppId。",
-          "example": "",
+          "example": "1400***366",
           "member": "uint64",
           "name": "SdkAppId",
           "required": true,
@@ -6981,7 +6981,7 @@
         {
           "disabled": false,
           "document": "字符串房间号。",
-          "example": "",
+          "example": "room_1001",
           "member": "string",
           "name": "StrRoomId",
           "required": true,
@@ -8292,8 +8292,7 @@
           "member": "uint64",
           "name": "WaterMarkId",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -8302,8 +8301,7 @@
           "member": "uint64",
           "name": "WaterMarkWidth",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -8312,8 +8310,7 @@
           "member": "uint64",
           "name": "WaterMarkHeight",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -8322,8 +8319,7 @@
           "member": "uint64",
           "name": "LocationX",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -8332,18 +8328,16 @@
           "member": "uint64",
           "name": "LocationY",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
           "document": "混流-水印图片URL地址，支持png、jpg、jpeg、bmp格式，暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时，以WaterMarkUrl为准。图片大小限制不超过2MB。",
-          "example": "xxx",
+          "example": "https://**.png",
           "member": "string",
           "name": "WaterMarkUrl",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         }
       ],
       "usage": "in"

tccli/services/trtc/v20190722/examples.json

@@ -274,8 +274,8 @@
     ],
     "DismissRoom": [
       {
-        "document": "解散房间1234。",
-        "input": "https://trtc.tencentcloudapi.com/?Action=DismissRoom\n&SdkAppId=1400000001\n&RoomId=1234\n&<公共请求参数>",
+        "document": "解散房间1001。",
+        "input": "https://trtc.tencentcloudapi.com/?Action=DismissRoom\n&SdkAppId=1400000001\n&RoomId=1001\n&<公共请求参数>",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n    }\n}",
         "title": "解散房间"
       }
@@ -306,8 +306,8 @@
     ],
     "RemoveUser": [
       {
-        "document": "将用户test1、test2从房间1234移出。",
-        "input": "https://trtc.tencentcloudapi.com/?Action=RemoveUser\n&SdkAppId=1400000001\n&RoomId=1234\n&UserIds.0=test1\n&UserIds.1=test2\n&<公共请求参数>",
+        "document": "将用户user_1、user_2从房间1001移出。",
+        "input": "https://trtc.tencentcloudapi.com/?Action=RemoveUser\n&SdkAppId=1400000001\n&RoomId=1001\n&UserIds.0=user_1\n&UserIds.1=user_2\n&<公共请求参数>",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n    }\n}",
         "title": "移出用户"
       }
@@ -331,8 +331,8 @@
     "StartAITranscription": [
       {
         "document": "",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartAITranscription\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1234,\n    \"RoomId\": \"1234\",\n    \"RoomIdType\": 1,\n    \"TranscriptionParams\": {\n        \"UserId\": \"abc\",\n        \"UserSig\": \"abc\",\n        \"IMAdminUserId\": \"abc\",\n        \"IMAdminUserSig\": \"abc\",\n        \"MaxIdleTime\": 60,\n        \"TranscriptionMode\": 1,\n        \"TargetUserId\": \"abc\"\n    }\n}",
-        "output": "{\n    \"Response\": {\n        \"TaskId\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartAITranscription\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1234,\n    \"RoomId\": \"500123\",\n    \"RoomIdType\": 1,\n    \"TranscriptionParams\": {\n        \"UserId\": \"test_user\",\n        \"UserSig\": \"your-usersig\",\n        \"MaxIdleTime\": 60,\n        \"TranscriptionMode\": 1,\n        \"TargetUserId\": \"test_user\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"TaskId\": \"taskid\",\n        \"RequestId\": \"requestid\"\n    }\n}",
         "title": "样例"
       }
     ],
@@ -432,8 +432,8 @@
     ],
     "StopMCUMixTranscodeByStrRoomId": [
       {
-        "document": "结束字符串房间号为Room_3560的云端混流。",
-        "input": "https://trtc.tencentcloudapi.com/?Action=StopMCUMixTranscodeByStrRoomId\n&SdkAppId=1400188366\n&StrRoomId=Room_3560\n&<公共请求参数>",
+        "document": "结束字符串房间号为room_1001的云端混流。",
+        "input": "https://trtc.tencentcloudapi.com/?Action=StopMCUMixTranscodeByStrRoomId\n&SdkAppId=1400000001\n&StrRoomId=room_1001\n&<公共请求参数>",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n    }\n}",
         "title": "结束云端混流"
       }