tccli 3.0.1084.1__py2.py3-none-any.whl → 3.0.1085.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (199) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/aiart/v20221229/QueryTextToImageProJob.md +30 -0
  3. tccli/examples/aiart/v20221229/SubmitTextToImageProJob.md +22 -0
  4. tccli/examples/billing/v20180709/DescribeCostDetail.md +36 -33
  5. tccli/examples/billing/v20180709/DescribeCostSummaryByProject.md +25 -80
  6. tccli/examples/billing/v20180709/DescribeCostSummaryByRegion.md +23 -14
  7. tccli/examples/billing/v20180709/DescribeCostSummaryByResource.md +53 -27
  8. tccli/examples/ccc/v20200210/CreateCompanyApply.md +36 -0
  9. tccli/examples/ccc/v20200210/DescribeCompanyList.md +33 -0
  10. tccli/examples/ccc/v20200210/ModifyCompanyApply.md +36 -0
  11. tccli/examples/ckafka/v20190819/CreateInstancePost.md +9 -6
  12. tccli/examples/ckafka/v20190819/CreatePrometheus.md +29 -0
  13. tccli/examples/ckafka/v20190819/DescribePrometheus.md +25 -0
  14. tccli/examples/cynosdb/v20190107/RollbackToNewCluster.md +62 -0
  15. tccli/examples/dlc/v20210125/QueryTaskCostDetail.md +20 -0
  16. tccli/examples/essbasic/v20210526/ChannelCreateReleaseFlow.md +1 -1
  17. tccli/examples/faceid/v20180301/GetFaceIdResult.md +4 -4
  18. tccli/examples/iotexplorer/v20190423/BindCloudStorageUser.md +22 -0
  19. tccli/examples/iotexplorer/v20190423/CreateIotVideoCloudStorage.md +22 -0
  20. tccli/examples/iotexplorer/v20190423/DeleteCloudStorageEvent.md +26 -0
  21. tccli/examples/iotexplorer/v20190423/DescribeCloudStorage.md +27 -0
  22. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageDate.md +24 -0
  23. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageEvents.md +87 -0
  24. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageMultiThumbnail.md +28 -0
  25. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageOrder.md +25 -0
  26. tccli/examples/iotexplorer/v20190423/DescribeCloudStoragePackageConsumeDetails.md +21 -0
  27. tccli/examples/iotexplorer/v20190423/DescribeCloudStoragePackageConsumeStats.md +44 -0
  28. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageStreamData.md +24 -0
  29. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageThumbnail.md +24 -0
  30. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageThumbnailList.md +28 -0
  31. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageTime.md +43 -0
  32. tccli/examples/iotexplorer/v20190423/DescribeCloudStorageUsers.md +29 -0
  33. tccli/examples/iotexplorer/v20190423/DescribeDevicePackages.md +37 -0
  34. tccli/examples/iotexplorer/v20190423/DescribePackageConsumeTask.md +21 -0
  35. tccli/examples/iotexplorer/v20190423/DescribePackageConsumeTasks.md +39 -0
  36. tccli/examples/iotexplorer/v20190423/GenerateSignedVideoURL.md +22 -0
  37. tccli/examples/iotexplorer/v20190423/InheritCloudStorageUser.md +23 -0
  38. tccli/examples/iotexplorer/v20190423/ResetCloudStorage.md +21 -0
  39. tccli/examples/iotexplorer/v20190423/ResetCloudStorageEvent.md +22 -0
  40. tccli/examples/iotexplorer/v20190423/TransferCloudStorage.md +22 -0
  41. tccli/examples/monitor/v20180724/CreateExporterIntegration.md +626 -2
  42. tccli/examples/ocr/v20181119/ReconstructDocument.md +2263 -0
  43. tccli/examples/pts/v20210728/CreateEnvironment.md +18 -0
  44. tccli/examples/pts/v20210728/DeleteEnvironments.md +18 -0
  45. tccli/examples/pts/v20210728/DescribeEnvironments.md +18 -0
  46. tccli/examples/pts/v20210728/UpdateEnvironment.md +18 -0
  47. tccli/examples/ssl/v20191205/UploadCertificate.md +48 -3
  48. tccli/examples/tag/v20180813/DescribeProjects.md +1 -1
  49. tccli/examples/tione/v20211111/CreateModelService.md +3 -1
  50. tccli/examples/tione/v20211111/ModifyModelService.md +62 -228
  51. tccli/examples/wedata/v20210820/BatchCreateIntegrationTaskAlarms.md +11 -11
  52. tccli/examples/wedata/v20210820/BatchForceSuccessIntegrationTaskInstances.md +2 -2
  53. tccli/examples/wedata/v20210820/BatchKillIntegrationTaskInstances.md +2 -2
  54. tccli/examples/wedata/v20210820/BatchMakeUpIntegrationTasks.md +2 -2
  55. tccli/examples/wedata/v20210820/BatchRerunIntegrationTaskInstances.md +5 -2
  56. tccli/examples/wedata/v20210820/CheckDuplicateRuleName.md +5 -5
  57. tccli/examples/wedata/v20210820/CheckDuplicateTemplateName.md +4 -4
  58. tccli/examples/wedata/v20210820/CheckIntegrationNodeNameExists.md +4 -4
  59. tccli/examples/wedata/v20210820/CheckIntegrationTaskNameExists.md +4 -4
  60. tccli/examples/wedata/v20210820/CheckTaskNameExist.md +3 -3
  61. tccli/examples/wedata/v20210820/CommitExportTask.md +4 -4
  62. tccli/examples/wedata/v20210820/CreateInLongAgent.md +6 -6
  63. tccli/examples/wedata/v20210820/CreateOrUpdateResource.md +2 -1
  64. tccli/examples/wedata/v20210820/CreateRuleTemplate.md +1 -1
  65. tccli/examples/wedata/v20210820/CreateTaskAlarmRegular.md +11 -11
  66. tccli/examples/wedata/v20210820/DeleteInLongAgent.md +3 -3
  67. tccli/examples/wedata/v20210820/DeleteIntegrationNode.md +2 -2
  68. tccli/examples/wedata/v20210820/DeleteOfflineTask.md +4 -4
  69. tccli/examples/wedata/v20210820/DeleteRule.md +1 -1
  70. tccli/examples/wedata/v20210820/DeleteRuleTemplate.md +1 -1
  71. tccli/examples/wedata/v20210820/DescribeClusterNamespaceList.md +6 -6
  72. tccli/examples/wedata/v20210820/DescribeDataBases.md +12 -8
  73. tccli/examples/wedata/v20210820/DescribeDataCheckStat.md +5 -5
  74. tccli/examples/wedata/v20210820/DescribeDataObjects.md +6 -3
  75. tccli/examples/wedata/v20210820/DescribeExecStrategy.md +20 -16
  76. tccli/examples/wedata/v20210820/DescribeInLongAgentTaskList.md +6 -6
  77. tccli/examples/wedata/v20210820/DescribeInLongAgentVpcList.md +3 -3
  78. tccli/examples/wedata/v20210820/DescribeInstances.md +6 -6
  79. tccli/examples/wedata/v20210820/DescribeIntegrationNode.md +61 -43
  80. tccli/examples/wedata/v20210820/DescribeIntegrationStatistics.md +13 -13
  81. tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsAgentStatus.md +6 -6
  82. tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsInstanceTrend.md +8 -10
  83. tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsRecordsTrend.md +1 -1
  84. tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsTaskStatus.md +5 -5
  85. tccli/examples/wedata/v20210820/DescribeIntegrationStatisticsTaskStatusTrend.md +8 -10
  86. tccli/examples/wedata/v20210820/DescribeMonitorsByPage.md +7 -7
  87. tccli/examples/wedata/v20210820/DescribeOfflineTaskToken.md +3 -3
  88. tccli/examples/wedata/v20210820/DescribeProdTasks.md +6 -5
  89. tccli/examples/wedata/v20210820/DescribeRealTimeTaskInstanceNodeInfo.md +9 -9
  90. tccli/examples/wedata/v20210820/DescribeRealTimeTaskSpeed.md +32 -26
  91. tccli/examples/wedata/v20210820/DescribeRule.md +118 -23
  92. tccli/examples/wedata/v20210820/DescribeRuleDataSources.md +11 -8
  93. tccli/examples/wedata/v20210820/DescribeRuleDimStat.md +3 -3
  94. tccli/examples/wedata/v20210820/DescribeRuleExecDetail.md +48 -41
  95. tccli/examples/wedata/v20210820/DescribeRuleExecExportResult.md +15 -10
  96. tccli/examples/wedata/v20210820/DescribeRuleExecLog.md +2 -2
  97. tccli/examples/wedata/v20210820/DescribeRuleExecResults.md +72 -4
  98. tccli/examples/wedata/v20210820/DescribeRuleExecResultsByPage.md +38 -33
  99. tccli/examples/wedata/v20210820/DescribeRuleExecStat.md +14 -14
  100. tccli/examples/wedata/v20210820/DescribeRuleGroup.md +50 -23
  101. tccli/examples/wedata/v20210820/DescribeRuleGroupExecResultsByPage.md +87 -14
  102. tccli/examples/wedata/v20210820/DescribeRuleGroupExecResultsByPageWithoutAuth.md +81 -12
  103. tccli/examples/wedata/v20210820/DescribeRuleGroupSubscription.md +12 -6
  104. tccli/examples/wedata/v20210820/DescribeRuleGroupTable.md +35 -27
  105. tccli/examples/wedata/v20210820/DescribeRuleGroupsByPage.md +51 -21
  106. tccli/examples/wedata/v20210820/DescribeRuleHistoryByPage.md +9 -9
  107. tccli/examples/wedata/v20210820/DescribeRuleTablesByPage.md +52 -35
  108. tccli/examples/wedata/v20210820/DescribeRuleTemplate.md +33 -16
  109. tccli/examples/wedata/v20210820/DescribeRuleTemplates.md +8 -8
  110. tccli/examples/wedata/v20210820/DescribeRuleTemplatesByPage.md +13 -13
  111. tccli/examples/wedata/v20210820/DescribeRulesByPage.md +123 -28
  112. tccli/examples/wedata/v20210820/DescribeStandardRuleDetailInfoList.md +3 -3
  113. tccli/examples/wedata/v20210820/DescribeTableInfoList.md +9 -2
  114. tccli/examples/wedata/v20210820/DescribeTaskInstance.md +35 -35
  115. tccli/examples/wedata/v20210820/DescribeTaskInstanceReportDetail.md +28 -26
  116. tccli/examples/wedata/v20210820/DescribeTaskLockStatus.md +7 -7
  117. tccli/examples/wedata/v20210820/DescribeTaskReport.md +6 -6
  118. tccli/examples/wedata/v20210820/DescribeTaskReportDetailList.md +17 -17
  119. tccli/examples/wedata/v20210820/DescribeTopTableStat.md +9 -9
  120. tccli/examples/wedata/v20210820/DescribeTrendStat.md +2 -2
  121. tccli/examples/wedata/v20210820/DryRunDIOfflineTask.md +10 -9
  122. tccli/examples/wedata/v20210820/GetIntegrationNodeColumnSchema.md +13 -11
  123. tccli/examples/wedata/v20210820/GetOfflineDIInstanceList.md +26 -26
  124. tccli/examples/wedata/v20210820/LockIntegrationTask.md +4 -4
  125. tccli/examples/wedata/v20210820/ModifyIntegrationNode.md +42 -41
  126. tccli/examples/wedata/v20210820/ModifyIntegrationTask.md +110 -58
  127. tccli/examples/wedata/v20210820/ModifyMonitorStatus.md +4 -4
  128. tccli/examples/wedata/v20210820/ModifyRule.md +24 -24
  129. tccli/examples/wedata/v20210820/ModifyRuleGroupSubscription.md +11 -13
  130. tccli/examples/wedata/v20210820/ModifyTaskAlarmRegular.md +45 -16
  131. tccli/examples/wedata/v20210820/ModifyTaskName.md +5 -5
  132. tccli/examples/wedata/v20210820/RestartInLongAgent.md +3 -3
  133. tccli/examples/wedata/v20210820/RobAndLockIntegrationTask.md +7 -7
  134. tccli/examples/wedata/v20210820/StopIntegrationTask.md +4 -4
  135. tccli/examples/wedata/v20210820/TaskLog.md +5 -15
  136. tccli/examples/wedata/v20210820/UnlockIntegrationTask.md +4 -4
  137. tccli/examples/wedata/v20210820/UpdateInLongAgent.md +5 -5
  138. tccli/services/aiart/aiart_client.py +106 -0
  139. tccli/services/aiart/v20221229/api.json +174 -0
  140. tccli/services/aiart/v20221229/examples.json +16 -0
  141. tccli/services/asr/v20190614/api.json +4 -4
  142. tccli/services/bi/v20220105/api.json +27 -0
  143. tccli/services/billing/v20180709/api.json +365 -130
  144. tccli/services/billing/v20180709/examples.json +4 -4
  145. tccli/services/ccc/ccc_client.py +159 -0
  146. tccli/services/ccc/v20200210/api.json +442 -0
  147. tccli/services/ccc/v20200210/examples.json +24 -0
  148. tccli/services/cdb/v20170320/api.json +3 -3
  149. tccli/services/cdwpg/v20201230/api.json +9 -0
  150. tccli/services/ckafka/ckafka_client.py +106 -0
  151. tccli/services/ckafka/v20190819/api.json +190 -12
  152. tccli/services/ckafka/v20190819/examples.json +17 -1
  153. tccli/services/clb/v20180317/api.json +2 -2
  154. tccli/services/cloudstudio/v20230508/api.json +40 -4
  155. tccli/services/cls/v20201016/api.json +30 -30
  156. tccli/services/csip/v20221121/api.json +76 -76
  157. tccli/services/cwp/v20180228/api.json +124 -8
  158. tccli/services/cynosdb/cynosdb_client.py +53 -0
  159. tccli/services/cynosdb/v20190107/api.json +255 -0
  160. tccli/services/cynosdb/v20190107/examples.json +8 -0
  161. tccli/services/dlc/dlc_client.py +53 -0
  162. tccli/services/dlc/v20210125/api.json +103 -4
  163. tccli/services/dlc/v20210125/examples.json +8 -0
  164. tccli/services/dsgc/v20190723/api.json +20 -0
  165. tccli/services/dts/v20211206/api.json +56 -2
  166. tccli/services/es/v20180416/api.json +127 -24
  167. tccli/services/ess/v20201111/api.json +19 -19
  168. tccli/services/essbasic/v20210526/api.json +13 -4
  169. tccli/services/essbasic/v20210526/examples.json +1 -1
  170. tccli/services/faceid/v20180301/api.json +23 -13
  171. tccli/services/faceid/v20180301/examples.json +1 -1
  172. tccli/services/iotexplorer/iotexplorer_client.py +1453 -234
  173. tccli/services/iotexplorer/v20190423/api.json +2179 -117
  174. tccli/services/iotexplorer/v20190423/examples.json +184 -0
  175. tccli/services/lcic/v20220817/api.json +62 -4
  176. tccli/services/monitor/v20180724/examples.json +111 -3
  177. tccli/services/mps/v20190612/api.json +53 -27
  178. tccli/services/ms/v20180408/api.json +14 -14
  179. tccli/services/ocr/ocr_client.py +53 -0
  180. tccli/services/ocr/v20181119/api.json +276 -0
  181. tccli/services/ocr/v20181119/examples.json +8 -0
  182. tccli/services/pts/pts_client.py +212 -0
  183. tccli/services/pts/v20210728/api.json +96 -0
  184. tccli/services/pts/v20210728/examples.json +32 -0
  185. tccli/services/ssl/v20191205/examples.json +9 -3
  186. tccli/services/tag/v20180813/examples.json +1 -1
  187. tccli/services/tione/v20211111/api.json +77 -3
  188. tccli/services/tione/v20211111/examples.json +2 -2
  189. tccli/services/tms/v20201229/api.json +1 -1
  190. tccli/services/trtc/v20190722/api.json +1 -1
  191. tccli/services/tts/v20190823/api.json +10 -1
  192. tccli/services/vod/v20180717/api.json +6 -6
  193. tccli/services/wedata/v20210820/api.json +621 -198
  194. tccli/services/wedata/v20210820/examples.json +146 -146
  195. {tccli-3.0.1084.1.dist-info → tccli-3.0.1085.1.dist-info}/METADATA +2 -2
  196. {tccli-3.0.1084.1.dist-info → tccli-3.0.1085.1.dist-info}/RECORD +199 -162
  197. {tccli-3.0.1084.1.dist-info → tccli-3.0.1085.1.dist-info}/WHEEL +0 -0
  198. {tccli-3.0.1084.1.dist-info → tccli-3.0.1085.1.dist-info}/entry_points.txt +0 -0
  199. {tccli-3.0.1084.1.dist-info → tccli-3.0.1085.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,13 @@
1
1
  {
2
2
  "actions": {
3
+ "BindCloudStorageUser": [
4
+ {
5
+ "document": "",
6
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BindCloudStorageUser\n<公共请求参数>\n\n{\n \"DeviceName\": \"sdfsdf\",\n \"UserId\": \"sdfsdf\",\n \"ProductId\": \"sdfdsf\"\n}",
7
+ "output": "{\n \"Response\": {\n \"RequestId\": \"sdfsdfdsf\"\n }\n}",
8
+ "title": "绑定云存用户"
9
+ }
10
+ ],
3
11
  "BindDevices": [
4
12
  {
5
13
  "document": "",
@@ -106,6 +114,14 @@
106
114
  "title": "CreateFenceBind"
107
115
  }
108
116
  ],
117
+ "CreateIotVideoCloudStorage": [
118
+ {
119
+ "document": "",
120
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCloudStorage\n<公共请求参数>\n\n{\n \"ProductId\": \"H541SOP191\",\n \"DeviceName\": \"event_36502632_1\",\n \"PackageId\": \"yc1m3d\"\n}",
121
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a9a9d232-01c0-494a-baa3-57c384463c3f\"\n }\n}",
122
+ "title": "CreateCloudStorage"
123
+ }
124
+ ],
109
125
  "CreateLoRaFrequency": [
110
126
  {
111
127
  "document": "创建 LoRa 自定义频点",
@@ -170,6 +186,14 @@
170
186
  "title": "创建规则"
171
187
  }
172
188
  ],
189
+ "DeleteCloudStorageEvent": [
190
+ {
191
+ "document": "",
192
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCloudStorageEvent\n<公共请求参数>\n\n{\n \"ProductId\": \"abc\",\n \"DeviceName\": \"abc\",\n \"EventId\": \"abc\",\n \"StartTime\": 1,\n \"EndTime\": 1,\n \"UserId\": \"abc\",\n \"ChannelId\": 1\n}",
193
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
194
+ "title": "删除云存某一事件"
195
+ }
196
+ ],
173
197
  "DeleteDevice": [
174
198
  {
175
199
  "document": "删除设备",
@@ -274,6 +298,102 @@
274
298
  "title": "获取网关产品已经绑定的子产品"
275
299
  }
276
300
  ],
301
+ "DescribeCloudStorage": [
302
+ {
303
+ "document": "",
304
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorage\n<公共请求参数>\n\n{\n \"ProductId\": \"H541SOP191\",\n \"DeviceName\": \"event_36502632_1\",\n \"UserId\": \"default\"\n}",
305
+ "output": "{\n \"Response\": {\n \"RequestId\": \"f889deee-70ec-4391-9b91-bb0f3f09b5a4\",\n \"Status\": 1,\n \"Type\": 1,\n \"ExpireTime\": 1614670782,\n \"ShiftDuration\": 86400,\n \"UserId\": \"default\"\n }\n}",
306
+ "title": "获取设备云存服务详情"
307
+ }
308
+ ],
309
+ "DescribeCloudStorageDate": [
310
+ {
311
+ "document": "",
312
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageDate\n<公共请求参数>\n\n{\n \"ProductId\": \"AQTV2839QJ\",\n \"DeviceName\": \"p2p_32731213_1\"\n}",
313
+ "output": "{\n \"Response\": {\n \"RequestId\": \"77d90d07-e48c-4cf0-bec5-afe5b137f80e\",\n \"Data\": [\n \"2021-01-14\"\n ]\n }\n}",
314
+ "title": "获取具有云存的日期"
315
+ }
316
+ ],
317
+ "DescribeCloudStorageEvents": [
318
+ {
319
+ "document": "",
320
+ "input": "POST / HTTP/1.1\nHost: iotvideo.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageEvents\n<公共请求参数>\n\n{\n \"ProductId\": \"AQTV2839QJ\",\n \"DeviceName\": \"sp01_32820237_10\"\n}",
321
+ "output": "{\n \"Response\": {\n \"RequestId\": \"bd3ad0f6-5b9f-47cd-83db-223356926772\",\n \"Total\": 13,\n \"Events\": [\n {\n \"StartTime\": 842084401,\n \"EndTime\": 842084401,\n \"Thumbnail\": \"\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 842084401,\n \"EndTime\": 842084401,\n \"Thumbnail\": \"\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 842084401,\n \"EndTime\": 842084401,\n \"Thumbnail\": \"\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n },\n {\n \"StartTime\": 1614847697,\n \"EndTime\": 167000000,\n \"Thumbnail\": \"face_dection.jpg\",\n \"EventId\": \"id1_data\"\n }\n ],\n \"Context\": \"DnF1ZXJ5VGhlbkZldGNoKAAAAAABxjxlFmlDUHBXME5XVE55eUdHMDUwZTV4WWcAAAAAAcaq9BZFeGQwTXM5X1RvNnFRMFNhRm1MNTlRAAAAAAHGqvYWRXhkME1zOV9UbzZxUTBTYUZtTDU5UQAAAAABxk0BFnN5Q1hWNUp0UjcyZkZma2licmF3SmcAAAAAAcaq9RZFeGQwTXM5X1RvNnFRMFNhRm1MNTlRAAAAAAHGhvUWTzl2c3FBNVdUWnFSWXh4d012MGlzdwAAAAABxjxmFmlDUHBXME5XVE55eUdHMDUwZTV4WWcAAAAAAcaG9xZPOXZzcUE1V1RacVJZeHh3TXYwaXN3AAAAAAHGVbkWTVBJSndzX0VReVNoU3JOb2pWUm40UQAAAAABxk0AFnN5Q1hWNUp0UjcyZkZma2licmF3SmcAAAAAAcaG-BZPOXZzcUE1V1RacVJZeHh3TXYwaXN3AAAAAAHGqvgWRXhkME1zOV9UbzZxUTBTYUZtTDU5UQAAAAABxkfDFjdNdGYtaTR5UTBPNmFFcHkyUmlUVHcAAAAAAcY88hZOVnkwbjNfNFRqV2YwSWk1LWczc2V3AAAAAAHGhvYWTzl2c3FBNVdUWnFSWXh4d012MGlzdwAAAAABxqr3FkV4ZDBNczlfVG82cVEwU2FGbUw1OVEAAAAAAcaG-RZPOXZzcUE1V1RacVJZeHh3TXYwaXN3AAAAAAHGR8IWN010Zi1pNHlRME82YUVweTJSaVRUdwAAAAABxquSFnJKTjhzbk5mUmZxMVVCcVhpVUNTZFEAAAAAAcY8ZxZpQ1BwVzBOV1ROeXlHRzA1MGU1eFlnAAAAAAHGehEWTTRRa1JkRDhUek9qem1CSmNFbHhUZwAAAAABxqr5FkV4ZDBNczlfVG82cVEwU2FGbUw1OVEAAAAAAcZNBBZzeUNYVjVKdFI3MmZGZmtpYnJhd0pnAAAAAAHGVboWTVBJSndzX0VReVNoU3JOb2pWUm40UQAAAAABxnoQFk00UWtSZEQ4VHpPanptQkpjRWx4VGcAAAAAAcarkxZySk44c25OZlJmcTFVQnFYaVVDU2RRAAAAAAHGTQIWc3lDWFY1SnRSNzJmRmZraWJyYXdKZwAAAAABxpZ4Fno4eVNTTDlLUVUyblVfMFFFcnhramcAAAAAAcY88xZOVnkwbjNfNFRqV2YwSWk1LWczc2V3AAAAAAHGTQMWc3lDWFY1SnRSNzJmRmZraWJyYXdKZwAAAAABxkfEFjdNdGYtaTR5UTBPNmFFcHkyUmlUVHcAAAAAAcarlBZySk44c25OZlJmcTFVQnFYaVVDU2RRAAAAAAHGqvoWRXhkME1zOV9UbzZxUTBTYUZtTDU5UQAAAAABxpZ6Fno4eVNTTDlLUVUyblVfMFFFcnhramcAAAAAAcZHxRY3TXRmLWk0eVEwTzZhRXB5MlJpVFR3AAAAAAHGVbsWTVBJSndzX0VReVNoU3JOb2pWUm40UQAAAAABxpZ5Fno4eVNTTDlLUVUyblVfMFFFcnhramcAAAAAAcY8aBZpQ1BwVzBOV1ROeXlHRzA1MGU1eFlnAAAAAAHGqvsWRXhkME1zOV9UbzZxUTBTYUZtTDU5UQAAAAABxpZ7Fno4eVNTTDlLUVUyblVfMFFFcnhramc=\",\n \"Listover\": false,\n \"VideoURL\": \"http://test.iotvideo.tencentcs.com/timeshift/live/test.m3u8\"\n }\n}",
322
+ "title": "拉取云存事件列表"
323
+ }
324
+ ],
325
+ "DescribeCloudStorageMultiThumbnail": [
326
+ {
327
+ "document": "",
328
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageMultiThumbnail\n<公共请求参数>\n\n{\n \"ProductId\": \"abc\",\n \"DeviceName\": \"abc\",\n \"MultiThumbnail\": \"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg|/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"\n}",
329
+ "output": "{\n \"Response\": {\n \"ThumbnailURLInfoList\": [\n {\n \"ThumbnailURL\": \"abc\",\n \"ExpireTime\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
330
+ "title": "拉取多个云存事件缩略图"
331
+ }
332
+ ],
333
+ "DescribeCloudStorageOrder": [
334
+ {
335
+ "document": "",
336
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageOrder\n<公共请求参数>\n\n{\n \"OrderId\": \"abc\"\n}",
337
+ "output": "{\n \"Response\": {\n \"StartTime\": 1,\n \"ExpireTime\": 1,\n \"PackageId\": \"abc\",\n \"Status\": 1,\n \"RequestId\": \"abc\",\n \"ChannelId\": 1\n }\n}",
338
+ "title": "查询云服务详情示例"
339
+ }
340
+ ],
341
+ "DescribeCloudStoragePackageConsumeDetails": [
342
+ {
343
+ "document": "",
344
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStoragePackageConsumeDetails\n<公共请求参数>\n\n{\n \"StartDate\": \"2020-10-11\",\n \"EndDate\": \"2021-03-06\"\n}",
345
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a9545416-7eac-4e2e-a4a0-9735b0ee7682\"\n }\n}",
346
+ "title": "获取云存套餐包消耗详细记录"
347
+ }
348
+ ],
349
+ "DescribeCloudStoragePackageConsumeStats": [
350
+ {
351
+ "document": "",
352
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStoragePackageConsumeStats\n<公共请求参数>\n\n{\n \"StartDate\": \"2020-10-11\",\n \"EndDate\": \"2021-03-06\"\n}",
353
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a9545416-7eac-4e2e-a4a0-9735b0ee7682\",\n \"Stats\": [\n {\n \"PackageId\": \"\",\n \"PackageName\": \"全时3天月卡\",\n \"Cnt\": 3,\n \"Source\": 1,\n \"Price\": 600\n },\n {\n \"PackageId\": \"\",\n \"PackageName\": \"全时3天月卡\",\n \"Cnt\": 1,\n \"Source\": 1,\n \"Price\": 595\n },\n {\n \"PackageId\": \"\",\n \"PackageName\": \"全时7天月卡\",\n \"Cnt\": 2,\n \"Source\": 1,\n \"Price\": 1000\n }\n ]\n }\n}",
354
+ "title": "获取云存套餐包消耗详统计"
355
+ }
356
+ ],
357
+ "DescribeCloudStorageStreamData": [
358
+ {
359
+ "document": "",
360
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageStreamData\n<公共请求参数>\n\n{\n \"DeviceName\": \"device\",\n \"StartTime\": 1660561529,\n \"ProductId\": \"product\"\n}",
361
+ "output": "{\n \"Response\": {\n \"VideoStream\": \"https://test.cos.ap-guangzhou.myqcloud.com/test.mjpg\",\n \"AudioStream\": \"https://test.cos.ap-guangzhou.myqcloud.com/test.aac\",\n \"RequestId\": \"test-id\"\n }\n}",
362
+ "title": "获取设备图片流数据"
363
+ }
364
+ ],
365
+ "DescribeCloudStorageThumbnail": [
366
+ {
367
+ "document": "",
368
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageThumbnail\n<公共请求参数>\n\n{\n \"ProductId\": \"AQTV2839QJ\",\n \"DeviceName\": \"sp01_32820237_5\",\n \"Thumbnail\": \"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"\n}",
369
+ "output": "{\n \"Response\": {\n \"RequestId\": \"c299d2c9-805f-41a5-853d-db32ba1a16b5\",\n \"ThumbnailURL\": \"https://video-cv-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100008401725%2FAQTV2839QJ%2Fsp01_32820237_5%2Fevents%2F1614908216.jpg?q-sign-algorithm=sha1&q-ak=AKIDAbqpXyZb6KJ6dtvwkRwAqLbfNvIZlYJp&q-sign-time=1614909378%3B1614912978&q-key-time=1614909378%3B1614912978&q-header-list=host&q-url-param-list=&q-signature=59cfa8d69bb77980ba757cb111de62fc6c4880f5\",\n \"ExpireTime\": 1\n }\n}",
370
+ "title": "拉取云存事件缩略图"
371
+ }
372
+ ],
373
+ "DescribeCloudStorageThumbnailList": [
374
+ {
375
+ "document": "批量拉取云存事件缩略图",
376
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageThumbnailList\n<公共请求参数>\n\n{\n \"ProductId\": \"H541SOP191\",\n \"DeviceName\": \"event_36502632_1\",\n \"ThumbnailList\": [\n \"/100008401725/AQTV2839QJ/sp01_32820237_7/events/1615200613.jpg\"\n ]\n}",
377
+ "output": "{\n \"Response\": {\n \"RequestId\": \"77dbf0ae-bdee-4b09-a5eb-0086d0164a20\",\n \"ThumbnailURLInfoList\": [\n {\n \"ExpireTime\": 12321321,\n \"ThumbnailURL\": \"https://video-cv-1258344699.cos.ap-guangzhou.myqcloud.com/%2F100\"\n }\n ]\n }\n}",
378
+ "title": "批量拉取云存事件缩略图"
379
+ }
380
+ ],
381
+ "DescribeCloudStorageTime": [
382
+ {
383
+ "document": "",
384
+ "input": "POST / HTTP/1.1\nHost: iotvideo.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageTime\n<公共请求参数>\n\n{\n \"ProductId\": \"AQTV2839QJ\",\n \"DeviceName\": \"p2p_32731213_1\",\n \"Date\": \"2021-01-14\"\n}",
385
+ "output": "{\n \"Response\": {\n \"RequestId\": \"ac74ecca-b866-4ab1-87e0-18b92816fb20\",\n \"Data\": {\n \"VideoURL\": \"47b9d579-9088-4cc2-a16e-2b8cf245319b\",\n \"TimeList\": [\n {\n \"StartTime\": 1610607600,\n \"EndTime\": 1610608200\n },\n {\n \"StartTime\": 1610607600,\n \"EndTime\": 1610608200\n },\n {\n \"StartTime\": 1610607600,\n \"EndTime\": 1610608200\n },\n {\n \"StartTime\": 1610607600,\n \"EndTime\": 1610608200\n }\n ]\n }\n }\n}",
386
+ "title": "获取某一天云存时间轴"
387
+ }
388
+ ],
389
+ "DescribeCloudStorageUsers": [
390
+ {
391
+ "document": "",
392
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCloudStorageUsers\n<公共请求参数>\n\n{\n \"DeviceName\": \"sdfsdf\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"ProductId\": \"lsdjfjf\"\n}",
393
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Users\": [\n {\n \"UserId\": \"dfsdf\"\n }\n ],\n \"RequestId\": \"sdfdsfesdsf\"\n }\n}",
394
+ "title": "拉取云存用户列表"
395
+ }
396
+ ],
277
397
  "DescribeDevice": [
278
398
  {
279
399
  "document": "用于查看设备信息",
@@ -322,6 +442,14 @@
322
442
  "title": "获取实时位置解析"
323
443
  }
324
444
  ],
445
+ "DescribeDevicePackages": [
446
+ {
447
+ "document": "",
448
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDevicePackages\n<公共请求参数>\n\n{\n \"ProductId\": \"abc\",\n \"DeviceName\": \"abc\",\n \"CSUserId\": \"sdfsdf\",\n \"Limit\": 1,\n \"Offset\": 1\n}",
449
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Packages\": [\n {\n \"Status\": 0,\n \"CSType\": 1,\n \"CSShiftDuration\": 1,\n \"CSExpiredTime\": 0,\n \"ChannelId\": 1,\n \"CSUserId\": \"sdfsdf\",\n \"CreatedAt\": 0,\n \"UpdatedAt\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
450
+ "title": "拉取有效套餐列表"
451
+ }
452
+ ],
325
453
  "DescribeDevicePositionList": [
326
454
  {
327
455
  "document": "",
@@ -402,6 +530,22 @@
402
530
  "title": "查询产品数据模板"
403
531
  }
404
532
  ],
533
+ "DescribePackageConsumeTask": [
534
+ {
535
+ "document": "",
536
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePackageConsumeTask\n<公共请求参数>\n\n{\n \"TaskId\": 45\n}",
537
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a9545416-7eac-4e2e-a4a0-9735b0ee7682\",\n \"URL\": \"https://video-cv-test-1256872341.cos.ap-guangzhou.myqcloud.com/41411451%2FPackageConsume%2F2022-02-11_2022-02-17_1.csv?q-sign-algorithm=sha1&q-ak=AKIDCOZny6BBD4mLnKMPm7HFGHD2iIl6dONI&q-sign-time=1645168502%3B1645172102&q-key-time=1645168502%3B1645172102&q-header-list=host&q-url-param-list=&q-signature=b9d9c7298da29677b7dc45b8c4c0385495290a09\"\n }\n}",
538
+ "title": "查询套餐消耗记录详情"
539
+ }
540
+ ],
541
+ "DescribePackageConsumeTasks": [
542
+ {
543
+ "document": "",
544
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePackageConsumeTasks\n<公共请求参数>\n\n{\n \"Limit\": 45,\n \"Offset\": 0\n}",
545
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a9545416-7eac-4e2e-a4a0-9735b0ee7682\",\n \"TotalCount\": 3,\n \"List\": [\n {\n \"TaskId\": 3,\n \"CreateTime\": \"2022-02-18 15:45:06\",\n \"State\": 3\n },\n {\n \"TaskId\": 2,\n \"CreateTime\": \"2022-02-18 15:43:38\",\n \"State\": 3\n },\n {\n \"TaskId\": 1,\n \"CreateTime\": \"2022-02-17 14:50:42\",\n \"State\": 3\n }\n ]\n }\n}",
546
+ "title": "查询套餐消耗记录列表"
547
+ }
548
+ ],
405
549
  "DescribePositionFenceList": [
406
550
  {
407
551
  "document": "",
@@ -482,6 +626,14 @@
482
626
  "title": "生成单个设备绑定的签名"
483
627
  }
484
628
  ],
629
+ "GenerateSignedVideoURL": [
630
+ {
631
+ "document": "",
632
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GenerateSignedVideoURL\n<公共请求参数>\n\n{\n \"ExpireTime\": 1619331648,\n \"VideoURL\": \"http://zylcb.iotvideo.tencentcs.com/timeshift/live/1.m3u8\"\n}",
633
+ "output": "{\n \"Response\": {\n \"SignedVideoURL\": \"http://zylcb.iotvideo.tencentcs.com/timeshift/live/1.m3u8?sign=x\",\n \"RequestId\": \"abc\"\n }\n}",
634
+ "title": "获取视频防盗链播放URL"
635
+ }
636
+ ],
485
637
  "GetBatchProductionsList": [
486
638
  {
487
639
  "document": "",
@@ -584,6 +736,14 @@
584
736
  "title": "获取规则列表"
585
737
  }
586
738
  ],
739
+ "InheritCloudStorageUser": [
740
+ {
741
+ "document": "",
742
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InheritCloudStorageUser\n<公共请求参数>\n\n{\n \"DeviceName\": \"sdfds\",\n \"ToUserId\": \"sdfds\",\n \"UserId\": \"ddd\",\n \"ProductId\": \"sdfds\"\n}",
743
+ "output": "{\n \"Response\": {\n \"RequestId\": \"dd\"\n }\n}",
744
+ "title": "继承云存用户"
745
+ }
746
+ ],
587
747
  "ListEventHistory": [
588
748
  {
589
749
  "document": "用于查询设备上报的所有类型历史事件信息",
@@ -734,6 +894,22 @@
734
894
  "title": "发布产品"
735
895
  }
736
896
  ],
897
+ "ResetCloudStorage": [
898
+ {
899
+ "document": "",
900
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetCloudStorage\n<公共请求参数>\n\n{\n \"DeviceName\": \"event_36502632_1\",\n \"ProductId\": \"H541SOP191\"\n}",
901
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
902
+ "title": "ResetCloudStorage"
903
+ }
904
+ ],
905
+ "ResetCloudStorageEvent": [
906
+ {
907
+ "document": "",
908
+ "input": "POST / HTTP/1.1\nHost:iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetCloudStorageEvent\n<公共请求参数>\n\n{\n \"ProductId\": \"abc\",\n \"DeviceName\": \"abc\",\n \"UserId\": \"abc\"\n}",
909
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
910
+ "title": "重置云存事件"
911
+ }
912
+ ],
737
913
  "SearchPositionSpace": [
738
914
  {
739
915
  "document": "",
@@ -758,6 +934,14 @@
758
934
  "title": "搜索规则"
759
935
  }
760
936
  ],
937
+ "TransferCloudStorage": [
938
+ {
939
+ "document": "用于转移云存服务到新设备",
940
+ "input": "POST / HTTP/1.1\nHost: iotexplorer.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TransferCloudStorage\n<公共请求参数>\n\n{\n \"ToDeviceName\": \"event_36502632_2\",\n \"DeviceName\": \"event_36502632_1\",\n \"ProductId\": \"H541SOP191\"\n}",
941
+ "output": "{\n \"Response\": {\n \"RequestId\": \"sdfdsf\"\n }\n}",
942
+ "title": "转移云存服务"
943
+ }
944
+ ],
761
945
  "UnbindDevices": [
762
946
  {
763
947
  "document": "",
@@ -1819,6 +1819,45 @@
1819
1819
  ],
1820
1820
  "type": "object"
1821
1821
  },
1822
+ "CustomMsgContent": {
1823
+ "document": "自定义消息",
1824
+ "members": [
1825
+ {
1826
+ "disabled": false,
1827
+ "document": "自定义消息数据。\n注意:此字段可能返回 null,表示取不到有效值。",
1828
+ "example": "你好",
1829
+ "member": "string",
1830
+ "name": "Data",
1831
+ "output_required": false,
1832
+ "required": false,
1833
+ "type": "string",
1834
+ "value_allowed_null": true
1835
+ },
1836
+ {
1837
+ "disabled": false,
1838
+ "document": "自定义消息描述信息。\n注意:此字段可能返回 null,表示取不到有效值。",
1839
+ "example": "自定义消息描述",
1840
+ "member": "string",
1841
+ "name": "Desc",
1842
+ "output_required": false,
1843
+ "required": false,
1844
+ "type": "string",
1845
+ "value_allowed_null": true
1846
+ },
1847
+ {
1848
+ "disabled": false,
1849
+ "document": "扩展字段。\n注意:此字段可能返回 null,表示取不到有效值。",
1850
+ "example": "CHAT",
1851
+ "member": "string",
1852
+ "name": "Ext",
1853
+ "output_required": false,
1854
+ "required": false,
1855
+ "type": "string",
1856
+ "value_allowed_null": true
1857
+ }
1858
+ ],
1859
+ "usage": "both"
1860
+ },
1822
1861
  "DeleteAppCustomContentRequest": {
1823
1862
  "document": "DeleteAppCustomContent请求参数结构体",
1824
1863
  "members": [
@@ -5070,7 +5109,7 @@
5070
5109
  "example": "0",
5071
5110
  "member": "int64",
5072
5111
  "name": "MessageType",
5073
- "required": false,
5112
+ "output_required": true,
5074
5113
  "type": "int",
5075
5114
  "value_allowed_null": true
5076
5115
  },
@@ -5080,7 +5119,7 @@
5080
5119
  "example": "text",
5081
5120
  "member": "string",
5082
5121
  "name": "TextMessage",
5083
- "required": false,
5122
+ "output_required": true,
5084
5123
  "type": "string",
5085
5124
  "value_allowed_null": true
5086
5125
  },
@@ -5090,9 +5129,19 @@
5090
5129
  "example": "url",
5091
5130
  "member": "string",
5092
5131
  "name": "ImageMessage",
5093
- "required": false,
5132
+ "output_required": true,
5094
5133
  "type": "string",
5095
5134
  "value_allowed_null": true
5135
+ },
5136
+ {
5137
+ "disabled": false,
5138
+ "document": "自定义消息内容。message type为2时有效。\n注意:此字段可能返回 null,表示取不到有效值。",
5139
+ "example": "{\"Data\":\"data\",\"Desc\":\"custom_message\",\"Ext\":\"CHAT\"}",
5140
+ "member": "CustomMsgContent",
5141
+ "name": "CustomMessage",
5142
+ "output_required": true,
5143
+ "type": "object",
5144
+ "value_allowed_null": true
5096
5145
  }
5097
5146
  ],
5098
5147
  "usage": "out"
@@ -5562,7 +5611,7 @@
5562
5611
  "members": [
5563
5612
  {
5564
5613
  "disabled": false,
5565
- "document": "TIM 消息对象类型,目前支持的消息对象包括:\nTIMTextElem(文本消息)\nTIMFaceElem(表情消息)\nTIMImageElem(图像消息)",
5614
+ "document": "TIM 消息对象类型,目前支持的消息对象包括:\nTIMTextElem(文本消息)\nTIMFaceElem(表情消息)\nTIMImageElem(图像消息)\nTIMCustomElem(自定义消息)",
5566
5615
  "example": "TIMImageElem",
5567
5616
  "member": "string",
5568
5617
  "name": "MsgType",
@@ -5595,6 +5644,15 @@
5595
5644
  "name": "ImageMsgContent",
5596
5645
  "required": false,
5597
5646
  "type": "object"
5647
+ },
5648
+ {
5649
+ "disabled": false,
5650
+ "document": "自定义消息,TIMCustomElem(自定义消息)必选。",
5651
+ "example": "无",
5652
+ "member": "CustomMsgContent",
5653
+ "name": "CustomMsgContent",
5654
+ "required": false,
5655
+ "type": "object"
5598
5656
  }
5599
5657
  ],
5600
5658
  "usage": "in"
@@ -66,10 +66,118 @@
66
66
  ],
67
67
  "CreateExporterIntegration": [
68
68
  {
69
- "document": "",
70
- "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"blackbox-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"test\\\",\\\"kind\\\":\\\"blackbox-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"module\\\":\\\"http_get\\\",\\\"urls\\\":[\\\"http://abc\\\"]}}}\"\n}",
69
+ "document": "参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `qcloud-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `qcloud-exporter`\n3.3. spec.instanceSpec.region 是云产品所在地域,必填,比如采集广州地域的云产品,可以填 `广州` 或 `ap-guangzhou`,该参数最终会转化为指标的 label, 名为 `instance-region`\n3.4. spec.instanceSpec.delaySeconds 表示数据采集延迟,整数,单位是秒,可不填,默认是 0。当值为 0 时,原始数据点的时间戳会被忽略,替换为集成拉取到数据点的时间;当值 >0 时,数据点会保留原始的时间戳,且数据必然会延迟设置的时间\n3.5. spec.instanceSpec.reload_interval_minutes 表示实例刷新间隔,整数,单位是分钟,必填且必须大于等于 10。云产品实例的新增或者云标签的修改,会在刷新实例后反映在指标中,至多需要等待一个实例刷新间隔\n3.6. spec.instanceSpec.useRole 表示是否使用服务角色,布尔类型,必填。当前逻辑一定会使用服务角色,所以必填 `true`\n3.7. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填\n3.8. spec.exporterSpec.[云产品] 表示是否采集对应云产品,布尔类型,`true` 表示采集该云产品。云产品各编码指代含义:`cvm`:云服务器,`cbs`:云硬盘,`lb_public`:负载均衡(公网),`lb_private`:负载均衡(内网),`tgw_set`:负载均衡(独占集群),`cmongo`:数据库MongoDB,`cdb`:数据库MySQL(CDB),`redis`:数据库Redis(CKV版),`redis_mem`:数据库Redis(内存版),`tendis`:Tendis,`xstor`:CTSDB(InfluxDB版),`mariadb`:数据库MariaDB,`postgres`:数据库PostgreSQL,`tdmysql`:TDSQL MySQL版,`cynosdb_mysql`:TDSQL-C MySQL,`sqlserver`:数据库SQL Server,`nat_gateway`:NAT网关,`ckafka`:CKafka,`rocketmq`:RocketMQ(新指标),`lb`:弹性公网IP,`vpngw`:VPN网关,`vpnx`:VPN通道,`vpc_net_detect`:网络探测,`cdn`:CDN,`ov_cdn`:CND(海外),`cos`:COS,`dc`:专线接入-物理专线,`dcx`:专线接入-专用通道,`dcg`:专线接入-专线网关,`lighthouse`:轻量应用服务器,`nacos`:Nacos,`zookeeper`:Zookeeper,`ces`:Elasticsearch,`dts`:数据传输服务,`vbc`:云联网,`gaap`:全球应用加速,`waf`:Web应用防火墙,`cfs`:文件存储,`bwp`:共享带宽包,`scf_v2`:云函数(别名),`vod`:云点播(VOD),`cls`:日志服务(CLS)-日志主题,`apigateway`:API 网关,`ti_traintask`:TI-ONE(任务式建模),`ti_notebook`:TI-ONE(Notebook),`ti_model`:TI-ONE(在线服务),`self`:采集器自监控\n2.9. spec.scrapeSpec.relabelConfigs 用于添加 `metricRelabelings` 配置,选填。该配置是 prometheus-operator 的 relabel 配置,部分字段与 prometheus 原生 relabel 配置不同,具体可参考[官方配置说明](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.RelabelConfig)",
70
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"qcloud-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"test\\\",\\\"kind\\\":\\\"qcloud-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"region\\\":\\\"广州\\\",\\\"delaySeconds\\\":0,\\\"reload_interval_minutes\\\":10,\\\"useRole\\\":true,\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"cvm\\\":true,\\\"cbs\\\":true},\\\"scrapeSpec\\\":{\\\"relabelConfigs\\\":\\\"metricRelabelings:\\\\n- action: labeldrop\\\\n regex: tmp_test_label\\\\n\\\"}}}\"\n}",
71
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
72
+ "title": "a. 创建 云监控 集成"
73
+ },
74
+ {
75
+ "document": "该集成要保证 CVM 实例与 Prometheus 实例内网相通(比如同 VPC 下),且 CVM 实例安装了[自动化助手](https://cloud.tencent.com/document/product/1340/51945)。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `cvm-node-exporter-sd`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. kind 是集成类型,必填且这里固定为 `cvm-node-exporter-sd\n3.2. spec.job 是抓取配置,必填,yaml格式,可参考输入示例,其中 instance_ids 可填写多个 CVM 实例 ID",
76
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"cvm-node-exporter-sd\",\n \"Content\": \"{\\\"kind\\\":\\\"cvm-node-exporter-sd\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: node-test\\\\ninstance:\\\\n - region: ap-chengdu\\\\n instance_ids:\\\\n - ins-a\\\\n - ins-b\\\\n\\\"}}\"\n}",
77
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"node-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
78
+ "title": "b. 创建 CVM Node Exporter 集成"
79
+ },
80
+ {
81
+ "document": "参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `cvm-http-sd-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. kind 是集成类型,必填且这里固定为 `cvm-http-sd-exporter`\n3.2. spec.job 是抓取配置,必填,yaml格式,具体配置可参考[抓取配置说明](https://cloud.tencent.com/document/product/1416/55995#%E4%BA%91%E6%9C%8D%E5%8A%A1%E5%99%A8%E6%9C%8D%E5%8A%A1%E5%8F%91%E7%8E%B0%E9%85%8D%E7%BD%AE)",
82
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"cvm-http-sd-exporter\",\n \"Content\": \"{\\\"kind\\\":\\\"cvm-http-sd-exporter\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: example-job-name\\\\nmetrics_path: /metrics\\\\ncvm_sd_configs:\\\\n- region: ap-singapore\\\\n ports:\\\\n - 9100\\\\n filters: \\\\n - name: tag:示例标签键\\\\n values: \\\\n - 示例标签值\\\\nrelabel_configs: \\\\n- source_labels: [__meta_cvm_instance_state]\\\\n regex: RUNNING\\\\n action: keep\\\\n- regex: __meta_cvm_tag_(.*)\\\\n replacement: $1\\\\n action: labelmap\\\\n- source_labels: [__meta_cvm_region]\\\\n target_label: region\\\\n action: replace\\\"}}\"\n}",
83
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"example-job-name\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
84
+ "title": "c. 创建 CVM 云服务器 集成"
85
+ },
86
+ {
87
+ "document": "参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `blackbox-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `blackbox-exporter`\n3.3. spec.instanceSpec.module 是探测方式,必填,可选值为 `http_get`、`http_post`、`tcp`、`ssh`、`ping`\n3.4. spec.instanceSpec.urls 是探测目标,字符串数组,必填,目标格式可以是 host:port 或 http://abc 或 https://abc\n3.5. spec.instanceSpec.noAllowRedirect 可以控制是否禁止重定向,布尔类型,选填,仅对探测方式 `http_get` 和 `http_post` 生效,true 表示禁止重定向,可直接不填,默认为 false\n3.6. spec.instanceSpec.insecureSkipVerify 可以控制是否禁用目标证书验证,布尔类型,选填,仅对探测方式 `http_get` 和 `http_post` 生效,true 表示禁用目标证书验证,可直接不填,默认为 false\n3.7. spec.instanceSpec.headers 用于在探测目标时添加 header,键值对类型,选填,仅对探测方式 `http_get` 和 `http_post` 生效\n3.8. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填\n3.9. spec.scrapeSpec.interval 用于自定义探测间隔,选填,默认是 15s",
88
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"blackbox-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"test\\\",\\\"kind\\\":\\\"blackbox-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"module\\\":\\\"http_get\\\",\\\"urls\\\":[\\\"host:port\\\",\\\"http://abc\\\",\\\"https://abc\\\"],\\\"noAllowRedirect\\\":false,\\\"insecureSkipVerify\\\":true,\\\"headers\\\":{\\\"Authorization\\\":\\\"Basic <Credentials>\\\",\\\"test\\\":\\\"test\\\"},\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"scrapeSpec\\\":{\\\"interval\\\":\\\"15s\\\"}}}\"\n}",
89
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
90
+ "title": "d. 创建 健康巡检 集成"
91
+ },
92
+ {
93
+ "document": "采集关联集群中的 Ingress NGINX Controller。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `nginx-ingress`,必填\n3. ClusterId 是与 Prometheus 实例关联且部署了 Ingress NGINX Controller 的集群 ID,必填\n4. KubeType 是 ClusterId 对应的集群类型,必填。1 表示 tke 集群,2 或 3 表示 eks 集群\n5. Content 参数格式如示例。说明如下:\n5.1. kind 是集成类型,必填且这里固定为 `nginx-ingress`\n5.2. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n5.3. spec.instanceSpec.namespace 是 Ingress NGINX Controller 所在的 namespace,必填\n5.4. spec.instanceSpec.name 是 Ingress NGINX Controller 的名字,必填。取 Deployment 或 DaemonSet 的名字\n5.5. spec.instanceSpec.workload 是 Ingress NGINX Controller 的集群对象类型,必填,比如 deployment 或者 daemonset",
94
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"ClusterId\": \"cls-test\",\n \"KubeType\": 1,\n \"Kind\": \"nginx-ingress\",\n \"Content\": \"{\\\"kind\\\":\\\"nginx-ingress\\\",\\\"name\\\":\\\"ingress-test\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"namespace\\\":\\\"namespace\\\",\\\"name\\\":\\\"controller-name\\\",\\\"workLoad\\\":\\\"deployment\\\"}}}\"\n}",
95
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"ingress-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
96
+ "title": "e. 创建 Ingress NGINX Controller 集成"
97
+ },
98
+ {
99
+ "document": "参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `cdwch-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. kind 是集成类型,必填且这里固定为 `cdwch-exporter`\n3.2. spec.job 是抓取配置,必填,yaml格式,建议参考输入示例,仅需修改任务名和实例 ID",
100
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"cdwch-exporter\",\n \"Content\": \"{\\\"kind\\\":\\\"cdwch-exporter\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: cdwch-example-job\\\\nmetrics_path: /metrics\\\\ncdwch_sd_configs:\\\\n- region: ap-guangzhou\\\\n instance_ids: \\\\n - cdwch-test\\\\nrelabel_configs:\\\\n- regex: __meta_cdwch_(.*)\\\\n replacement: $1\\\\n action: labelmap\\\"}}\"\n}",
101
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"cdwch-example-job\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
102
+ "title": "f. 创建 Cdwch 集成"
103
+ },
104
+ {
105
+ "document": "参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `emr-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n4.1. kind 是集成类型,必填且这里固定为 `emr-exporter`\n4.2. spec.job 是抓取配置,必填,yaml格式,具体可参考[EMR 接入文档](https://cloud.tencent.com/document/product/1416/92850#cb099aba-2dd3-42e6-bc10-69db3999a5a8)",
106
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"emr-exporter\",\n \"Content\": \"{\\\"kind\\\":\\\"emr-exporter\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: emr-example-job\\\\nmetrics_path: /metrics\\\\nemr_sd_configs:\\\\n- region: ap-guangzhou\\\\n instance_ids: \\\\n - emr-test\\\\nrelabel_configs:\\\\n- regex: __meta_emr_(.*)\\\\n replacement: $1\\\\n action: labelmap\\\"}}\"\n}",
107
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"emr-example-job\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
108
+ "title": "g. 创建 EMR 集成"
109
+ },
110
+ {
111
+ "document": "安装 免鉴权代理,可以免鉴权内网访问 Prometheus 原生 API。\n创建后可以调用 DescribeExporterIntegrations 接口,通过 InstanceDesc 参数获取集成的内网 IP:Port 地址,该地址可以代替 Prometheus 实例地址,实现免鉴权访问。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `raw-job`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. kind 是集成类型,必填且这里固定为 `raw-job`\n3.2. spec.spec.job 是 Prometheus 原生抓取配置,yaml格式,必填。可参考[配置说明文档](https://cloud.tencent.com/document/product/1416/55995#.E5.8E.9F.E7.94.9F-job-.E9.85.8D.E7.BD.AE)",
112
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"raw-job\",\n \"Content\": \"{\\\"kind\\\":\\\"raw-job\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: test\\\\nscrape_interval: 30s\\\\nstatic_configs:\\\\n- targets:\\\\n - 127.0.0.1:9090\\\"}}\"\n}",
71
113
  "output": "{\n \"Response\": {\n \"Names\": [\n \"test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
72
- "title": "创建 blackbox-exporter 集成"
114
+ "title": "h. 创建 抓取任务"
115
+ },
116
+ {
117
+ "document": "安装 Consul Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `consul-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `consul-exporter`\n3.3. spec.instanceSpec.server 是 Consul 实例的地址,必填\n3.4. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填",
118
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"consul-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"consul-test\\\",\\\"kind\\\":\\\"consul-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"server\\\":\\\"1.1.1.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
119
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"consul-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
120
+ "title": "i. 创建 Consul 集成"
121
+ },
122
+ {
123
+ "document": "安装 ElasticSearch Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `es-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `es-exporter`\n3.3. spec.instanceSpec.user 是 ElasticSearch 的用户名称,必填\n3.4. spec.instanceSpec.password 是 ElasticSearch 的密码,必填\n3.5. spec.instanceSpec.url 是 ElasticSearch 的连接地址,必填\n3.6. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填\n3.7. spec.exporterSpec.all 表示是否查询集群中所有节点的统计信息,布尔类型,选填,默认值为 false。false 则仅查询连接的节点的统计信息\n3.8. spec.exporterSpec.indices 表示是否查询集群中所有索引的统计信息,布尔类型,选填,默认值为 false\n3.9. spec.exporterSpec.indicesSettings 表示是否查询集群中所有索引配置的统计信息,布尔类型,选填,默认值为 false\n3.10. spec.exporterSpec.shards 表示是否查询集群中所有索引的统计信息,包括分片级别的统计信息,布尔类型,选填,默认值为 false。\n3.11. spec.exporterSpec.snapshots 表示是否查询集群快照的统计信息,布尔类型,选填,默认值为 false\n3.12. spec.exporterSpec.clusterSettings 表示是否查询集群配置的统计信息,布尔类型,选填,默认值为false",
124
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"es-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"es-test\\\",\\\"kind\\\":\\\"es-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"root\\\",\\\"password\\\":\\\"password\\\",\\\"url\\\":\\\"http://127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"all\\\":true,\\\"indices\\\":true,\\\"indicesSettings\\\":true,\\\"shards\\\":true,\\\"snapshots\\\":true,\\\"clusterSettings\\\":true}}}\"\n}",
125
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"es-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
126
+ "title": "j. 创建 ElasticSearch 集成"
127
+ },
128
+ {
129
+ "document": "安装 kafka Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `kafka-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `kafka-exporter`\n3.3. spec.instanceSpec.servers 是 Kafka 实例的地址,必填,可填写多个,建议一个实例一个集成\n3.4. spec.instanceSpec.version 是 Kafka 实例的版本,选填,部分版本不填写会报错,比如 0.10.2.0\n3.5. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填\n3.6. spec.exporterSpec.topicFilter 用于过滤 topic,可不填,默认全部采集。填写正则表达式后,只采集符合条件的 topic\n3.7. spec.exporterSpec.groupFilter 用于过滤 group,可不填,默认全部采集。填写正则表达式后,只采集符合条件的 group",
130
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"kafka-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"kafka-test\\\",\\\"kind\\\":\\\"kafka-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"servers\\\":[\\\"127.0.0.1:8080\\\"],\\\"version\\\":\\\"0.10.2.0\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"topicFilter\\\":\\\"topic.*\\\",\\\"groupFilter\\\":\\\"group.*\\\"}}}\"\n}",
131
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"kafka-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
132
+ "title": "k. 创建 Kafka 集成"
133
+ },
134
+ {
135
+ "document": "安装 RocketMQ Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `rocketmq-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `rocketmq-exporter`\n3.3. spec.instanceSpec.address 是 RocketMQ 实例的地址,必填,可填写多个,用分号分割\n3.4. spec.instanceSpec.version 是 RocketMQ 实例的版本,必填,比如 V4_9_4\n3.5. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填",
136
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"rocketmq-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"rocketmq-test\\\",\\\"kind\\\":\\\"rocketmq-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"address\\\":\\\"127.0.0.1:8080;127.0.0.2:8080\\\",\\\"version\\\":\\\"V4_9_4\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
137
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"rocketmq-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
138
+ "title": "l. 创建 RocketMQ 集成"
139
+ },
140
+ {
141
+ "document": "安装 Memcached Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `memcached-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `memcached-exporter`\n3.3. spec.instanceSpec.address 是 Memcached 实例的地址,必填\n3.4. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填",
142
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"memcached-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"memcached-test\\\",\\\"kind\\\":\\\"memcached-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
143
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"memcached-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
144
+ "title": "m. 创建 Memcached 集成"
145
+ },
146
+ {
147
+ "document": "安装 MongoDB Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `mongodb-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `mongodb-exporter`\n3.3. spec.instanceSpec.user 是 MongoDB 实例的用户名称,必填\n3.4. spec.instanceSpec.password 是 MongoDB 实例的密码,必填\n3.5. spec.instanceSpec.servers 是 MongoDB 实例的连接地址,必填,可填写多个,逗号分隔\n3.6. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填\n3.7. spec.exporterSpec.collectors 是 exporter 的采集配置,选填,字符串数组,示例中展示了所有可填写的值。其中`database` 表示启用数据库指标的采集,`collection`表示启用集合指标的采集,`topmetrics`表示启用数据库表头指标信息的采集,`indexusage`表示启用索引使用统计信息的采集,`connpoolstats`表示启用连接池统计信息的采集",
148
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"mongodb-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"mongodb-test\\\",\\\"kind\\\":\\\"mongodb-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"root\\\",\\\"password\\\":\\\"password\\\",\\\"servers\\\":[\\\"127.0.0.1:8080\\\",\\\"127.0.0.2:8080\\\"],\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"collectors\\\":[\\\"database\\\",\\\"collection\\\",\\\"topmetrics\\\",\\\"indexusage\\\",\\\"connpoolstats\\\"]}}}\"\n}",
149
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"mongodb-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
150
+ "title": "n. 创建 MongoDB 集成"
151
+ },
152
+ {
153
+ "document": "安装 MySQL Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `mysql-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `mysql-exporter`\n3.3. spec.instanceSpec.user 是 MySQL 实例的用户名称,必填\n3.4. spec.instanceSpec.password 是 MySQL 实例的密码,必填\n3.5. spec.instanceSpec.address 是 MySQL 实例的连接地址,必填\n3.6. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填",
154
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"mysql-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"mysql-test\\\",\\\"kind\\\":\\\"mysql-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"root\\\",\\\"password\\\":\\\"password\\\",\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
155
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"mysql-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
156
+ "title": "o. 创建 MySQL 集成"
157
+ },
158
+ {
159
+ "document": "安装 PostgreSQL Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `postgres-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `postgres-exporter`\n3.3. spec.instanceSpec.user 是 PostgreSQL 实例的用户名称,必填\n3.4. spec.instanceSpec.password 是 PostgreSQL 实例的密码,必填\n3.5. spec.instanceSpec.address 是 PostgreSQL 实例的连接地址,必填\n3.6. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填",
160
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"postgres-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"postgresql-test\\\",\\\"kind\\\":\\\"postgres-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"user\\\",\\\"password\\\":\\\"password\\\",\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
161
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"postgresql-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
162
+ "title": "p. 创建 PostgreSQL 集成"
163
+ },
164
+ {
165
+ "document": "安装 Redis Exporter。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `redis-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `redis-exporter`\n3.3. spec.instanceSpec.address 是 Redis 实例的连接地址,必填\n3.4. spec.instanceSpec.password 是 Redis 实例的密码,必填\n3.5. spec.instanceSpec.labels 用于给指标添加自定义标签,键值对类型,选填",
166
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"redis-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"redis-test\\\",\\\"kind\\\":\\\"redis-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"password\\\":\\\"password\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
167
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"redis-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
168
+ "title": "q. 创建 Redis 集成"
169
+ },
170
+ {
171
+ "document": "安装 Graphite Exporter,可以将 Graphite 指标转为 Prometheus 指标。\n创建后可以调用 DescribeExporterIntegrations 接口,通过 InstanceDesc 参数获取集成的内网 IP:Port 地址。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `graphite-exporter`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `graphite-exporter`\n3.3. spec.instanceSpec.isStrictMatch 表示是否严格匹配 mappingConfig,选填,默认是 false\n3.4. spec.instanceSpec.mappingConfig 是映射配置,可以定义 Prometheus 指标的名字和 label。具体可参考[官方文档](https://github.com/prometheus/graphite_exporter#yaml-config)",
172
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"graphite-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"graphite-test\\\",\\\"kind\\\":\\\"graphite-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"isStrictMatch\\\":true,\\\"mappingConfig\\\":\\\"mappings:\\\\n- match: test.dispatcher.*.*.*\\\\n name: dispatcher_events_total\\\\n labels:\\\\n action: $2\\\\n job: test_dispatcher\\\\n outcome: $3\\\\n processor: $1\\\\n- match: \\\\\\\"*.signup.*.*\\\\\\\"\\\\n name: signup_events_total\\\\n labels:\\\\n job: ${1}_server\\\\n outcome: $3\\\\n provider: $2\\\\n- match: \\\\\\\"servers.(.*).networking.subnetworks.transmissions.([a-z0-9-]+).(.*)\\\\\\\"\\\\n match_type: regex\\\\n name: \\\\\\\"servers_networking_transmissions_${3}\\\\\\\"\\\\n labels: \\\\n hostname: ${1}\\\\n device: ${2}\\\"}}}\"\n}",
173
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"graphite-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
174
+ "title": "r. 创建 Graphite 集成"
175
+ },
176
+ {
177
+ "document": "安装 免鉴权代理,可以免鉴权内网访问 Prometheus 原生 API。\n创建后可以调用 DescribeExporterIntegrations 接口,通过 InstanceDesc 参数获取集成的内网 IP:Port 地址,该地址可以代替 Prometheus 实例地址,实现免鉴权访问。\n参数说明:\n1. InstanceId 是 Prometheus 实例 ID,必填\n2. Kind 参数固定为 `auth-proxy`,必填\n3. Content 参数格式如示例。说明如下:\n3.1. name 是集成名,必填且全局唯一,需要符合正则表达式`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n3.2. kind 是集成类型,必填且这里固定为 `auth-proxy`\n3.3. spec.instanceSpec.enableSelfMonitor 表示是否采集自监控指标,选填,默认是 false。自监控指标是 auth_proxy_http_requests_total{result=~\"success|error\"},仅统计成功和失败的请求数量。",
178
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"auth-proxy\",\n \"Content\": \"{\\\"name\\\":\\\"auth-test\\\",\\\"kind\\\":\\\"auth-proxy\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"enableSelfMonitor\\\":true}}}\"\n}",
179
+ "output": "{\n \"Response\": {\n \"Names\": [\n \"auth-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
180
+ "title": "s. 创建 免鉴权代理 集成"
73
181
  }
74
182
  ],
75
183
  "CreateGrafanaInstance": [