tccli 3.0.909.1__py2.py3-none-any.whl → 3.0.910.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 (57) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cdn/v20180606/DescribeHttpsPackages.md +19 -18
  3. tccli/examples/cdn/v20180606/DescribeTrafficPackages.md +16 -14
  4. tccli/examples/cfs/v20190719/DescribeCfsFileSystems.md +31 -31
  5. tccli/examples/cfs/v20190719/UpdateCfsPGroup.md +1 -1
  6. tccli/examples/emr/v20190103/InquiryPriceRenewInstance.md +32 -1
  7. tccli/examples/es/v20180416/ModifyEsVipSecurityGroup.md +21 -0
  8. tccli/examples/ess/v20201111/CreateFlowReminds.md +3 -3
  9. tccli/examples/ess/v20201111/CreateFlowSignReview.md +2 -2
  10. tccli/examples/lcic/v20220817/DescribeDocument.md +52 -16
  11. tccli/examples/live/v20180801/DeleteLiveTranscodeTemplate.md +1 -1
  12. tccli/examples/monitor/v20180724/DeletePrometheusScrapeJobs.md +4 -4
  13. tccli/examples/monitor/v20180724/DescribeExporterIntegrations.md +5 -5
  14. tccli/examples/monitor/v20180724/DescribePrometheusAgents.md +10 -10
  15. tccli/examples/monitor/v20180724/DescribePrometheusScrapeJobs.md +8 -8
  16. tccli/examples/ocr/v20181119/DriverLicenseOCR.md +2 -2
  17. tccli/examples/vod/v20180717/DescribeRebuildMediaTemplates.md +2 -2
  18. tccli/examples/vod/v20180717/ModifyRebuildMediaTemplate.md +2 -2
  19. tccli/examples/vod/v20180717/RebuildMedia.md +2 -2
  20. tccli/examples/vod/v20180717/RebuildMediaByTemplate.md +2 -2
  21. tccli/examples/vpc/v20170312/DescribeSecurityGroups.md +1 -1
  22. tccli/examples/wedata/v20210820/DescribeColumnLineage.md +77 -0
  23. tccli/examples/wedata/v20210820/DescribeTableLineage.md +79 -0
  24. tccli/services/cdn/v20180606/api.json +49 -67
  25. tccli/services/cdn/v20180606/examples.json +3 -3
  26. tccli/services/cfs/v20190719/api.json +65 -26
  27. tccli/services/cfs/v20190719/examples.json +3 -3
  28. tccli/services/emr/v20190103/api.json +5 -12
  29. tccli/services/emr/v20190103/examples.json +7 -1
  30. tccli/services/es/es_client.py +65 -12
  31. tccli/services/es/v20180416/api.json +43 -0
  32. tccli/services/es/v20180416/examples.json +8 -0
  33. tccli/services/ess/v20201111/api.json +1 -1
  34. tccli/services/ess/v20201111/examples.json +3 -3
  35. tccli/services/essbasic/v20210526/api.json +9 -0
  36. tccli/services/lcic/v20220817/api.json +27 -16
  37. tccli/services/lcic/v20220817/examples.json +10 -4
  38. tccli/services/live/v20180801/api.json +3 -3
  39. tccli/services/live/v20180801/examples.json +1 -1
  40. tccli/services/monitor/v20180724/api.json +20 -24
  41. tccli/services/monitor/v20180724/examples.json +11 -11
  42. tccli/services/ocr/v20181119/api.json +22 -5
  43. tccli/services/ocr/v20181119/examples.json +1 -1
  44. tccli/services/tke/v20180525/api.json +14 -1
  45. tccli/services/tse/v20201207/api.json +20 -39
  46. tccli/services/vod/v20180717/api.json +33 -30
  47. tccli/services/vod/v20180717/examples.json +8 -8
  48. tccli/services/vpc/v20170312/api.json +21 -7
  49. tccli/services/vpc/v20170312/examples.json +1 -1
  50. tccli/services/wedata/v20210820/api.json +1146 -211
  51. tccli/services/wedata/v20210820/examples.json +16 -0
  52. tccli/services/wedata/wedata_client.py +106 -0
  53. {tccli-3.0.909.1.dist-info → tccli-3.0.910.1.dist-info}/METADATA +82 -3
  54. {tccli-3.0.909.1.dist-info → tccli-3.0.910.1.dist-info}/RECORD +57 -54
  55. {tccli-3.0.909.1.dist-info → tccli-3.0.910.1.dist-info}/WHEEL +0 -0
  56. {tccli-3.0.909.1.dist-info → tccli-3.0.910.1.dist-info}/entry_points.txt +0 -0
  57. {tccli-3.0.909.1.dist-info → tccli-3.0.910.1.dist-info}/license_files/LICENSE +0 -0
@@ -152,6 +152,14 @@
152
152
  "title": "获取接收客户端请求的节点类型"
153
153
  }
154
154
  ],
155
+ "ModifyEsVipSecurityGroup": [
156
+ {
157
+ "document": "修改集群VIP绑定的安全组信息",
158
+ "input": "POST / HTTP/1.1\nHost: es.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyEsVipSecurityGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"es-3p7lkvxx\",\n \"SecurityGroupIds\": [\n \"sg-1\",\n \"sg-2\"\n ]\n}",
159
+ "output": "{\n \"Response\": {\n \"RequestId\": \"c96a110c-7493-452d-a99b-683d07xxxxxx\"\n }\n}",
160
+ "title": "修改集群VIP绑定的安全组信息"
161
+ }
162
+ ],
155
163
  "RestartInstance": [
156
164
  {
157
165
  "document": "用以进行版本更新等操作",
@@ -2547,7 +2547,7 @@
2547
2547
  },
2548
2548
  {
2549
2549
  "disabled": false,
2550
- "document": "操作类型:\n操作类型,默认:SignReview;SignReview:签署审核\n注:接口通过该字段区分操作类型\n该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程\n若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)",
2550
+ "document": "操作类型:(接口通过该字段区分操作类型)\n\nSignReview:签署审核\nCreateReview:发起审核\n\n默认:SignReview;SignReview:签署审核\n\n该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程\n若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)",
2551
2551
  "example": "无",
2552
2552
  "member": "string",
2553
2553
  "name": "OperateType",
@@ -139,15 +139,15 @@
139
139
  "CreateFlowReminds": [
140
140
  {
141
141
  "document": "对合同中尚未完成的用户推送催办",
142
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowReminds\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"xxx\"\n },\n \"FlowIds\": [\n \"xxx\"\n ]\n}",
143
- "output": "{\n \"Response\": {\n \"RemindFlowRecords\": [\n {\n \"CanRemind\": true,\n \"FlowId\": \"xxx\",\n \"RemindMessage\": \"签署人 xxx: 此签署人已催办过;\"\n }\n ],\n \"RequestId\": \"s1675154686215203499\"\n }\n}",
142
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowReminds\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxMkUyxxxxxxxxxxxVI2JmKxPkk\"\n },\n \"FlowIds\": [\n \"yDwXiUUcxxxxxxxxxxSZ0uIW72Qaxm\"\n ]\n}",
143
+ "output": "{\n \"Response\": {\n \"RemindFlowRecords\": [\n {\n \"CanRemind\": true,\n \"FlowId\": \"yDwxxxxxxxW72Qaxm\",\n \"RemindMessage\": \"签署人 xxx: 此签署人已催办过;\"\n }\n ],\n \"RequestId\": \"s1675154686215203499\"\n }\n}",
144
144
  "title": "合同催办"
145
145
  }
146
146
  ],
147
147
  "CreateFlowSignReview": [
148
148
  {
149
149
  "document": "提交企业签署流程审批结果",
150
- "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowSignReview\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"1956103********520fde6a\"\n },\n \"FlowId\": \"xxxx\",\n \"ReviewType\": \"PASS\",\n \"ReviewMessage\": \"企业内部审核通过,允许签署\"\n}",
150
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFlowSignReview\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxMkUy************8VI2JmKxPkk\"\n },\n \"FlowId\": \"yDwXiUUc***********uIW72Qaxm\",\n \"ReviewType\": \"PASS\",\n \"ReviewMessage\": \"企业内部审核通过,允许签署\"\n}",
151
151
  "output": "{\n \"Response\": {\n \"RequestId\": \"s1234345677xxxx\"\n }\n}",
152
152
  "title": "提交企业签署流程审批结果"
153
153
  }
@@ -4942,6 +4942,15 @@
4942
4942
  "name": "SignId",
4943
4943
  "required": false,
4944
4944
  "type": "string"
4945
+ },
4946
+ {
4947
+ "disabled": false,
4948
+ "document": "SMS: 短信; NONE: 不发信息\n默认为SMS(该字段对子客无效)",
4949
+ "example": "SMS",
4950
+ "member": "string",
4951
+ "name": "NotifyType",
4952
+ "required": false,
4953
+ "type": "string"
4945
4954
  }
4946
4955
  ],
4947
4956
  "usage": "in"
@@ -185,7 +185,7 @@
185
185
  "DescribeDocuments": {
186
186
  "document": "有新接口替换\n\n批量获取文档信息(已废弃,替代接口BatchDescribeDocument)",
187
187
  "input": "DescribeDocumentsRequest",
188
- "name": "批量获取文档信息",
188
+ "name": "批量获取文档信息【已废弃】",
189
189
  "output": "DescribeDocumentsResponse",
190
190
  "status": "deprecated"
191
191
  },
@@ -2033,7 +2033,6 @@
2033
2033
  "document": "DescribeDocument请求参数结构体",
2034
2034
  "members": [
2035
2035
  {
2036
- "default": "",
2037
2036
  "disabled": false,
2038
2037
  "document": "文档Id(唯一id)",
2039
2038
  "example": "abc",
@@ -2054,7 +2053,7 @@
2054
2053
  "example": "abc",
2055
2054
  "member": "string",
2056
2055
  "name": "DocumentId",
2057
- "required": true,
2056
+ "output_required": true,
2058
2057
  "type": "string",
2059
2058
  "value_allowed_null": false
2060
2059
  },
@@ -2064,7 +2063,7 @@
2064
2063
  "example": "abc",
2065
2064
  "member": "string",
2066
2065
  "name": "DocumentUrl",
2067
- "required": true,
2066
+ "output_required": true,
2068
2067
  "type": "string",
2069
2068
  "value_allowed_null": false
2070
2069
  },
@@ -2074,7 +2073,7 @@
2074
2073
  "example": "abc",
2075
2074
  "member": "string",
2076
2075
  "name": "DocumentName",
2077
- "required": true,
2076
+ "output_required": true,
2078
2077
  "type": "string",
2079
2078
  "value_allowed_null": false
2080
2079
  },
@@ -2084,7 +2083,7 @@
2084
2083
  "example": "abc",
2085
2084
  "member": "string",
2086
2085
  "name": "Owner",
2087
- "required": true,
2086
+ "output_required": true,
2088
2087
  "type": "string",
2089
2088
  "value_allowed_null": false
2090
2089
  },
@@ -2094,7 +2093,7 @@
2094
2093
  "example": "123",
2095
2094
  "member": "uint64",
2096
2095
  "name": "SdkAppId",
2097
- "required": true,
2096
+ "output_required": true,
2098
2097
  "type": "int",
2099
2098
  "value_allowed_null": false
2100
2099
  },
@@ -2104,7 +2103,7 @@
2104
2103
  "example": "1",
2105
2104
  "member": "uint64",
2106
2105
  "name": "Permission",
2107
- "required": true,
2106
+ "output_required": true,
2108
2107
  "type": "int",
2109
2108
  "value_allowed_null": false
2110
2109
  },
@@ -2114,7 +2113,7 @@
2114
2113
  "example": "xx",
2115
2114
  "member": "string",
2116
2115
  "name": "TranscodeResult",
2117
- "required": true,
2116
+ "output_required": true,
2118
2117
  "type": "string",
2119
2118
  "value_allowed_null": false
2120
2119
  },
@@ -2124,7 +2123,7 @@
2124
2123
  "example": "1",
2125
2124
  "member": "uint64",
2126
2125
  "name": "TranscodeType",
2127
- "required": true,
2126
+ "output_required": true,
2128
2127
  "type": "int",
2129
2128
  "value_allowed_null": false
2130
2129
  },
@@ -2134,7 +2133,7 @@
2134
2133
  "example": "1",
2135
2134
  "member": "uint64",
2136
2135
  "name": "TranscodeProgress",
2137
- "required": true,
2136
+ "output_required": true,
2138
2137
  "type": "int",
2139
2138
  "value_allowed_null": false
2140
2139
  },
@@ -2144,7 +2143,7 @@
2144
2143
  "example": "1",
2145
2144
  "member": "uint64",
2146
2145
  "name": "TranscodeState",
2147
- "required": true,
2146
+ "output_required": true,
2148
2147
  "type": "int",
2149
2148
  "value_allowed_null": false
2150
2149
  },
@@ -2154,7 +2153,7 @@
2154
2153
  "example": "abc",
2155
2154
  "member": "string",
2156
2155
  "name": "TranscodeInfo",
2157
- "required": true,
2156
+ "output_required": true,
2158
2157
  "type": "string",
2159
2158
  "value_allowed_null": false
2160
2159
  },
@@ -2164,7 +2163,7 @@
2164
2163
  "example": "abc",
2165
2164
  "member": "string",
2166
2165
  "name": "DocumentType",
2167
- "required": true,
2166
+ "output_required": true,
2168
2167
  "type": "string",
2169
2168
  "value_allowed_null": false
2170
2169
  },
@@ -2174,7 +2173,7 @@
2174
2173
  "example": "1",
2175
2174
  "member": "uint64",
2176
2175
  "name": "DocumentSize",
2177
- "required": true,
2176
+ "output_required": true,
2178
2177
  "type": "int",
2179
2178
  "value_allowed_null": false
2180
2179
  },
@@ -2184,7 +2183,17 @@
2184
2183
  "example": "1",
2185
2184
  "member": "uint64",
2186
2185
  "name": "UpdateTime",
2187
- "required": true,
2186
+ "output_required": true,
2187
+ "type": "int",
2188
+ "value_allowed_null": false
2189
+ },
2190
+ {
2191
+ "disabled": false,
2192
+ "document": "课件页数",
2193
+ "example": "1",
2194
+ "member": "uint64",
2195
+ "name": "Pages",
2196
+ "output_required": false,
2188
2197
  "type": "int",
2189
2198
  "value_allowed_null": false
2190
2199
  },
@@ -2365,6 +2374,7 @@
2365
2374
  "example": "无",
2366
2375
  "member": "int64",
2367
2376
  "name": "Total",
2377
+ "output_required": true,
2368
2378
  "type": "int",
2369
2379
  "value_allowed_null": false
2370
2380
  },
@@ -2374,6 +2384,7 @@
2374
2384
  "example": "无",
2375
2385
  "member": "DocumentInfo",
2376
2386
  "name": "Documents",
2387
+ "output_required": true,
2377
2388
  "type": "list",
2378
2389
  "value_allowed_null": true
2379
2390
  },
@@ -202,10 +202,16 @@
202
202
  ],
203
203
  "DescribeDocument": [
204
204
  {
205
- "document": "",
206
- "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDocument\n<公共请求参数>\n\n{\n \"DocumentId\": \"xx\"\n}",
207
- "output": "{\n \"Response\": {\n \"UpdateTime\": 1,\n \"DocumentUrl\": \"xx\",\n \"TranscodeState\": 1,\n \"Permission\": 1,\n \"TranscodeType\": 1,\n \"DocumentName\": \"xx\",\n \"TranscodeInfo\": \"xx\",\n \"DocumentSize\": 1,\n \"TranscodeResult\": \"xx\",\n \"SdkAppId\": 1,\n \"DocumentType\": \"xx\",\n \"Owner\": \"xx\",\n \"TranscodeProgress\": 1,\n \"DocumentId\": \"xx\",\n \"RequestId\": \"xx\"\n }\n}",
208
- "title": "获取文档信息"
205
+ "document": "pdf 示例",
206
+ "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDocument\n<公共请求参数>\n\n{\n \"DocumentId\": \"omxxxsdc\"\n}",
207
+ "output": "{\n \"Response\": {\n \"DocumentId\": \"omxxxsdc\",\n \"DocumentName\": \"滴滴电子发票 (1).pdf\",\n \"DocumentSize\": 38673,\n \"DocumentType\": \"pdf\",\n \"DocumentUrl\": \"https://tcic-source.qcloudclass.com/uploads/5390248a-5eb7-4fe8-be27-c43dbad1380f/3520371/1679021408_KzpMGD38.pdf\",\n \"Owner\": \"2N1zP0mW7E3Vr3xJ2ZQ9GeFDK4t\",\n \"Pages\": 1,\n \"Permission\": 0,\n \"RequestId\": \"ee3fdca0-c88c-43f1-81b4-4f51f9e50521\",\n \"SdkAppId\": 3520371,\n \"TranscodeInfo\": \"\",\n \"TranscodeProgress\": 100,\n \"TranscodeResult\": \"https://tcic-test-1257307760.qcloudclass.com/doc/01aq2v7djsh31noat9gc_tiw/picture/\",\n \"TranscodeState\": 3,\n \"TranscodeType\": 1,\n \"UpdateTime\": 1679021410\n }\n}",
208
+ "title": "测试示例"
209
+ },
210
+ {
211
+ "document": "示例",
212
+ "input": "POST / HTTP/1.1\nHost: lcic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDocument\n<公共请求参数>\n\n{\n \"DocumentId\": \"ntxsfrzk\"\n}",
213
+ "output": "{\n \"Response\": {\n \"DocumentId\": \"ntxsfrzk\",\n \"DocumentName\": \"test.pptx\",\n \"DocumentSize\": 15814364,\n \"DocumentType\": \"pptx\",\n \"DocumentUrl\": \"https://tcic-source.qcloudclass.com/uploads/5390248a-5eb7-4fe8-be27-c43dbad1380f/3520371/1677202414_85bt9f0X.pptx\",\n \"Owner\": \"2M04q0j5mhsbq1lAEbCW1dhRvA2\",\n \"Pages\": 0,\n \"Permission\": 0,\n \"RequestId\": \"d97f98d7-de89-455a-a1f3-b9dae84d84bb\",\n \"SdkAppId\": 3520371,\n \"TranscodeInfo\": \"Microsoft Macintosh PowerPoint\",\n \"TranscodeProgress\": 100,\n \"TranscodeResult\": \"https://tcic-test-1257307760.qcloudclass.com/doc/gsutgbm7ssh31ns71sfc_tiw/h5/index.html\",\n \"TranscodeState\": 3,\n \"TranscodeType\": 1,\n \"UpdateTime\": 1677202419\n }\n}",
214
+ "title": "获取文档详情"
209
215
  }
210
216
  ],
211
217
  "DescribeDocuments": [
@@ -2899,7 +2899,7 @@
2899
2899
  },
2900
2900
  {
2901
2901
  "disabled": false,
2902
- "document": "完整目标 URL 地址。\n用法注意:如果使用该参数来传完整目标地址,则 DomainName, AppName, StreamName 需要传入空字符串,任务将会使用该 ToUrl 参数指定的目标地址。\n\n注意:签名时间需要超过任务结束时间,避免因签名过期造成任务失败。",
2902
+ "document": "完整目标 URL 地址。\n用法注意:如果使用该参数来传完整目标地址,则 DomainName, AppName, StreamName 需要传入空字符串,任务将会使用该 ToUrl 参数指定的目标地址。\n\n使用该方式传入目标地址支持的协议有:\nrtmp、rtmps、rtsp、rtp、srt。\n\n注意:签名时间需要超过任务结束时间,避免因签名过期造成任务失败。",
2903
2903
  "example": "无",
2904
2904
  "member": "string",
2905
2905
  "name": "ToUrl",
@@ -2963,6 +2963,7 @@
2963
2963
  "example": "无",
2964
2964
  "member": "string",
2965
2965
  "name": "TaskId",
2966
+ "output_required": true,
2966
2967
  "type": "string",
2967
2968
  "value_allowed_null": false
2968
2969
  },
@@ -5123,9 +5124,8 @@
5123
5124
  "document": "DeleteLiveTranscodeTemplate请求参数结构体",
5124
5125
  "members": [
5125
5126
  {
5126
- "default": "",
5127
5127
  "disabled": false,
5128
- "document": "模板 ID。\n1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。\n2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建的过的模板列表。",
5128
+ "document": "模板 ID。\n1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。\n2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建过的模板列表。",
5129
5129
  "example": "1000",
5130
5130
  "member": "int64",
5131
5131
  "name": "TemplateId",
@@ -346,7 +346,7 @@
346
346
  ],
347
347
  "DeleteLiveTranscodeTemplate": [
348
348
  {
349
- "document": "",
349
+ "document": "请求示例。",
350
350
  "input": "https://live.tencentcloudapi.com/?Action=DeleteLiveTranscodeTemplate\n&TemplateId=1000\n&<公共请求参数>",
351
351
  "output": "{\n \"Response\": {\n \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n }\n}",
352
352
  "title": "请求示例"
@@ -5236,27 +5236,27 @@
5236
5236
  "document": "DeletePrometheusScrapeJobs请求参数结构体",
5237
5237
  "members": [
5238
5238
  {
5239
- "default": "",
5240
5239
  "disabled": false,
5241
5240
  "document": "实例 ID",
5241
+ "example": " prom-evrh1x32",
5242
5242
  "member": "string",
5243
5243
  "name": "InstanceId",
5244
5244
  "required": true,
5245
5245
  "type": "string"
5246
5246
  },
5247
5247
  {
5248
- "default": "",
5249
5248
  "disabled": false,
5250
5249
  "document": "Agent ID",
5250
+ "example": "agent-hod16m43",
5251
5251
  "member": "string",
5252
5252
  "name": "AgentId",
5253
5253
  "required": true,
5254
5254
  "type": "string"
5255
5255
  },
5256
5256
  {
5257
- "default": "",
5258
5257
  "disabled": false,
5259
5258
  "document": "任务 ID 列表",
5259
+ "example": "[\"job-afeiigf\"]",
5260
5260
  "member": "string",
5261
5261
  "name": "JobIds",
5262
5262
  "required": true,
@@ -7726,17 +7726,15 @@
7726
7726
  "document": "DescribeExporterIntegrations请求参数结构体",
7727
7727
  "members": [
7728
7728
  {
7729
- "default": "",
7730
7729
  "disabled": false,
7731
7730
  "document": "实例 ID",
7732
- "example": "prom-xx",
7731
+ "example": "prom-evrh1x32",
7733
7732
  "member": "string",
7734
7733
  "name": "InstanceId",
7735
7734
  "required": true,
7736
7735
  "type": "string"
7737
7736
  },
7738
7737
  {
7739
- "default": "",
7740
7738
  "disabled": false,
7741
7739
  "document": "Kubernetes 集群类型,取值如下:\n<li> 1= 容器集群(TKE) </li>\n<li> 2=弹性集群<EKS> </li>\n<li> 3= Prometheus管理的弹性集群<MEKS> </li>",
7742
7740
  "example": "3",
@@ -7746,17 +7744,15 @@
7746
7744
  "type": "int"
7747
7745
  },
7748
7746
  {
7749
- "default": "",
7750
7747
  "disabled": false,
7751
7748
  "document": "集群 ID",
7752
- "example": "cls-xxx",
7749
+ "example": "cls-evrh1x32",
7753
7750
  "member": "string",
7754
7751
  "name": "ClusterId",
7755
7752
  "required": false,
7756
7753
  "type": "string"
7757
7754
  },
7758
7755
  {
7759
- "default": "",
7760
7756
  "disabled": false,
7761
7757
  "document": "类型",
7762
7758
  "example": "mysql-exporter",
@@ -7766,7 +7762,6 @@
7766
7762
  "type": "string"
7767
7763
  },
7768
7764
  {
7769
- "default": "",
7770
7765
  "disabled": false,
7771
7766
  "document": "名字",
7772
7767
  "example": "test",
@@ -7787,7 +7782,7 @@
7787
7782
  "example": "[]",
7788
7783
  "member": "IntegrationConfiguration",
7789
7784
  "name": "IntegrationSet",
7790
- "required": true,
7785
+ "output_required": true,
7791
7786
  "type": "list",
7792
7787
  "value_allowed_null": false
7793
7788
  },
@@ -10773,7 +10768,6 @@
10773
10768
  "document": "DescribePrometheusAgents请求参数结构体",
10774
10769
  "members": [
10775
10770
  {
10776
- "default": "",
10777
10771
  "disabled": false,
10778
10772
  "document": "实例 ID",
10779
10773
  "example": "xx",
@@ -10783,7 +10777,6 @@
10783
10777
  "type": "string"
10784
10778
  },
10785
10779
  {
10786
- "default": "",
10787
10780
  "disabled": false,
10788
10781
  "document": "Agent 名称",
10789
10782
  "example": "无",
@@ -10793,7 +10786,6 @@
10793
10786
  "type": "string"
10794
10787
  },
10795
10788
  {
10796
- "default": "",
10797
10789
  "disabled": false,
10798
10790
  "document": "Agent ID 列表",
10799
10791
  "example": "无",
@@ -10803,7 +10795,6 @@
10803
10795
  "type": "list"
10804
10796
  },
10805
10797
  {
10806
- "default": "",
10807
10798
  "disabled": false,
10808
10799
  "document": "偏移量,默认为0",
10809
10800
  "example": "无",
@@ -10813,7 +10804,6 @@
10813
10804
  "type": "int"
10814
10805
  },
10815
10806
  {
10816
- "default": "",
10817
10807
  "disabled": false,
10818
10808
  "document": "返回数量,默认为20,最大值为100",
10819
10809
  "example": "无",
@@ -10834,7 +10824,7 @@
10834
10824
  "example": "无",
10835
10825
  "member": "PrometheusAgent",
10836
10826
  "name": "AgentSet",
10837
- "required": true,
10827
+ "output_required": true,
10838
10828
  "type": "list",
10839
10829
  "value_allowed_null": true
10840
10830
  },
@@ -10844,7 +10834,7 @@
10844
10834
  "example": "12",
10845
10835
  "member": "int64",
10846
10836
  "name": "TotalCount",
10847
- "required": true,
10837
+ "output_required": true,
10848
10838
  "type": "int",
10849
10839
  "value_allowed_null": false
10850
10840
  },
@@ -11506,6 +11496,7 @@
11506
11496
  "example": "无",
11507
11497
  "member": "PrometheusInstancesOverview",
11508
11498
  "name": "Instances",
11499
+ "output_required": true,
11509
11500
  "type": "list",
11510
11501
  "value_allowed_null": false
11511
11502
  },
@@ -11515,6 +11506,7 @@
11515
11506
  "example": "1",
11516
11507
  "member": "uint64",
11517
11508
  "name": "Total",
11509
+ "output_required": true,
11518
11510
  "type": "int",
11519
11511
  "value_allowed_null": true
11520
11512
  },
@@ -11785,54 +11777,54 @@
11785
11777
  "document": "DescribePrometheusScrapeJobs请求参数结构体",
11786
11778
  "members": [
11787
11779
  {
11788
- "default": "",
11789
11780
  "disabled": false,
11790
11781
  "document": "实例 ID",
11782
+ "example": "prom-evrh1x32",
11791
11783
  "member": "string",
11792
11784
  "name": "InstanceId",
11793
11785
  "required": true,
11794
11786
  "type": "string"
11795
11787
  },
11796
11788
  {
11797
- "default": "",
11798
11789
  "disabled": false,
11799
11790
  "document": "Agent ID",
11791
+ "example": "agent-hod16m43",
11800
11792
  "member": "string",
11801
11793
  "name": "AgentId",
11802
11794
  "required": true,
11803
11795
  "type": "string"
11804
11796
  },
11805
11797
  {
11806
- "default": "",
11807
11798
  "disabled": false,
11808
11799
  "document": "任务名",
11800
+ "example": "node-exporter",
11809
11801
  "member": "string",
11810
11802
  "name": "Name",
11811
11803
  "required": false,
11812
11804
  "type": "string"
11813
11805
  },
11814
11806
  {
11815
- "default": "",
11816
11807
  "disabled": false,
11817
11808
  "document": "任务 ID 列表",
11809
+ "example": "[\"job-afeiigf\"]",
11818
11810
  "member": "string",
11819
11811
  "name": "JobIds",
11820
11812
  "required": false,
11821
11813
  "type": "list"
11822
11814
  },
11823
11815
  {
11824
- "default": "",
11825
11816
  "disabled": false,
11826
11817
  "document": "偏移量,默认为0",
11818
+ "example": "0",
11827
11819
  "member": "int64",
11828
11820
  "name": "Offset",
11829
11821
  "required": false,
11830
11822
  "type": "int"
11831
11823
  },
11832
11824
  {
11833
- "default": "",
11834
11825
  "disabled": false,
11835
11826
  "document": "返回数量,默认为20,最大值为100",
11827
+ "example": "20",
11836
11828
  "member": "int64",
11837
11829
  "name": "Limit",
11838
11830
  "required": false,
@@ -11847,16 +11839,20 @@
11847
11839
  {
11848
11840
  "disabled": false,
11849
11841
  "document": "任务列表\n注意:此字段可能返回 null,表示取不到有效值。",
11842
+ "example": "[{ \"AgentId\": \"agent-hod16m43\", \"Config\": \"job_name: static\\nhonor_timestamps: true\\nmetrics_path: /metrics\\nscheme: http\\nfollow_redirects: true\\nstatic_configs:\\n- targets:\\n - localhost:9090\\n\", \"Name\": \"node-exporter\", \"JobId\": \"job-afeiig0k\"}]",
11850
11843
  "member": "PrometheusScrapeJob",
11851
11844
  "name": "ScrapeJobSet",
11845
+ "output_required": true,
11852
11846
  "type": "list",
11853
11847
  "value_allowed_null": true
11854
11848
  },
11855
11849
  {
11856
11850
  "disabled": false,
11857
11851
  "document": "任务总量",
11852
+ "example": "12",
11858
11853
  "member": "int64",
11859
11854
  "name": "TotalCount",
11855
+ "output_required": true,
11860
11856
  "type": "int",
11861
11857
  "value_allowed_null": false
11862
11858
  },
@@ -310,8 +310,8 @@
310
310
  ],
311
311
  "DeletePrometheusScrapeJobs": [
312
312
  {
313
- "document": "",
314
- "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePrometheusScrapeJobs\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"AgentId\": \"xx\",\n \"JobIds\": [\n \"xx\"\n ]\n}",
313
+ "document": "删除 Prometheus 抓取任务",
314
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePrometheusScrapeJobs\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-evrh1x32\",\n \"AgentId\": \"agent-hod16m3f\",\n \"JobIds\": [\n \"job-afeiig0x\"\n ]\n}",
315
315
  "output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
316
316
  "title": "删除 Prometheus 抓取任务"
317
317
  }
@@ -512,9 +512,9 @@
512
512
  ],
513
513
  "DescribeExporterIntegrations": [
514
514
  {
515
- "document": "",
516
- "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeExporterIntegrations\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"Kind\": \"xx\",\n \"ClusterId\": \"xx\",\n \"KubeType\": 3\n}",
517
- "output": "{\n \"Response\": {\n \"RequestId\": \"xyz\",\n \"IntegrationSet\": []\n }\n}",
515
+ "document": "查询 exporter 集成列表",
516
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeExporterIntegrations\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-evrh1x32\",\n \"Kind\": \"mysql-exporter\",\n \"ClusterId\": \"cls-evrh1x32\",\n \"KubeType\": 3\n}",
517
+ "output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\",\n \"IntegrationSet\": []\n }\n}",
518
518
  "title": "查询 exporter 集成列表"
519
519
  }
520
520
  ],
@@ -648,9 +648,9 @@
648
648
  ],
649
649
  "DescribePrometheusAgents": [
650
650
  {
651
- "document": "",
652
- "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusAgents\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\"\n}",
653
- "output": "{\n \"Response\": {\n \"AgentSet\": [\n {\n \"AgentId\": \"xx\",\n \"Name\": \"xx\",\n \"InstanceId\": \"xx\",\n \"HeartbeatTime\": \"xx\",\n \"Ipv4\": \"xx\",\n \"LastError\": \"xx\",\n \"AgentVersion\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\",\n \"TotalCount\": 12\n }\n}",
651
+ "document": "查询 Prometheus Agent 列表",
652
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusAgents\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-m4fb9h34\"\n}",
653
+ "output": "{\n \"Response\": {\n \"AgentSet\": [\n {\n \"AgentId\": \"agent-hod16m34\",\n \"Name\": \"node-agent\",\n \"InstanceId\": \"prom-m4fb9h34\",\n \"HeartbeatTime\": \"2021-12-03T16:16:24+08:00\",\n \"Ipv4\": \"199.21.24.90\",\n \"LastError\": \"\",\n \"AgentVersion\": \"2.31.1-rig.1\"\n }\n ],\n \"RequestId\": \"e6a09531-0b40-41ab-a932-33061e9e1832\",\n \"TotalCount\": 12\n }\n}",
654
654
  "title": "列出 Prometheus Agent"
655
655
  }
656
656
  ],
@@ -758,9 +758,9 @@
758
758
  ],
759
759
  "DescribePrometheusScrapeJobs": [
760
760
  {
761
- "document": "",
762
- "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusScrapeJobs\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"AgentId\": \"xx\"\n}",
763
- "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"RequestId\": \"xx\",\n \"ScrapeJobSet\": [\n {\n \"AgentId\": \"xx\",\n \"Config\": \"xx\",\n \"Name\": \"xx\",\n \"JobId\": \"xx\"\n }\n ]\n }\n}",
761
+ "document": "查询 Prometheus 抓取任务列表",
762
+ "input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusScrapeJobs\n<公共请求参数>\n\n{\n \"InstanceId\": \"prom-evrh1x32\",\n \"AgentId\": \"agent-hod16m43\"\n}",
763
+ "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"RequestId\": \"5fa8c92-3072-4f46-8553-4cb82c30943c\",\n \"ScrapeJobSet\": [\n {\n \"AgentId\": \"agent-hod16m43\",\n \"Config\": \"job_name: static\\nhonor_timestamps: true\\nmetrics_path: /metrics\\nscheme: http\\nfollow_redirects: true\\nstatic_configs:\\n- targets:\\n - localhost:9090\\n\",\n \"Name\": \"node-exporter\",\n \"JobId\": \"job-afeiig0k\"\n }\n ]\n }\n}",
764
764
  "title": "列出 Prometheus 抓取任务"
765
765
  }
766
766
  ],