tencentcloud-sdk-nodejs 4.0.255 → 4.0.259

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (154) hide show
  1. package/CHANGELOG.md +939 -28
  2. package/package.json +1 -1
  3. package/products.md +42 -42
  4. package/src/common/sdk_version.ts +1 -1
  5. package/src/services/antiddos/v20200309/antiddos_models.ts +15 -0
  6. package/src/services/as/v20180419/as_client.ts +15 -1
  7. package/src/services/as/v20180419/as_models.ts +65 -5
  8. package/src/services/billing/v20180709/billing_models.ts +5 -5
  9. package/src/services/cam/v20190116/cam_models.ts +1 -1
  10. package/src/services/cat/v20180409/cat_client.ts +158 -55
  11. package/src/services/cat/v20180409/cat_models.ts +1535 -863
  12. package/src/services/cbs/v20170312/cbs_client.ts +6 -5
  13. package/src/services/cbs/v20170312/cbs_models.ts +112 -87
  14. package/src/services/cdn/v20180606/cdn_models.ts +11 -0
  15. package/src/services/cii/v20210408/cii_models.ts +7 -7
  16. package/src/services/ckafka/v20190819/ckafka_models.ts +14 -2
  17. package/src/services/clb/v20180317/clb_client.ts +24 -11
  18. package/src/services/clb/v20180317/clb_models.ts +155 -64
  19. package/src/services/cls/v20201016/cls_client.ts +71 -21
  20. package/src/services/cls/v20201016/cls_models.ts +259 -71
  21. package/src/services/cme/v20191029/cme_models.ts +10 -10
  22. package/src/services/dbbrain/v20210527/dbbrain_client.ts +14 -2
  23. package/src/services/dbbrain/v20210527/dbbrain_models.ts +100 -45
  24. package/src/services/dcdb/v20180411/dcdb_client.ts +12 -0
  25. package/src/services/dcdb/v20180411/dcdb_models.ts +35 -0
  26. package/src/services/dlc/v20210125/dlc_client.ts +4 -4
  27. package/src/services/dlc/v20210125/dlc_models.ts +170 -8
  28. package/src/services/dnspod/v20210323/dnspod_models.ts +8 -8
  29. package/src/services/eiam/v20210420/eiam_client.ts +230 -65
  30. package/src/services/eiam/v20210420/eiam_models.ts +1525 -729
  31. package/src/services/faceid/v20180301/faceid_client.ts +12 -0
  32. package/src/services/faceid/v20180301/faceid_models.ts +60 -0
  33. package/src/services/iotvideoindustry/v20201201/iotvideoindustry_client.ts +436 -57
  34. package/src/services/iotvideoindustry/v20201201/iotvideoindustry_models.ts +1721 -303
  35. package/src/services/lighthouse/v20200324/lighthouse_client.ts +202 -38
  36. package/src/services/lighthouse/v20200324/lighthouse_models.ts +765 -77
  37. package/src/services/live/v20180801/live_models.ts +12 -1
  38. package/src/services/mariadb/v20170312/mariadb_client.ts +12 -0
  39. package/src/services/mariadb/v20170312/mariadb_models.ts +30 -0
  40. package/src/services/mongodb/v20190725/mongodb_client.ts +19 -3
  41. package/src/services/mongodb/v20190725/mongodb_models.ts +297 -62
  42. package/src/services/monitor/v20180724/monitor_client.ts +26 -7
  43. package/src/services/monitor/v20180724/monitor_models.ts +320 -0
  44. package/src/services/mrs/v20200910/mrs_models.ts +6 -0
  45. package/src/services/ocr/v20181119/ocr_models.ts +2 -1
  46. package/src/services/rum/v20210622/rum_models.ts +24 -4
  47. package/src/services/scf/v20180416/scf_client.ts +1 -1
  48. package/src/services/scf/v20180416/scf_models.ts +1 -1
  49. package/src/services/sms/v20210111/sms_client.ts +3 -3
  50. package/src/services/sqlserver/v20180328/sqlserver_models.ts +10 -10
  51. package/src/services/sts/v20180813/sts_client.ts +13 -0
  52. package/src/services/sts/v20180813/sts_models.ts +45 -0
  53. package/src/services/tcb/v20180608/tcb_models.ts +1 -1
  54. package/src/services/tdmq/v20200217/tdmq_models.ts +11 -1
  55. package/src/services/thpc/v20211109/thpc_client.ts +14 -1
  56. package/src/services/thpc/v20211109/thpc_models.ts +89 -5
  57. package/src/services/tiia/v20190529/tiia_client.ts +1 -0
  58. package/src/services/tiia/v20190529/tiia_models.ts +31 -0
  59. package/src/services/tiw/v20190919/tiw_models.ts +2 -6
  60. package/src/services/tke/v20180525/tke_models.ts +8 -3
  61. package/src/services/tse/v20201207/tse_models.ts +5 -0
  62. package/src/services/vpc/v20170312/vpc_models.ts +68 -2
  63. package/tencentcloud/common/sdk_version.d.ts +1 -1
  64. package/tencentcloud/common/sdk_version.js +1 -1
  65. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +12 -0
  66. package/tencentcloud/services/as/v20180419/as_client.d.ts +5 -1
  67. package/tencentcloud/services/as/v20180419/as_client.js +6 -0
  68. package/tencentcloud/services/as/v20180419/as_models.d.ts +57 -5
  69. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +5 -5
  70. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +1 -1
  71. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +35 -3
  72. package/tencentcloud/services/cat/v20180409/cat_client.js +51 -3
  73. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1414 -844
  74. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +1 -1
  75. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +95 -74
  76. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +9 -0
  77. package/tencentcloud/services/cii/v20210408/cii_models.d.ts +7 -7
  78. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +12 -2
  79. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +9 -5
  80. package/tencentcloud/services/clb/v20180317/clb_client.js +11 -5
  81. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +133 -56
  82. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +27 -11
  83. package/tencentcloud/services/cls/v20201016/cls_client.js +36 -12
  84. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +229 -68
  85. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +8 -9
  86. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +5 -1
  87. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +6 -0
  88. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +83 -37
  89. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +5 -1
  90. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +6 -0
  91. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +30 -0
  92. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +4 -4
  93. package/tencentcloud/services/dlc/v20210125/dlc_client.js +4 -4
  94. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +141 -8
  95. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +8 -8
  96. package/tencentcloud/services/eiam/v20210420/eiam_client.d.ts +57 -5
  97. package/tencentcloud/services/eiam/v20210420/eiam_client.js +84 -6
  98. package/tencentcloud/services/eiam/v20210420/eiam_models.d.ts +1353 -673
  99. package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +5 -1
  100. package/tencentcloud/services/faceid/v20180301/faceid_client.js +6 -0
  101. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +50 -0
  102. package/tencentcloud/services/iotvideoindustry/v20201201/iotvideoindustry_client.d.ts +139 -15
  103. package/tencentcloud/services/iotvideoindustry/v20201201/iotvideoindustry_client.js +207 -21
  104. package/tencentcloud/services/iotvideoindustry/v20201201/iotvideoindustry_models.d.ts +1462 -245
  105. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +66 -14
  106. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +95 -17
  107. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +665 -75
  108. package/tencentcloud/services/live/v20180801/live_models.d.ts +11 -1
  109. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +5 -1
  110. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +6 -0
  111. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +26 -0
  112. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -1
  113. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -0
  114. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +249 -55
  115. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +11 -3
  116. package/tencentcloud/services/monitor/v20180724/monitor_client.js +13 -3
  117. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +275 -0
  118. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +5 -0
  119. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +2 -1
  120. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +20 -4
  121. package/tencentcloud/services/scf/v20180416/scf_client.d.ts +1 -1
  122. package/tencentcloud/services/scf/v20180416/scf_client.js +1 -1
  123. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +1 -1
  124. package/tencentcloud/services/sms/v20210111/sms_client.d.ts +3 -3
  125. package/tencentcloud/services/sms/v20210111/sms_client.js +3 -3
  126. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +10 -10
  127. package/tencentcloud/services/sts/v20180813/sts_client.d.ts +6 -1
  128. package/tencentcloud/services/sts/v20180813/sts_client.js +7 -0
  129. package/tencentcloud/services/sts/v20180813/sts_models.d.ts +38 -0
  130. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +1 -1
  131. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +9 -1
  132. package/tencentcloud/services/thpc/v20211109/thpc_client.d.ts +5 -1
  133. package/tencentcloud/services/thpc/v20211109/thpc_client.js +6 -0
  134. package/tencentcloud/services/thpc/v20211109/thpc_models.d.ts +76 -5
  135. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +26 -0
  136. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +2 -6
  137. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +7 -3
  138. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +4 -0
  139. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +59 -2
  140. package/test/as.v20180419.test.js +10 -0
  141. package/test/cat.v20180409.test.js +82 -2
  142. package/test/clb.v20180317.test.js +12 -2
  143. package/test/cls.v20201016.test.js +44 -4
  144. package/test/dbbrain.v20210527.test.js +10 -0
  145. package/test/dcdb.v20180411.test.js +10 -0
  146. package/test/eiam.v20210420.test.js +134 -4
  147. package/test/faceid.v20180301.test.js +10 -0
  148. package/test/iotvideoindustry.v20201201.test.js +324 -14
  149. package/test/lighthouse.v20200324.test.js +138 -8
  150. package/test/mariadb.v20170312.test.js +10 -0
  151. package/test/mongodb.v20190725.test.js +10 -0
  152. package/test/monitor.v20180724.test.js +12 -2
  153. package/test/sts.v20180813.test.js +10 -0
  154. package/test/thpc.v20211109.test.js +10 -0
@@ -15,36 +15,6 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
- /**
19
- * GetReturnCodeInfo返回参数结构体
20
- */
21
- export interface GetReturnCodeInfoResponse {
22
- /**
23
- * 拨测失败详情列表
24
- */
25
- Details?: Array<CatReturnDetail>
26
-
27
- /**
28
- * 拨测失败汇总列表
29
- */
30
- Summary?: Array<CatReturnSummary>
31
-
32
- /**
33
- * 开始时间
34
- */
35
- BeginTime?: string
36
-
37
- /**
38
- * 截至时间
39
- */
40
- EndTime?: string
41
-
42
- /**
43
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
44
- */
45
- RequestId?: string
46
- }
47
-
48
18
  /**
49
19
  * ModifyAgentGroup请求参数结构体
50
20
  */
@@ -70,16 +40,6 @@ export interface ModifyAgentGroupRequest {
70
40
  Agents: Array<CatAgent>
71
41
  }
72
42
 
73
- /**
74
- * BindAlarmPolicy返回参数结构体
75
- */
76
- export interface BindAlarmPolicyResponse {
77
- /**
78
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
79
- */
80
- RequestId?: string
81
- }
82
-
83
43
  /**
84
44
  * 拨测告警信息
85
45
  */
@@ -131,19 +91,14 @@ export interface AlarmInfo {
131
91
  }
132
92
 
133
93
  /**
134
- * GetDailyAvailRatio请求参数结构体
94
+ * CreateTaskEx返回参数结构体
135
95
  */
136
- export interface GetDailyAvailRatioRequest {
96
+ export interface CreateTaskExResponse {
137
97
  /**
138
- * 拨测任务Id
98
+ * 拨测结果查询ID。接下来可以使用查询拨测是否能够成功,验证能否通过。
139
99
  */
140
- TaskId: number
141
- }
100
+ ResultId?: number
142
101
 
143
- /**
144
- * ModifyTaskEx返回参数结构体
145
- */
146
- export interface ModifyTaskExResponse {
147
102
  /**
148
103
  * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
149
104
  */
@@ -156,244 +111,713 @@ export interface ModifyTaskExResponse {
156
111
  }
157
112
 
158
113
  /**
159
- * DescribeAgents请求参数结构体
114
+ * DescribeProbeNodes返回参数结构体
160
115
  */
161
- export type DescribeAgentsRequest = null
116
+ export interface DescribeProbeNodesResponse {
117
+ /**
118
+ * 节点列表
119
+ 注意:此字段可能返回 null,表示取不到有效值。
120
+ */
121
+ NodeSet: Array<NodeDefine>
122
+
123
+ /**
124
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
125
+ */
126
+ RequestId?: string
127
+ }
162
128
 
163
129
  /**
164
- * 拨测失败返回情况汇总
130
+ * RunTask请求参数结构体
165
131
  */
166
- export interface CatReturnSummary {
132
+ export interface RunTaskRequest {
167
133
  /**
168
- * 拨测失败个数
134
+ * 任务Id
169
135
  */
170
- ResultCount: number
136
+ TaskId: number
137
+ }
171
138
 
139
+ /**
140
+ * DescribeTaskDetail返回参数结构体
141
+ */
142
+ export interface DescribeTaskDetailResponse {
172
143
  /**
173
- * 拨测失败返回码
144
+ * 拨测任务列表
174
145
  */
175
- ResultCode: number
146
+ Tasks?: Array<CatTaskDetail>
176
147
 
177
148
  /**
178
- * 拨测失败原因描述
149
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
179
150
  */
180
- ErrorReason: string
151
+ RequestId?: string
181
152
  }
182
153
 
183
154
  /**
184
- * 拨测失败详情
155
+ * DeleteTasks返回参数结构体
185
156
  */
186
- export interface CatReturnDetail {
157
+ export interface DeleteTasksResponse {
187
158
  /**
188
- * 运营商名称
159
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
189
160
  */
190
- IspName: string
161
+ RequestId?: string
162
+ }
191
163
 
164
+ /**
165
+ * 任务信息和告警策略组
166
+ */
167
+ export interface CatTaskDetail {
192
168
  /**
193
- * 省份全拼
169
+ * 任务ID
194
170
  */
195
- Province: string
171
+ TaskId: number
196
172
 
197
173
  /**
198
- * 省份中文名称
174
+ * 任务名称
199
175
  */
200
- ProvinceName: string
176
+ TaskName: string
201
177
 
202
178
  /**
203
- * Map键值
179
+ * 任务周期,单位为分钟。目前支持1,5,15,30几种取值
204
180
  */
205
- MapKey: string
181
+ Period: number
206
182
 
207
183
  /**
208
- * 拨测目标的IP
184
+ * 拨测类型。http, https, ping, tcp 之一
209
185
  */
210
- ServerIp: string
186
+ CatTypeName: string
211
187
 
212
188
  /**
213
- * 拨测失败个数
189
+ * 拨测任务的URL
214
190
  */
215
- ResultCount: number
191
+ CgiUrl: string
216
192
 
217
193
  /**
218
- * 拨测失败返回码
194
+ * 拨测分组ID
219
195
  */
220
- ResultCode: number
196
+ AgentGroupId: number
221
197
 
222
198
  /**
223
- * 拨测失败原因描述
199
+ * 告警策略组ID
224
200
  */
225
- ErrorReason: string
226
- }
201
+ PolicyGroupId: number
227
202
 
228
- /**
229
- * RunTask请求参数结构体
230
- */
231
- export interface RunTaskRequest {
232
203
  /**
233
- * 任务Id
204
+ * 任务状态。1表示暂停,2表示运行中,0为初始态
234
205
  */
235
- TaskId: number
236
- }
206
+ Status?: number
237
207
 
238
- /**
239
- * 拨测点维度信息
240
- */
241
- export interface DimensionsDetail {
242
208
  /**
243
- * 运营商列表
209
+ * 任务创建时间
244
210
  */
245
- Isp?: Array<string>
211
+ AddTime?: string
246
212
 
247
213
  /**
248
- * 省份列表
214
+ * 任务类型。0 站点监控,2 可用性监控
249
215
  */
250
- Province?: Array<string>
251
- }
216
+ Type?: number
252
217
 
253
- /**
254
- * GetRespTimeTrendEx返回参数结构体
255
- */
256
- export interface GetRespTimeTrendExResponse {
257
218
  /**
258
- * 数据点集合,时延等走势数据
219
+ * 绑定的统一告警主题ID
259
220
  */
260
- DataPoints?: Array<DataPointMetric>
221
+ TopicId?: string
261
222
 
262
223
  /**
263
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
224
+ * 告警状态。0 未启用,1, 启用
264
225
  */
265
- RequestId?: string
266
- }
226
+ AlarmStatus?: number
267
227
 
268
- /**
269
- * ModifyAgentGroup返回参数结构体
270
- */
271
- export interface ModifyAgentGroupResponse {
272
228
  /**
273
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
229
+ * 指定的域名
274
230
  */
275
- RequestId?: string
276
- }
231
+ Host?: string
277
232
 
278
- /**
279
- * DescribeTaskDetail返回参数结构体
280
- */
281
- export interface DescribeTaskDetailResponse {
282
233
  /**
283
- * 拨测任务列表
234
+ * 拨测目标的端口号
284
235
  */
285
- Tasks?: Array<CatTaskDetail>
236
+ Port?: number
286
237
 
287
238
  /**
288
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
239
+ * 要在结果中进行匹配的字符串
289
240
  */
290
- RequestId?: string
291
- }
241
+ CheckStr?: string
292
242
 
293
- /**
294
- * 运营商可用率
295
- */
296
- export interface IspDetail {
297
243
  /**
298
- * 运营商名称
244
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
299
245
  */
300
- IspName: string
246
+ CheckType?: number
301
247
 
302
248
  /**
303
- * 可用率
249
+ * 用户Agent信息
304
250
  */
305
- AvailRatio: number
251
+ UserAgent?: string
306
252
 
307
253
  /**
308
- * 平均耗时
309
- 注意:此字段可能返回 null,表示取不到有效值。
310
- */
311
- AvgTime: number
312
- }
254
+ * 设置的Cookie信息
255
+ */
256
+ Cookie?: string
313
257
 
314
- /**
315
- * 包含MetricName的DataPoint数据
316
- */
317
- export interface DataPointMetric {
318
258
  /**
319
- * 数据项
259
+ * POST 请求数据。空字符串表示非POST请求
320
260
  */
321
- MetricName: string
261
+ PostData?: string
322
262
 
323
263
  /**
324
- * 数据点的时间和值
264
+ * SSL协议版本
325
265
  */
326
- Points: Array<DataPoint>
327
- }
266
+ SslVer?: string
328
267
 
329
- /**
330
- * GetReturnCodeInfo请求参数结构体
331
- */
332
- export interface GetReturnCodeInfoRequest {
333
268
  /**
334
- * 正整数。验证成功的拨测任务id
269
+ * 是否为Header请求。非0 Header 请求
335
270
  */
336
- TaskId: number
271
+ IsHeader?: number
337
272
 
338
273
  /**
339
- * 开始时间点。格式如:2017-05-09 10:20:00,最多拉群两天的数据
274
+ * 目的DNS服务器
340
275
  */
341
- BeginTime: string
276
+ DnsSvr?: string
342
277
 
343
278
  /**
344
- * 结束时间点。格式如:2017-05-09 10:25:00,最多拉群两天的数据
279
+ * 需要检验是否在DNS IP列表的IP
345
280
  */
346
- EndTime: string
281
+ DnsCheckIp?: string
347
282
 
348
283
  /**
349
- * 省份名称的全拼
284
+ * DNS查询类型
350
285
  */
351
- Province?: string
352
- }
286
+ DnsQueryType?: string
353
287
 
354
- /**
355
- * DescribeCatLogs请求参数结构体
356
- */
357
- export interface DescribeCatLogsRequest {
358
288
  /**
359
- * 拨测任务Id
289
+ * 登录服务器的账号
360
290
  */
361
- TaskId: number
291
+ UserName?: string
362
292
 
363
293
  /**
364
- * 从第Offset 条开始查询。缺省值为0
294
+ * 登录服务器的密码
365
295
  */
366
- Offset?: number
296
+ PassWord?: string
367
297
 
368
298
  /**
369
- * 本批次查询Limit 条记录。缺省值为20
299
+ * 是否使用安全链接SSL, 0 不使用,1 使用
370
300
  */
371
- Limit?: number
301
+ UseSecConn?: number
372
302
 
373
303
  /**
374
- * 格式如:2017-05-09 00:00:00 缺省为当天0点,最多拉取1天的数据
304
+ * FTP登录验证方式 0 不验证 1 匿名登录 2 需要身份验证
305
+ */
306
+ NeedAuth?: number
307
+
308
+ /**
309
+ * 请求数据类型。0 表示请求为字符串类型。1表示为二进制类型
310
+ */
311
+ ReqDataType?: number
312
+
313
+ /**
314
+ * 发起TCP, UDP请求的协议请求数据
315
+ */
316
+ ReqData?: string
317
+
318
+ /**
319
+ * 响应数据类型。0 表示响应为字符串类型。1表示为二进制类型
320
+ */
321
+ RespDataType?: number
322
+
323
+ /**
324
+ * 预期的UDP请求的回应数据
325
+ */
326
+ RespData?: string
327
+
328
+ /**
329
+ * 跟随跳转次数
330
+ */
331
+ RedirectFollowNum?: number
332
+ }
333
+
334
+ /**
335
+ * BindAlarmPolicy请求参数结构体
336
+ */
337
+ export interface BindAlarmPolicyRequest {
338
+ /**
339
+ * 拨测任务Id
340
+ */
341
+ TaskId: number
342
+
343
+ /**
344
+ * 告警策略组Id
345
+ */
346
+ PolicyGroupId: number
347
+
348
+ /**
349
+ * 是否绑定操作。非0 为绑定, 0 为 解绑。缺省表示 绑定。
350
+ */
351
+ IfBind?: number
352
+
353
+ /**
354
+ * 告警主题Id
355
+ */
356
+ TopicId?: string
357
+ }
358
+
359
+ /**
360
+ * DeleteProbeTask请求参数结构体
361
+ */
362
+ export interface DeleteProbeTaskRequest {
363
+ /**
364
+ * 任务 ID
365
+ */
366
+ TaskIds: Array<string>
367
+ }
368
+
369
+ /**
370
+ * 实时统计数据
371
+ */
372
+ export interface ResultSummary {
373
+ /**
374
+ * 统计时间
375
+ */
376
+ LogTime: string
377
+
378
+ /**
379
+ * 任务ID
380
+ */
381
+ TaskId: number
382
+
383
+ /**
384
+ * 实时可用率
385
+ */
386
+ AvailRatio: number
387
+
388
+ /**
389
+ * 实时响应时间
390
+ */
391
+ ReponseTime: number
392
+ }
393
+
394
+ /**
395
+ * DescribeDetailedSingleProbeData返回参数结构体
396
+ */
397
+ export interface DescribeDetailedSingleProbeDataResponse {
398
+ /**
399
+ * 单次详情数据
400
+ */
401
+ DataSet: Array<DetailedSingleDataDefine>
402
+
403
+ /**
404
+ * 符合条件的数据总数
405
+ */
406
+ TotalNumber: number
407
+
408
+ /**
409
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
410
+ */
411
+ RequestId?: string
412
+ }
413
+
414
+ /**
415
+ * DescribeAlarmsByTask请求参数结构体
416
+ */
417
+ export interface DescribeAlarmsByTaskRequest {
418
+ /**
419
+ * 拨测任务Id
420
+ */
421
+ TaskId: number
422
+
423
+ /**
424
+ * 从第Offset 条开始查询。缺省值为0
425
+ */
426
+ Offset?: number
427
+
428
+ /**
429
+ * 本批次查询Limit 条记录。缺省值为20
430
+ */
431
+ Limit?: number
432
+
433
+ /**
434
+ * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态
435
+ */
436
+ Status?: number
437
+
438
+ /**
439
+ * 格式如:2017-05-09 00:00:00 缺省为7天前0点
375
440
  */
376
441
  BeginTime?: string
377
442
 
378
443
  /**
379
- * 格式如:2017-05-10 00:00:00 缺省为当前时间
444
+ * 格式如:2017-05-10 00:00:00 缺省为明天0点
445
+ */
446
+ EndTime?: string
447
+
448
+ /**
449
+ * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time
450
+ */
451
+ SortBy?: string
452
+
453
+ /**
454
+ * 升序或降序。可为Desc, Asc之一。缺省为Desc
455
+ */
456
+ SortType?: string
457
+
458
+ /**
459
+ * 告警对象的名称
460
+ */
461
+ ObjName?: string
462
+ }
463
+
464
+ /**
465
+ * DescribeAlarms请求参数结构体
466
+ */
467
+ export interface DescribeAlarmsRequest {
468
+ /**
469
+ * 从第Offset 条开始查询。缺省值为0
470
+ */
471
+ Offset?: number
472
+
473
+ /**
474
+ * 本批次查询Limit 条记录。缺省值为20
475
+ */
476
+ Limit?: number
477
+
478
+ /**
479
+ * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态。
480
+ */
481
+ Status?: number
482
+
483
+ /**
484
+ * 格式如:2017-05-09 00:00:00 缺省为7天前0点
485
+ */
486
+ BeginTime?: string
487
+
488
+ /**
489
+ * 格式如:2017-05-10 00:00:00 缺省为明天0点
490
+ */
491
+ EndTime?: string
492
+
493
+ /**
494
+ * 告警任务名
495
+ */
496
+ ObjName?: string
497
+
498
+ /**
499
+ * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time。
500
+ */
501
+ SortBy?: string
502
+
503
+ /**
504
+ * 升序或降序。可为Desc, Asc之一。缺省为Desc。
505
+ */
506
+ SortType?: string
507
+ }
508
+
509
+ /**
510
+ * DescribeUserLimit返回参数结构体
511
+ */
512
+ export interface DescribeUserLimitResponse {
513
+ /**
514
+ * 用户可建立的最大任务数
515
+ */
516
+ MaxTaskNum?: number
517
+
518
+ /**
519
+ * 用户可用的最大拨测结点数
520
+ */
521
+ MaxAgentNum?: number
522
+
523
+ /**
524
+ * 用户可建立的最大拨测分组数
525
+ */
526
+ MaxGroupNum?: number
527
+
528
+ /**
529
+ * 用户可用的最小拨测间隔
530
+ */
531
+ MinPeriod?: number
532
+
533
+ /**
534
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
535
+ */
536
+ RequestId?: string
537
+ }
538
+
539
+ /**
540
+ * CreateTaskEx请求参数结构体
541
+ */
542
+ export interface CreateTaskExRequest {
543
+ /**
544
+ * http, https, ping, tcp, ftp, smtp, udp, dns 之一
545
+ */
546
+ CatTypeName: string
547
+
548
+ /**
549
+ * 拨测的URL, 例如:www.qq.com (URL域名解析需要能解析出具体的IP)
550
+ */
551
+ Url: string
552
+
553
+ /**
554
+ * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
555
+ */
556
+ Period: number
557
+
558
+ /**
559
+ * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
560
+ */
561
+ TaskName: string
562
+
563
+ /**
564
+ * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroups 接口,本参数使用返回结果里的GroupId的值。注意: Type为0时,AgentGroupId为必填
565
+ */
566
+ AgentGroupId?: number
567
+
568
+ /**
569
+ * 指定域名(如需要)
570
+ */
571
+ Host?: string
572
+
573
+ /**
574
+ * 是否为Header请求(非0 发起Header 请求。为0,且PostData 非空,发起POST请求。为0,PostData 为空,发起GET请求)
575
+ */
576
+ IsHeader?: number
577
+
578
+ /**
579
+ * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
580
+ */
581
+ SslVer?: string
582
+
583
+ /**
584
+ * POST请求数据。空字符串表示非POST请求
585
+ */
586
+ PostData?: string
587
+
588
+ /**
589
+ * 用户Agent信息
590
+ */
591
+ UserAgent?: string
592
+
593
+ /**
594
+ * 要在结果中进行匹配的字符串
595
+ */
596
+ CheckStr?: string
597
+
598
+ /**
599
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
600
+ */
601
+ CheckType?: number
602
+
603
+ /**
604
+ * 需要设置的Cookie信息
605
+ */
606
+ Cookie?: string
607
+
608
+ /**
609
+ * 任务ID,用于验证且修改任务时传入原任务ID
610
+ */
611
+ TaskId?: number
612
+
613
+ /**
614
+ * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
615
+ */
616
+ UserName?: string
617
+
618
+ /**
619
+ * 登录服务器的密码
620
+ */
621
+ PassWord?: string
622
+
623
+ /**
624
+ * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
625
+ */
626
+ ReqDataType?: number
627
+
628
+ /**
629
+ * 发起TCP, UDP请求的协议请求数据
630
+ */
631
+ ReqData?: string
632
+
633
+ /**
634
+ * 缺省为0。0 表示响应为字符串类型。1表示为二进制类型
635
+ */
636
+ RespDataType?: number
637
+
638
+ /**
639
+ * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
640
+ */
641
+ RespData?: string
642
+
643
+ /**
644
+ * 目的DNS服务器 可以为空字符串
645
+ */
646
+ DnsSvr?: string
647
+
648
+ /**
649
+ * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
650
+ */
651
+ DnsCheckIp?: string
652
+
653
+ /**
654
+ * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
655
+ */
656
+ DnsQueryType?: string
657
+
658
+ /**
659
+ * 是否使用安全链接SSL, 0 不使用,1 使用
660
+ */
661
+ UseSecConn?: number
662
+
663
+ /**
664
+ * FTP登录验证方式, 0 不验证 , 1 匿名登录, 2 需要身份验证
665
+ */
666
+ NeedAuth?: number
667
+
668
+ /**
669
+ * 拨测目标的端口号
380
670
  */
381
- EndTime?: string
671
+ Port?: number
382
672
 
383
673
  /**
384
- * 按时间升序或降序。默认降序。可选值: Desc, Asc
674
+ * Type=0 默认 (站点监控)Type=2 可用率监控
385
675
  */
386
- SortType?: string
676
+ Type?: number
677
+
678
+ /**
679
+ * IsVerify=0 非验证任务 IsVerify=1 验证任务,不传则默认为0
680
+ */
681
+ IsVerify?: number
682
+
683
+ /**
684
+ * 跟随跳转次数,取值范围0-5,不传则表示不跟随
685
+ */
686
+ RedirectFollowNum?: number
387
687
  }
388
688
 
389
689
  /**
390
- * DescribeAgents返回参数结构体
690
+ * PauseTask请求参数结构体
391
691
  */
392
- export interface DescribeAgentsResponse {
692
+ export interface PauseTaskRequest {
393
693
  /**
394
- * 本用户可选的拨测点列表
694
+ * 拨测任务id
395
695
  */
396
- Agents?: Array<CatAgent>
696
+ TaskId: number
697
+ }
698
+
699
+ /**
700
+ * GetResultSummary请求参数结构体
701
+ */
702
+ export interface GetResultSummaryRequest {
703
+ /**
704
+ * 任务Id列表
705
+ */
706
+ TaskIds: Array<number>
707
+ }
708
+
709
+ /**
710
+ * 探测任务
711
+ */
712
+ export interface ProbeTask {
713
+ /**
714
+ * 任务名
715
+ 注意:此字段可能返回 null,表示取不到有效值。
716
+ */
717
+ Name: string
718
+
719
+ /**
720
+ * 任务 ID
721
+ */
722
+ TaskId: string
723
+
724
+ /**
725
+ * 任务类型
726
+ */
727
+ TaskType: number
728
+
729
+ /**
730
+ * 探测节点列表
731
+ */
732
+ Nodes: Array<string>
733
+
734
+ /**
735
+ * 探测间隔
736
+ */
737
+ Interval: number
738
+
739
+ /**
740
+ * 探测参数
741
+ */
742
+ Parameters: string
743
+
744
+ /**
745
+ * 任务状态
746
+ */
747
+ Status: number
748
+
749
+ /**
750
+ * 目标地址
751
+ */
752
+ TargetAddress: string
753
+
754
+ /**
755
+ * 付费模式
756
+ <li>1 = 试用版本</li>
757
+ <li> 2 = 付费版本 </li>
758
+ */
759
+ PayMode: number
760
+
761
+ /**
762
+ * 订单状态
763
+ <li>1 = 正常</li>
764
+ <li> 2 = 欠费 </li>
765
+ */
766
+ OrderState: number
767
+
768
+ /**
769
+ * 任务分类
770
+ <li>1 = PC</li>
771
+ <li> 2 = Mobile </li>
772
+ */
773
+ TaskCategory: number
774
+
775
+ /**
776
+ * 创建时间
777
+ */
778
+ CreatedAt: string
779
+
780
+ /**
781
+ * 定时任务cron表达式
782
+ 注意:此字段可能返回 null,表示取不到有效值。
783
+ */
784
+ Cron: string
785
+
786
+ /**
787
+ * 定时任务启动状态
788
+ 注意:此字段可能返回 null,表示取不到有效值。
789
+ */
790
+ CronState: number
791
+ }
792
+
793
+ /**
794
+ * 时延等数据,数据点
795
+ */
796
+ export interface DataPoint {
797
+ /**
798
+ * 数据点的时间
799
+ */
800
+ LogTime: string
801
+
802
+ /**
803
+ * 数据值
804
+ */
805
+ MetricValue: number
806
+ }
807
+
808
+ /**
809
+ * DescribeAlarmTopic返回参数结构体
810
+ */
811
+ export interface DescribeAlarmTopicResponse {
812
+ /**
813
+ * 主题个数
814
+ */
815
+ TotalCount?: number
816
+
817
+ /**
818
+ * 主题列表
819
+ */
820
+ Topics?: Array<AlarmTopic>
397
821
 
398
822
  /**
399
823
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -402,68 +826,134 @@ export interface DescribeAgentsResponse {
402
826
  }
403
827
 
404
828
  /**
405
- * GetAvailRatioHistory返回参数结构体
829
+ * DescribeUserLimit请求参数结构体
406
830
  */
407
- export interface GetAvailRatioHistoryResponse {
831
+ export type DescribeUserLimitRequest = null
832
+
833
+ /**
834
+ * 保存string类型字段
835
+ */
836
+ export interface Label {
408
837
  /**
409
- * 整体平均可用率
838
+ * 自定义字段编号
410
839
  */
411
- AvgAvailRatio?: number
840
+ ID: number
412
841
 
413
842
  /**
414
- * 各省份最低可用率
843
+ * 自定义字段名称/说明
415
844
  */
416
- LowestAvailRatio?: number
845
+ Name: string
417
846
 
418
847
  /**
419
- * 可用率最低的省份
848
+ * 字段值
420
849
  */
421
- LowestProvince?: string
850
+ Value: string
851
+ }
852
+
853
+ /**
854
+ * DescribeAgents请求参数结构体
855
+ */
856
+ export type DescribeAgentsRequest = null
422
857
 
858
+ /**
859
+ * 拨测失败详情
860
+ */
861
+ export interface CatReturnDetail {
423
862
  /**
424
- * 可用率最低的运营商
863
+ * 运营商名称
425
864
  */
426
- LowestIsp?: string
865
+ IspName: string
427
866
 
428
867
  /**
429
- * 分省份的可用率数据
868
+ * 省份全拼
430
869
  */
431
- ProvinceData?: Array<ProvinceDetail>
870
+ Province: string
432
871
 
433
872
  /**
434
- * 国内平均耗时,单位毫秒
873
+ * 省份中文名称
435
874
  */
436
- AvgTime?: number
875
+ ProvinceName: string
437
876
 
438
877
  /**
439
- * 国外平均可用率
878
+ * Map键值
440
879
  */
441
- AvgAvailRatio2?: number
880
+ MapKey: string
442
881
 
443
882
  /**
444
- * 国外平均耗时,单位毫秒
883
+ * 拨测目标的IP
445
884
  */
446
- AvgTime2?: number
885
+ ServerIp: string
447
886
 
448
887
  /**
449
- * 国外最低可用率
888
+ * 拨测失败个数
450
889
  */
451
- LowestAvailRatio2?: number
890
+ ResultCount: number
452
891
 
453
892
  /**
454
- * 国外可用率最低的区域
893
+ * 拨测失败返回码
455
894
  */
456
- LowestProvince2?: string
895
+ ResultCode: number
457
896
 
458
897
  /**
459
- * 国外可用率最低的运营商
898
+ * 拨测失败原因描述
460
899
  */
461
- LowestIsp2?: string
900
+ ErrorReason: string
901
+ }
902
+
903
+ /**
904
+ * 运营商可用率
905
+ */
906
+ export interface IspDetail {
907
+ /**
908
+ * 运营商名称
909
+ */
910
+ IspName: string
462
911
 
463
912
  /**
464
- * 国外分区域的可用率数据
913
+ * 可用率
465
914
  */
466
- ProvinceData2?: Array<ProvinceDetail>
915
+ AvailRatio: number
916
+
917
+ /**
918
+ * 平均耗时
919
+ 注意:此字段可能返回 null,表示取不到有效值。
920
+ */
921
+ AvgTime: number
922
+ }
923
+
924
+ /**
925
+ * GetReturnCodeInfo请求参数结构体
926
+ */
927
+ export interface GetReturnCodeInfoRequest {
928
+ /**
929
+ * 正整数。验证成功的拨测任务id
930
+ */
931
+ TaskId: number
932
+
933
+ /**
934
+ * 开始时间点。格式如:2017-05-09 10:20:00,最多拉群两天的数据
935
+ */
936
+ BeginTime: string
937
+
938
+ /**
939
+ * 结束时间点。格式如:2017-05-09 10:25:00,最多拉群两天的数据
940
+ */
941
+ EndTime: string
942
+
943
+ /**
944
+ * 省份名称的全拼
945
+ */
946
+ Province?: string
947
+ }
948
+
949
+ /**
950
+ * DescribeAgents返回参数结构体
951
+ */
952
+ export interface DescribeAgentsResponse {
953
+ /**
954
+ * 本用户可选的拨测点列表
955
+ */
956
+ Agents?: Array<CatAgent>
467
957
 
468
958
  /**
469
959
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -476,54 +966,79 @@ export interface GetAvailRatioHistoryResponse {
476
966
  */
477
967
  export interface CreateAgentGroupResponse {
478
968
  /**
479
- * 拨测分组Id
969
+ * 拨测分组Id
970
+ */
971
+ GroupId?: number
972
+
973
+ /**
974
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
975
+ */
976
+ RequestId?: string
977
+ }
978
+
979
+ /**
980
+ * DescribeDetailedSingleProbeData请求参数结构体
981
+ */
982
+ export interface DescribeDetailedSingleProbeDataRequest {
983
+ /**
984
+ * 开始时间戳(毫秒级)
985
+ */
986
+ BeginTime: number
987
+
988
+ /**
989
+ * 结束时间戳(毫秒级)
990
+ */
991
+ EndTime: number
992
+
993
+ /**
994
+ * 任务类型
995
+ */
996
+ TaskType: string
997
+
998
+ /**
999
+ * 待排序字段
1000
+ */
1001
+ SortField: string
1002
+
1003
+ /**
1004
+ * true表示升序
1005
+ */
1006
+ Ascending: boolean
1007
+
1008
+ /**
1009
+ * 选中字段
480
1010
  */
481
- GroupId?: number
1011
+ SelectedFields: Array<string>
482
1012
 
483
1013
  /**
484
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1014
+ * 起始取数位置
485
1015
  */
486
- RequestId?: string
487
- }
1016
+ Offset: number
488
1017
 
489
- /**
490
- * DeleteTasks返回参数结构体
491
- */
492
- export interface DeleteTasksResponse {
493
1018
  /**
494
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1019
+ * 取数数量
495
1020
  */
496
- RequestId?: string
497
- }
1021
+ Limit: number
498
1022
 
499
- /**
500
- * DescribeAlarms返回参数结构体
501
- */
502
- export interface DescribeAlarmsResponse {
503
1023
  /**
504
- * 告警总条数
1024
+ * 任务ID
505
1025
  */
506
- TotalCount?: number
1026
+ TaskID?: Array<string>
507
1027
 
508
1028
  /**
509
- * 本批告警信息列表
1029
+ * 拨测点运营商
510
1030
  */
511
- AlarmInfos?: Array<AlarmInfo>
1031
+ Operators?: Array<string>
512
1032
 
513
1033
  /**
514
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1034
+ * 拨测点地区
515
1035
  */
516
- RequestId?: string
517
- }
1036
+ Districts?: Array<string>
518
1037
 
519
- /**
520
- * GetRealAvailRatio请求参数结构体
521
- */
522
- export interface GetRealAvailRatioRequest {
523
1038
  /**
524
- * 拨测任务Id
1039
+ * 错误类型
525
1040
  */
526
- TaskId: number
1041
+ ErrorTypes?: Array<string>
527
1042
  }
528
1043
 
529
1044
  /**
@@ -572,118 +1087,133 @@ export interface AgentGroup {
572
1087
  }
573
1088
 
574
1089
  /**
575
- * DescribeTaskDetail请求参数结构体
1090
+ * GetReturnCodeHistory请求参数结构体
576
1091
  */
577
- export interface DescribeTaskDetailRequest {
1092
+ export interface GetReturnCodeHistoryRequest {
578
1093
  /**
579
- * 拨测任务id 数组
1094
+ * 正整数。验证成功的拨测任务id
580
1095
  */
581
- TaskIds: Array<number>
582
- }
1096
+ TaskId: number
583
1097
 
584
- /**
585
- * DescribeTasksByType返回参数结构体
586
- */
587
- export interface DescribeTasksByTypeResponse {
588
1098
  /**
589
- * 符合条件的总任务数
1099
+ * 开始时间点。格式如:2017-05-09 10:20:00。注意,BeginTime 和 EndTime 需要在同一天
590
1100
  */
591
- TotalCount?: number
1101
+ BeginTime: string
592
1102
 
593
1103
  /**
594
- * 任务列表
1104
+ * 结束时间点。格式如:2017-05-09 10:25:00。注意,BeginTime 和 EndTime 需要在同一天
595
1105
  */
596
- Tasks?: Array<TaskAlarm>
1106
+ EndTime: string
597
1107
 
598
1108
  /**
599
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1109
+ * 省份名称的全拼
600
1110
  */
601
- RequestId?: string
1111
+ Province: string
602
1112
  }
603
1113
 
604
1114
  /**
605
- * GetResultSummary返回参数结构体
1115
+ * 省份可用率
606
1116
  */
607
- export interface GetResultSummaryResponse {
1117
+ export interface ProvinceDetail {
608
1118
  /**
609
- * 实时统计数据
1119
+ * 可用率
610
1120
  */
611
- RealData?: Array<ResultSummary>
1121
+ AvgAvailRatio: number
612
1122
 
613
1123
  /**
614
- * 按天的统计数据
1124
+ * 省份名称
615
1125
  */
616
- DayData?: Array<ResultSummary>
1126
+ ProvinceName: string
617
1127
 
618
1128
  /**
619
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1129
+ * 省份英文名称
620
1130
  */
621
- RequestId?: string
622
- }
1131
+ Mapkey: string
623
1132
 
624
- /**
625
- * GetReturnCodeHistory请求参数结构体
626
- */
627
- export interface GetReturnCodeHistoryRequest {
628
1133
  /**
629
- * 正整数。验证成功的拨测任务id
1134
+ * 统计时间点
630
1135
  */
631
- TaskId: number
1136
+ TimeStamp: string
632
1137
 
633
1138
  /**
634
- * 开始时间点。格式如:2017-05-09 10:20:00。注意,BeginTime 和 EndTime 需要在同一天
1139
+ * 分运营商可用率
635
1140
  */
636
- BeginTime: string
1141
+ IspDetail: Array<IspDetail>
637
1142
 
638
1143
  /**
639
- * 结束时间点。格式如:2017-05-09 10:25:00。注意,BeginTime 和 EndTime 需要在同一天
1144
+ * 平均耗时,单位毫秒
640
1145
  */
641
- EndTime: string
1146
+ AvgTime: number
642
1147
 
643
1148
  /**
644
- * 省份名称的全拼
1149
+ * 省份
645
1150
  */
646
1151
  Province: string
647
1152
  }
648
1153
 
649
1154
  /**
650
- * BindAlarmPolicy请求参数结构体
1155
+ * GetRealAvailRatio返回参数结构体
651
1156
  */
652
- export interface BindAlarmPolicyRequest {
1157
+ export interface GetRealAvailRatioResponse {
653
1158
  /**
654
- * 拨测任务Id
1159
+ * 国内平均可用率
655
1160
  */
656
- TaskId: number
1161
+ AvgAvailRatio?: number
657
1162
 
658
1163
  /**
659
- * 告警策略组Id
1164
+ * 各省份最低可用率
660
1165
  */
661
- PolicyGroupId: number
1166
+ LowestAvailRatio?: number
662
1167
 
663
1168
  /**
664
- * 是否绑定操作。非0 为绑定, 0 为 解绑。缺省表示 绑定。
1169
+ * 可用率最低的省份
665
1170
  */
666
- IfBind?: number
1171
+ LowestProvince?: string
667
1172
 
668
1173
  /**
669
- * 告警主题Id
1174
+ * 可用率最低的运营商
670
1175
  */
671
- TopicId?: string
672
- }
1176
+ LowestIsp?: string
673
1177
 
674
- /**
675
- * DescribeAgentGroups返回参数结构体
676
- */
677
- export interface DescribeAgentGroupsResponse {
678
1178
  /**
679
- * 用户所属的系统默认拨测分组
1179
+ * 分省份的可用率数据
680
1180
  */
681
- SysDefaultGroup?: AgentGroup
1181
+ ProvinceData?: Array<ProvinceDetail>
682
1182
 
683
1183
  /**
684
- * 用户创建的拨测分组列表
1184
+ * 国内平均耗时,单位毫秒
685
1185
  */
686
- CustomGroups?: Array<AgentGroup>
1186
+ AvgTime?: number
1187
+
1188
+ /**
1189
+ * 国外平均可用率
1190
+ */
1191
+ AvgAvailRatio2?: number
1192
+
1193
+ /**
1194
+ * 国外平均耗时,单位毫秒
1195
+ */
1196
+ AvgTime2?: number
1197
+
1198
+ /**
1199
+ * 国外最低可用率
1200
+ */
1201
+ LowestAvailRatio2?: number
1202
+
1203
+ /**
1204
+ * 国外可用率最低的区域
1205
+ */
1206
+ LowestProvince2?: string
1207
+
1208
+ /**
1209
+ * 国外可用率最低的运营商
1210
+ */
1211
+ LowestIsp2?: string
1212
+
1213
+ /**
1214
+ * 国外分区域的可用率数据
1215
+ */
1216
+ ProvinceData2?: Array<ProvinceDetail>
687
1217
 
688
1218
  /**
689
1219
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -692,229 +1222,261 @@ export interface DescribeAgentGroupsResponse {
692
1222
  }
693
1223
 
694
1224
  /**
695
- * 省份可用率
1225
+ * UpdateProbeTaskConfigurationList返回参数结构体
696
1226
  */
697
- export interface ProvinceDetail {
1227
+ export interface UpdateProbeTaskConfigurationListResponse {
698
1228
  /**
699
- * 可用率
1229
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
700
1230
  */
701
- AvgAvailRatio: number
1231
+ RequestId?: string
1232
+ }
702
1233
 
1234
+ /**
1235
+ * CreateAgentGroup请求参数结构体
1236
+ */
1237
+ export interface CreateAgentGroupRequest {
703
1238
  /**
704
- * 省份名称
1239
+ * 拨测分组名称,不超过32个字符
705
1240
  */
706
- ProvinceName: string
1241
+ GroupName: string
707
1242
 
708
1243
  /**
709
- * 省份英文名称
1244
+ * 是否为默认分组,取值可为 0 或 1。取 1 时表示设置为默认分组
710
1245
  */
711
- Mapkey: string
1246
+ IsDefault: number
712
1247
 
713
1248
  /**
714
- * 统计时间点
1249
+ * Province, Isp 需要成对地进行选择。参数对的取值范围。参见:DescribeAgents 的返回结果。
715
1250
  */
716
- TimeStamp: string
1251
+ Agents: Array<CatAgent>
1252
+ }
717
1253
 
1254
+ /**
1255
+ * ResumeProbeTask返回参数结构体
1256
+ */
1257
+ export interface ResumeProbeTaskResponse {
718
1258
  /**
719
- * 分运营商可用率
1259
+ * 任务总量
720
1260
  */
721
- IspDetail: Array<IspDetail>
1261
+ Total: number
722
1262
 
723
1263
  /**
724
- * 平均耗时,单位毫秒
1264
+ * 任务成功量
1265
+ 注意:此字段可能返回 null,表示取不到有效值。
1266
+ */
1267
+ SuccessCount: number
1268
+
1269
+ /**
1270
+ * 任务执行详情
1271
+ 注意:此字段可能返回 null,表示取不到有效值。
1272
+ */
1273
+ Results: Array<TaskResult>
1274
+
1275
+ /**
1276
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
725
1277
  */
726
- AvgTime: number
1278
+ RequestId?: string
1279
+ }
727
1280
 
1281
+ /**
1282
+ * ModifyTaskEx返回参数结构体
1283
+ */
1284
+ export interface ModifyTaskExResponse {
728
1285
  /**
729
- * 省份
1286
+ * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
730
1287
  */
731
- Province: string
1288
+ TaskId?: number
1289
+
1290
+ /**
1291
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1292
+ */
1293
+ RequestId?: string
732
1294
  }
733
1295
 
734
1296
  /**
735
- * 告警主题
1297
+ * DescribeAlarmsByTask返回参数结构体
736
1298
  */
737
- export interface AlarmTopic {
1299
+ export interface DescribeAlarmsByTaskResponse {
738
1300
  /**
739
- * 主题的ID
1301
+ * 告警信息列表
740
1302
  */
741
- TopicId: string
1303
+ AlarmInfos?: Array<AlarmInfo>
742
1304
 
743
1305
  /**
744
- * 主题的名称
1306
+ * 故障率
745
1307
  */
746
- TopicName: string
1308
+ FaultRatio?: number
1309
+
1310
+ /**
1311
+ * 故障总时长
1312
+ */
1313
+ FaultTimeSpec?: string
1314
+
1315
+ /**
1316
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1317
+ */
1318
+ RequestId?: string
747
1319
  }
748
1320
 
749
1321
  /**
750
- * 实时统计数据
1322
+ * ModifyTaskEx请求参数结构体
751
1323
  */
752
- export interface ResultSummary {
1324
+ export interface ModifyTaskExRequest {
753
1325
  /**
754
- * 统计时间
1326
+ * http, https, ping, tcp, ftp, smtp, udp, dns 之一
755
1327
  */
756
- LogTime: string
1328
+ CatTypeName: string
1329
+
1330
+ /**
1331
+ * 拨测的URL,例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1332
+ */
1333
+ Url: string
1334
+
1335
+ /**
1336
+ * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1337
+ */
1338
+ Period: number
1339
+
1340
+ /**
1341
+ * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1342
+ */
1343
+ TaskName: string
1344
+
1345
+ /**
1346
+ * 验证成功的拨测任务ID
1347
+ */
1348
+ TaskId: number
757
1349
 
758
1350
  /**
759
- * 任务ID
1351
+ * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroupList 接口,本参数使用返回结果里的GroupId的值。注意,Type为0时,AgentGroupId为必填
760
1352
  */
761
- TaskId: number
1353
+ AgentGroupId?: number
762
1354
 
763
1355
  /**
764
- * 实时可用率
1356
+ * 指定域名(如需要)
765
1357
  */
766
- AvailRatio: number
1358
+ Host?: string
767
1359
 
768
1360
  /**
769
- * 实时响应时间
1361
+ * 拨测目标的端口号
770
1362
  */
771
- ReponseTime: number
772
- }
1363
+ Port?: number
773
1364
 
774
- /**
775
- * PauseTask请求参数结构体
776
- */
777
- export interface PauseTaskRequest {
778
1365
  /**
779
- * 拨测任务id
1366
+ * 是否为Header请求(非0 发起Header 请求。为0,且PostData非空,发起POST请求。为0,PostData为空,发起GET请求)
780
1367
  */
781
- TaskId: number
782
- }
1368
+ IsHeader?: number
783
1369
 
784
- /**
785
- * GetResultSummary请求参数结构体
786
- */
787
- export interface GetResultSummaryRequest {
788
1370
  /**
789
- * 任务Id列表
1371
+ * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
790
1372
  */
791
- TaskIds: Array<number>
792
- }
1373
+ SslVer?: string
793
1374
 
794
- /**
795
- * DescribeAlarms请求参数结构体
796
- */
797
- export interface DescribeAlarmsRequest {
798
1375
  /**
799
- * 从第Offset 条开始查询。缺省值为0
1376
+ * POST 请求数据,空字符串表示非POST请求
800
1377
  */
801
- Offset?: number
1378
+ PostData?: string
802
1379
 
803
1380
  /**
804
- * 本批次查询Limit 条记录。缺省值为20
1381
+ * 用户Agent信息
805
1382
  */
806
- Limit?: number
1383
+ UserAgent?: string
807
1384
 
808
1385
  /**
809
- * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态。
1386
+ * 要在结果中进行匹配的字符串
810
1387
  */
811
- Status?: number
1388
+ CheckStr?: string
812
1389
 
813
1390
  /**
814
- * 格式如:2017-05-09 00:00:00 缺省为7天前0点
1391
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
815
1392
  */
816
- BeginTime?: string
1393
+ CheckType?: number
817
1394
 
818
1395
  /**
819
- * 格式如:2017-05-10 00:00:00 缺省为明天0点
1396
+ * 需要设置的Cookie信息
820
1397
  */
821
- EndTime?: string
1398
+ Cookie?: string
822
1399
 
823
1400
  /**
824
- * 告警任务名
1401
+ * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
825
1402
  */
826
- ObjName?: string
1403
+ UserName?: string
827
1404
 
828
1405
  /**
829
- * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time。
1406
+ * 登录服务器的密码
830
1407
  */
831
- SortBy?: string
1408
+ PassWord?: string
832
1409
 
833
1410
  /**
834
- * 升序或降序。可为Desc, Asc之一。缺省为Desc。
1411
+ * 缺省为0,0 表示请求为字符串类型, 1表示为二进制类型
835
1412
  */
836
- SortType?: string
837
- }
1413
+ ReqDataType?: number
838
1414
 
839
- /**
840
- * DescribeUserLimit返回参数结构体
841
- */
842
- export interface DescribeUserLimitResponse {
843
1415
  /**
844
- * 用户可建立的最大任务数
1416
+ * 发起TCP, UDP请求的协议请求数据
845
1417
  */
846
- MaxTaskNum?: number
1418
+ ReqData?: string
847
1419
 
848
1420
  /**
849
- * 用户可用的最大拨测结点数
1421
+ * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
850
1422
  */
851
- MaxAgentNum?: number
1423
+ RespDataType?: string
852
1424
 
853
1425
  /**
854
- * 用户可建立的最大拨测分组数
1426
+ * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
855
1427
  */
856
- MaxGroupNum?: number
1428
+ RespData?: string
857
1429
 
858
1430
  /**
859
- * 用户可用的最小拨测间隔
1431
+ * 目的DNS服务器,可以为空字符串
860
1432
  */
861
- MinPeriod?: number
1433
+ DnsSvr?: string
862
1434
 
863
1435
  /**
864
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1436
+ * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
865
1437
  */
866
- RequestId?: string
867
- }
1438
+ DnsCheckIp?: string
868
1439
 
869
- /**
870
- * GetRespTimeTrendEx请求参数结构体
871
- */
872
- export interface GetRespTimeTrendExRequest {
873
1440
  /**
874
- * 验证成功的拨测任务id
1441
+ * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
875
1442
  */
876
- TaskId: number
1443
+ DnsQueryType?: string
877
1444
 
878
1445
  /**
879
- * 统计数据的发生日期。格式如:2017-05-09
1446
+ * 是否使用安全链接SSL, 0 不使用,1 使用
880
1447
  */
881
- Date: string
1448
+ UseSecConn?: number
882
1449
 
883
1450
  /**
884
- * 数据的采集周期,单位分钟。取值可为 1, 5, 15, 30
1451
+ * FTP登录验证方式, 0 不验证 1 匿名登录 2 需要身份验证
885
1452
  */
886
- Period: number
1453
+ NeedAuth?: number
887
1454
 
888
1455
  /**
889
- * 可为 Isp, Province
1456
+ * Type=0 默认 (站点监控) Type=2 可用率监控
890
1457
  */
891
- Dimensions?: DimensionsDetail
1458
+ Type?: number
892
1459
 
893
1460
  /**
894
- * 可为 totalTime, parseTime, connectTime, sendTime, waitTime, receiveTime, availRatio。缺省值为 totalTime
1461
+ * 跟随跳转次数,取值范围0-5,不传则表示不跟随
895
1462
  */
896
- MetricName?: string
1463
+ RedirectFollowNum?: number
897
1464
  }
898
1465
 
899
1466
  /**
900
- * DeleteTasks请求参数结构体
1467
+ * ResumeProbeTask请求参数结构体
901
1468
  */
902
- export interface DeleteTasksRequest {
1469
+ export interface ResumeProbeTaskRequest {
903
1470
  /**
904
- * 拨测任务id
1471
+ * 任务 ID
905
1472
  */
906
- TaskIds: Array<number>
1473
+ TaskIds: Array<string>
907
1474
  }
908
1475
 
909
1476
  /**
910
- * DescribeAlarmsByTask请求参数结构体
1477
+ * DescribeTasksByType请求参数结构体
911
1478
  */
912
- export interface DescribeAlarmsByTaskRequest {
913
- /**
914
- * 拨测任务Id
915
- */
916
- TaskId: number
917
-
1479
+ export interface DescribeTasksByTypeRequest {
918
1480
  /**
919
1481
  * 从第Offset 条开始查询。缺省值为0
920
1482
  */
@@ -926,40 +1488,90 @@ export interface DescribeAlarmsByTaskRequest {
926
1488
  Limit?: number
927
1489
 
928
1490
  /**
929
- * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态
1491
+ * 拨测任务类型。0 站点监控,2 可用性监控。缺省值为2
930
1492
  */
931
- Status?: number
1493
+ Type?: number
1494
+ }
932
1495
 
1496
+ /**
1497
+ * 探测节点
1498
+ */
1499
+ export interface NodeDefine {
933
1500
  /**
934
- * 格式如:2017-05-09 00:00:00 缺省为7天前0点
1501
+ * 节点名称
935
1502
  */
936
- BeginTime?: string
1503
+ Name: string
937
1504
 
938
1505
  /**
939
- * 格式如:2017-05-10 00:00:00 缺省为明天0点
1506
+ * 节点代码
940
1507
  */
941
- EndTime?: string
1508
+ Code: string
942
1509
 
943
1510
  /**
944
- * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time
1511
+ * 节点类型
1512
+ <li> 1 = IDC </li>
1513
+ <li> 2 = LastMile </li>
1514
+ <li> 3 = Mobile </li>
1515
+ */
1516
+ Type: number
1517
+
1518
+ /**
1519
+ * 网络服务商
945
1520
  */
946
- SortBy?: string
1521
+ NetService: string
947
1522
 
948
1523
  /**
949
- * 升序或降序。可为Desc, Asc之一。缺省为Desc
1524
+ * 区域
950
1525
  */
951
- SortType?: string
1526
+ District: string
952
1527
 
953
1528
  /**
954
- * 告警对象的名称
1529
+ * 城市
955
1530
  */
956
- ObjName?: string
1531
+ City: string
1532
+
1533
+ /**
1534
+ * IP 类型
1535
+ <li> 1 = IPv4 </li>
1536
+ <li> 2 = IPv6 </li>
1537
+ 注意:此字段可能返回 null,表示取不到有效值。
1538
+ */
1539
+ IPType: number
1540
+
1541
+ /**
1542
+ * 区域
1543
+ <li> 1 = 中国大陆 </li>
1544
+ <li> 2 = 港澳台 </li>
1545
+ <li> 3 = 国外 </li>
1546
+ 注意:此字段可能返回 null,表示取不到有效值。
1547
+ */
1548
+ Location: number
957
1549
  }
958
1550
 
959
1551
  /**
960
- * PauseTask返回参数结构体
1552
+ * GetReturnCodeHistory返回参数结构体
961
1553
  */
962
- export interface PauseTaskResponse {
1554
+ export interface GetReturnCodeHistoryResponse {
1555
+ /**
1556
+ * 拨测失败详情列表
1557
+ */
1558
+ Details?: Array<CatReturnDetail>
1559
+
1560
+ /**
1561
+ * 拨测失败汇总列表
1562
+ */
1563
+ Summary?: Array<CatReturnSummary>
1564
+
1565
+ /**
1566
+ * 开始时间
1567
+ */
1568
+ BeginTime?: string
1569
+
1570
+ /**
1571
+ * 截至时间
1572
+ */
1573
+ EndTime?: string
1574
+
963
1575
  /**
964
1576
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
965
1577
  */
@@ -967,144 +1579,198 @@ export interface PauseTaskResponse {
967
1579
  }
968
1580
 
969
1581
  /**
970
- * CreateAgentGroup请求参数结构体
1582
+ * GetAvailRatioHistory请求参数结构体
971
1583
  */
972
- export interface CreateAgentGroupRequest {
1584
+ export interface GetAvailRatioHistoryRequest {
973
1585
  /**
974
- * 拨测分组名称,不超过32个字符
1586
+ * 拨测任务Id
975
1587
  */
976
- GroupName: string
1588
+ TaskId: number
977
1589
 
978
1590
  /**
979
- * 是否为默认分组,取值可为 0 或 1。取 1 时表示设置为默认分组
1591
+ * 具体时间点
980
1592
  */
981
- IsDefault: number
1593
+ TimeStamp: string
1594
+ }
982
1595
 
1596
+ /**
1597
+ * GetTaskTotalNumber返回参数结构体
1598
+ */
1599
+ export interface GetTaskTotalNumberResponse {
983
1600
  /**
984
- * Province, Isp 需要成对地进行选择。参数对的取值范围。参见:DescribeAgents 的返回结果。
1601
+ * 拨测任务总数
985
1602
  */
986
- Agents: Array<CatAgent>
1603
+ TotalCount?: number
1604
+
1605
+ /**
1606
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1607
+ */
1608
+ RequestId?: string
987
1609
  }
988
1610
 
989
1611
  /**
990
- * 拨测记录
1612
+ * 拨测点维度信息
991
1613
  */
992
- export interface CatLog {
1614
+ export interface DimensionsDetail {
993
1615
  /**
994
- * 拨测时间点
1616
+ * 运营商列表
995
1617
  */
996
- Time: string
1618
+ Isp?: Array<string>
997
1619
 
998
1620
  /**
999
- * 拨测类型
1621
+ * 省份列表
1000
1622
  */
1001
- CatTypeName: string
1623
+ Province?: Array<string>
1624
+ }
1002
1625
 
1626
+ /**
1627
+ * GetDailyAvailRatio请求参数结构体
1628
+ */
1629
+ export interface GetDailyAvailRatioRequest {
1003
1630
  /**
1004
- * 任务ID
1631
+ * 拨测任务Id
1005
1632
  */
1006
1633
  TaskId: number
1634
+ }
1007
1635
 
1636
+ /**
1637
+ * 拨测失败返回情况汇总
1638
+ */
1639
+ export interface CatReturnSummary {
1008
1640
  /**
1009
- * 拨测点所在城市
1641
+ * 拨测失败个数
1010
1642
  */
1011
- City: string
1643
+ ResultCount: number
1012
1644
 
1013
1645
  /**
1014
- * 拨测点所在运营商
1646
+ * 拨测失败返回码
1015
1647
  */
1016
- Isp: string
1648
+ ResultCode: number
1017
1649
 
1018
1650
  /**
1019
- * 被拨测Server的IP
1651
+ * 拨测失败原因描述
1020
1652
  */
1021
- ServerIp: string
1653
+ ErrorReason: string
1654
+ }
1022
1655
 
1656
+ /**
1657
+ * 任务执行结果
1658
+ */
1659
+ export interface TaskResult {
1023
1660
  /**
1024
- * 被拨测Server的域名
1661
+ * 任务 ID
1025
1662
  */
1026
- DomainName: string
1663
+ TaskId: string
1027
1664
 
1028
1665
  /**
1029
- * 执行耗时,单位毫秒
1030
- */
1031
- TotalTime: number
1666
+ * 是否成功
1667
+ 注意:此字段可能返回 null,表示取不到有效值。
1668
+ */
1669
+ Success: boolean
1032
1670
 
1033
1671
  /**
1034
- * 成功失败(1 失败,0 成功)
1035
- */
1036
- ResultType: number
1672
+ * 错误信息
1673
+ 注意:此字段可能返回 null,表示取不到有效值。
1674
+ */
1675
+ ErrorMessage: string
1676
+ }
1037
1677
 
1678
+ /**
1679
+ * SuspendProbeTask返回参数结构体
1680
+ */
1681
+ export interface SuspendProbeTaskResponse {
1038
1682
  /**
1039
- * 失败错误码
1683
+ * 任务总量
1040
1684
  */
1041
- ResultCode: number
1685
+ Total: number
1042
1686
 
1043
1687
  /**
1044
- * 请求包大小
1045
- */
1046
- ReqPkgSize: number
1688
+ * 任务成功量
1689
+ 注意:此字段可能返回 null,表示取不到有效值。
1690
+ */
1691
+ SuccessCount: number
1047
1692
 
1048
1693
  /**
1049
- * 回应包大小
1694
+ * 任务执行结果
1695
+ 注意:此字段可能返回 null,表示取不到有效值。
1696
+ */
1697
+ Results: Array<TaskResult>
1698
+
1699
+ /**
1700
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1050
1701
  */
1051
- RspPkgSize: number
1702
+ RequestId?: string
1703
+ }
1052
1704
 
1705
+ /**
1706
+ * GetRespTimeTrendEx返回参数结构体
1707
+ */
1708
+ export interface GetRespTimeTrendExResponse {
1053
1709
  /**
1054
- * 拨测请求
1710
+ * 数据点集合,时延等走势数据
1055
1711
  */
1056
- ReqMsg: string
1712
+ DataPoints?: Array<DataPointMetric>
1057
1713
 
1058
1714
  /**
1059
- * 拨测回应
1715
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1060
1716
  */
1061
- RespMsg: string
1717
+ RequestId?: string
1718
+ }
1062
1719
 
1720
+ /**
1721
+ * 包含MetricName的DataPoint数据
1722
+ */
1723
+ export interface DataPointMetric {
1063
1724
  /**
1064
- * 客户端IP
1725
+ * 数据项
1065
1726
  */
1066
- ClientIp: string
1727
+ MetricName: string
1067
1728
 
1068
1729
  /**
1069
- * 拨测点所在城市名称
1730
+ * 数据点的时间和值
1070
1731
  */
1071
- CityName: string
1732
+ Points: Array<DataPoint>
1733
+ }
1072
1734
 
1735
+ /**
1736
+ * DescribeCatLogs请求参数结构体
1737
+ */
1738
+ export interface DescribeCatLogsRequest {
1073
1739
  /**
1074
- * 拨测点所在运营商名称
1740
+ * 拨测任务Id
1075
1741
  */
1076
- IspName: string
1742
+ TaskId: number
1077
1743
 
1078
1744
  /**
1079
- * 解析耗时,单位毫秒
1745
+ * 从第Offset 条开始查询。缺省值为0
1080
1746
  */
1081
- ParseTime: number
1747
+ Offset?: number
1082
1748
 
1083
1749
  /**
1084
- * 连接耗时,单位毫秒
1750
+ * 本批次查询Limit 条记录。缺省值为20
1085
1751
  */
1086
- ConnectTime: number
1752
+ Limit?: number
1087
1753
 
1088
1754
  /**
1089
- * 数据发送耗时,单位毫秒
1755
+ * 格式如:2017-05-09 00:00:00 缺省为当天0点,最多拉取1天的数据
1090
1756
  */
1091
- SendTime: number
1757
+ BeginTime?: string
1092
1758
 
1093
1759
  /**
1094
- * 等待耗时,单位毫秒
1760
+ * 格式如:2017-05-10 00:00:00 缺省为当前时间
1095
1761
  */
1096
- WaitTime: number
1762
+ EndTime?: string
1097
1763
 
1098
1764
  /**
1099
- * 接收耗时,单位毫秒
1765
+ * 按时间升序或降序。默认降序。可选值: Desc, Asc
1100
1766
  */
1101
- ReceiveTime: number
1767
+ SortType?: string
1102
1768
  }
1103
1769
 
1104
1770
  /**
1105
- * GetDailyAvailRatio返回参数结构体
1771
+ * GetAvailRatioHistory返回参数结构体
1106
1772
  */
1107
- export interface GetDailyAvailRatioResponse {
1773
+ export interface GetAvailRatioHistoryResponse {
1108
1774
  /**
1109
1775
  * 整体平均可用率
1110
1776
  */
@@ -1120,6 +1786,11 @@ export interface GetDailyAvailRatioResponse {
1120
1786
  */
1121
1787
  LowestProvince?: string
1122
1788
 
1789
+ /**
1790
+ * 可用率最低的运营商
1791
+ */
1792
+ LowestIsp?: string
1793
+
1123
1794
  /**
1124
1795
  * 分省份的可用率数据
1125
1796
  */
@@ -1150,6 +1821,11 @@ export interface GetDailyAvailRatioResponse {
1150
1821
  */
1151
1822
  LowestProvince2?: string
1152
1823
 
1824
+ /**
1825
+ * 国外可用率最低的运营商
1826
+ */
1827
+ LowestIsp2?: string
1828
+
1153
1829
  /**
1154
1830
  * 国外分区域的可用率数据
1155
1831
  */
@@ -1162,53 +1838,39 @@ export interface GetDailyAvailRatioResponse {
1162
1838
  }
1163
1839
 
1164
1840
  /**
1165
- * DeleteAgentGroup请求参数结构体
1841
+ * DescribeProbeTasks返回参数结构体
1166
1842
  */
1167
- export interface DeleteAgentGroupRequest {
1843
+ export interface DescribeProbeTasksResponse {
1168
1844
  /**
1169
- * 拨测分组id
1170
- */
1171
- GroupId: number
1172
- }
1845
+ * 任务列表
1846
+ 注意:此字段可能返回 null,表示取不到有效值。
1847
+ */
1848
+ TaskSet: Array<ProbeTask>
1173
1849
 
1174
- /**
1175
- * GetAvailRatioHistory请求参数结构体
1176
- */
1177
- export interface GetAvailRatioHistoryRequest {
1178
1850
  /**
1179
- * 拨测任务Id
1851
+ * 任务总数
1180
1852
  */
1181
- TaskId: number
1853
+ Total: number
1182
1854
 
1183
1855
  /**
1184
- * 具体时间点
1856
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1185
1857
  */
1186
- TimeStamp: string
1858
+ RequestId?: string
1187
1859
  }
1188
1860
 
1189
1861
  /**
1190
- * DescribeAgentGroups请求参数结构体
1191
- */
1192
- export type DescribeAgentGroupsRequest = null
1193
-
1194
- /**
1195
- * DescribeAlarmsByTask返回参数结构体
1862
+ * DescribeAlarms返回参数结构体
1196
1863
  */
1197
- export interface DescribeAlarmsByTaskResponse {
1198
- /**
1199
- * 告警信息列表
1200
- */
1201
- AlarmInfos?: Array<AlarmInfo>
1202
-
1864
+ export interface DescribeAlarmsResponse {
1203
1865
  /**
1204
- * 故障率
1866
+ * 告警总条数
1205
1867
  */
1206
- FaultRatio?: number
1868
+ TotalCount?: number
1207
1869
 
1208
1870
  /**
1209
- * 故障总时长
1871
+ * 本批告警信息列表
1210
1872
  */
1211
- FaultTimeSpec?: string
1873
+ AlarmInfos?: Array<AlarmInfo>
1212
1874
 
1213
1875
  /**
1214
1876
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1217,314 +1879,286 @@ export interface DescribeAlarmsByTaskResponse {
1217
1879
  }
1218
1880
 
1219
1881
  /**
1220
- * ModifyTaskEx请求参数结构体
1882
+ * DescribeTasksByType返回参数结构体
1221
1883
  */
1222
- export interface ModifyTaskExRequest {
1223
- /**
1224
- * http, https, ping, tcp, ftp, smtp, udp, dns 之一
1225
- */
1226
- CatTypeName: string
1227
-
1228
- /**
1229
- * 拨测的URL,例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1230
- */
1231
- Url: string
1232
-
1233
- /**
1234
- * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1235
- */
1236
- Period: number
1237
-
1238
- /**
1239
- * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1240
- */
1241
- TaskName: string
1242
-
1243
- /**
1244
- * 验证成功的拨测任务ID
1245
- */
1246
- TaskId: number
1247
-
1248
- /**
1249
- * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroupList 接口,本参数使用返回结果里的GroupId的值。注意,Type为0时,AgentGroupId为必填
1250
- */
1251
- AgentGroupId?: number
1252
-
1253
- /**
1254
- * 指定域名(如需要)
1255
- */
1256
- Host?: string
1257
-
1258
- /**
1259
- * 拨测目标的端口号
1260
- */
1261
- Port?: number
1262
-
1263
- /**
1264
- * 是否为Header请求(非0 发起Header 请求。为0,且PostData非空,发起POST请求。为0,PostData为空,发起GET请求)
1265
- */
1266
- IsHeader?: number
1267
-
1268
- /**
1269
- * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
1270
- */
1271
- SslVer?: string
1272
-
1273
- /**
1274
- * POST 请求数据,空字符串表示非POST请求
1275
- */
1276
- PostData?: string
1277
-
1884
+ export interface DescribeTasksByTypeResponse {
1278
1885
  /**
1279
- * 用户Agent信息
1886
+ * 符合条件的总任务数
1280
1887
  */
1281
- UserAgent?: string
1888
+ TotalCount?: number
1282
1889
 
1283
1890
  /**
1284
- * 要在结果中进行匹配的字符串
1891
+ * 任务列表
1285
1892
  */
1286
- CheckStr?: string
1893
+ Tasks?: Array<TaskAlarm>
1287
1894
 
1288
1895
  /**
1289
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1896
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1290
1897
  */
1291
- CheckType?: number
1898
+ RequestId?: string
1899
+ }
1292
1900
 
1901
+ /**
1902
+ * DescribeAlarmTopic请求参数结构体
1903
+ */
1904
+ export interface DescribeAlarmTopicRequest {
1293
1905
  /**
1294
- * 需要设置的Cookie信息
1906
+ * 如果不存在拨测相关的主题,是否自动创建一个。取值可为0, 1,默认为0
1295
1907
  */
1296
- Cookie?: string
1908
+ NeedAdd?: number
1909
+ }
1297
1910
 
1911
+ /**
1912
+ * DescribeAgentGroups返回参数结构体
1913
+ */
1914
+ export interface DescribeAgentGroupsResponse {
1298
1915
  /**
1299
- * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1916
+ * 用户所属的系统默认拨测分组
1300
1917
  */
1301
- UserName?: string
1918
+ SysDefaultGroup?: AgentGroup
1302
1919
 
1303
1920
  /**
1304
- * 登录服务器的密码
1921
+ * 用户创建的拨测分组列表
1305
1922
  */
1306
- PassWord?: string
1923
+ CustomGroups?: Array<AgentGroup>
1307
1924
 
1308
1925
  /**
1309
- * 缺省为0,0 表示请求为字符串类型, 1表示为二进制类型
1926
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1310
1927
  */
1311
- ReqDataType?: number
1928
+ RequestId?: string
1929
+ }
1312
1930
 
1931
+ /**
1932
+ * SuspendProbeTask请求参数结构体
1933
+ */
1934
+ export interface SuspendProbeTaskRequest {
1313
1935
  /**
1314
- * 发起TCP, UDP请求的协议请求数据
1936
+ * 任务 ID
1315
1937
  */
1316
- ReqData?: string
1938
+ TaskIds: Array<string>
1939
+ }
1317
1940
 
1941
+ /**
1942
+ * GetRespTimeTrendEx请求参数结构体
1943
+ */
1944
+ export interface GetRespTimeTrendExRequest {
1318
1945
  /**
1319
- * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1946
+ * 验证成功的拨测任务id
1320
1947
  */
1321
- RespDataType?: string
1948
+ TaskId: number
1322
1949
 
1323
1950
  /**
1324
- * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1951
+ * 统计数据的发生日期。格式如:2017-05-09
1325
1952
  */
1326
- RespData?: string
1953
+ Date: string
1327
1954
 
1328
1955
  /**
1329
- * 目的DNS服务器,可以为空字符串
1956
+ * 数据的采集周期,单位分钟。取值可为 1, 5, 15, 30
1330
1957
  */
1331
- DnsSvr?: string
1958
+ Period: number
1332
1959
 
1333
1960
  /**
1334
- * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1961
+ * 可为 Isp, Province
1335
1962
  */
1336
- DnsCheckIp?: string
1963
+ Dimensions?: DimensionsDetail
1337
1964
 
1338
1965
  /**
1339
- * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1966
+ * 可为 totalTime, parseTime, connectTime, sendTime, waitTime, receiveTime, availRatio。缺省值为 totalTime
1340
1967
  */
1341
- DnsQueryType?: string
1968
+ MetricName?: string
1969
+ }
1342
1970
 
1971
+ /**
1972
+ * UpdateProbeTaskConfigurationList请求参数结构体
1973
+ */
1974
+ export interface UpdateProbeTaskConfigurationListRequest {
1343
1975
  /**
1344
- * 是否使用安全链接SSL, 0 不使用,1 使用
1976
+ * 任务 ID
1345
1977
  */
1346
- UseSecConn?: number
1978
+ TaskIds: Array<string>
1347
1979
 
1348
1980
  /**
1349
- * FTP登录验证方式, 0 不验证 1 匿名登录 2 需要身份验证
1981
+ * 拨测节点
1350
1982
  */
1351
- NeedAuth?: number
1983
+ Nodes: Array<string>
1352
1984
 
1353
1985
  /**
1354
- * Type=0 默认 (站点监控) Type=2 可用率监控
1986
+ * 拨测间隔
1355
1987
  */
1356
- Type?: number
1988
+ Interval: number
1357
1989
 
1358
1990
  /**
1359
- * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1991
+ * 拨测参数
1360
1992
  */
1361
- RedirectFollowNum?: number
1362
- }
1993
+ Parameters: string
1363
1994
 
1364
- /**
1365
- * DescribeAlarmTopic请求参数结构体
1366
- */
1367
- export interface DescribeAlarmTopicRequest {
1368
1995
  /**
1369
- * 如果不存在拨测相关的主题,是否自动创建一个。取值可为0, 1,默认为0
1996
+ * 定时任务cron表达式
1370
1997
  */
1371
- NeedAdd?: number
1998
+ Cron?: string
1372
1999
  }
1373
2000
 
1374
2001
  /**
1375
- * CreateTaskEx请求参数结构体
2002
+ * CreateProbeTasks请求参数结构体
1376
2003
  */
1377
- export interface CreateTaskExRequest {
2004
+ export interface CreateProbeTasksRequest {
1378
2005
  /**
1379
- * http, https, ping, tcp, ftp, smtp, udp, dns 之一
2006
+ * 批量任务名-地址
1380
2007
  */
1381
- CatTypeName: string
2008
+ BatchTasks: Array<ProbeTaskBasicConfiguration>
1382
2009
 
1383
2010
  /**
1384
- * 拨测的URL, 例如:www.qq.com (URL域名解析需要能解析出具体的IP)
2011
+ * 任务类型
1385
2012
  */
1386
- Url: string
2013
+ TaskType: number
1387
2014
 
1388
2015
  /**
1389
- * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
2016
+ * 探测节点
1390
2017
  */
1391
- Period: number
2018
+ Nodes: Array<string>
1392
2019
 
1393
2020
  /**
1394
- * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
2021
+ * 探测间隔
1395
2022
  */
1396
- TaskName: string
2023
+ Interval: number
1397
2024
 
1398
2025
  /**
1399
- * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroups 接口,本参数使用返回结果里的GroupId的值。注意: Type为0时,AgentGroupId为必填
2026
+ * 探测参数
1400
2027
  */
1401
- AgentGroupId?: number
2028
+ Parameters: string
1402
2029
 
1403
2030
  /**
1404
- * 指定域名(如需要)
1405
- */
1406
- Host?: string
2031
+ * 任务分类
2032
+ <li>1 = PC</li>
2033
+ <li> 2 = Mobile </li>
2034
+ */
2035
+ TaskCategory: number
1407
2036
 
1408
2037
  /**
1409
- * 是否为Header请求(非0 发起Header 请求。为0,且PostData 非空,发起POST请求。为0,PostData 为空,发起GET请求)
2038
+ * 定时任务cron表达式
1410
2039
  */
1411
- IsHeader?: number
2040
+ Cron?: string
2041
+ }
1412
2042
 
2043
+ /**
2044
+ * 拨测记录
2045
+ */
2046
+ export interface CatLog {
1413
2047
  /**
1414
- * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
2048
+ * 拨测时间点
1415
2049
  */
1416
- SslVer?: string
2050
+ Time: string
1417
2051
 
1418
2052
  /**
1419
- * POST请求数据。空字符串表示非POST请求
2053
+ * 拨测类型
1420
2054
  */
1421
- PostData?: string
2055
+ CatTypeName: string
1422
2056
 
1423
2057
  /**
1424
- * 用户Agent信息
2058
+ * 任务ID
1425
2059
  */
1426
- UserAgent?: string
2060
+ TaskId: number
1427
2061
 
1428
2062
  /**
1429
- * 要在结果中进行匹配的字符串
2063
+ * 拨测点所在城市
1430
2064
  */
1431
- CheckStr?: string
2065
+ City: string
1432
2066
 
1433
2067
  /**
1434
- * 1 表示通过检查结果是否包含CheckStr 进行校验
2068
+ * 拨测点所在运营商
1435
2069
  */
1436
- CheckType?: number
2070
+ Isp: string
1437
2071
 
1438
2072
  /**
1439
- * 需要设置的Cookie信息
2073
+ * 被拨测Server的IP
1440
2074
  */
1441
- Cookie?: string
2075
+ ServerIp: string
1442
2076
 
1443
2077
  /**
1444
- * 任务ID,用于验证且修改任务时传入原任务ID
2078
+ * 被拨测Server的域名
1445
2079
  */
1446
- TaskId?: number
2080
+ DomainName: string
1447
2081
 
1448
2082
  /**
1449
- * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
2083
+ * 执行耗时,单位毫秒
1450
2084
  */
1451
- UserName?: string
2085
+ TotalTime: number
1452
2086
 
1453
2087
  /**
1454
- * 登录服务器的密码
2088
+ * 成功失败(1 失败,0 成功)
1455
2089
  */
1456
- PassWord?: string
2090
+ ResultType: number
1457
2091
 
1458
2092
  /**
1459
- * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
2093
+ * 失败错误码
1460
2094
  */
1461
- ReqDataType?: number
2095
+ ResultCode: number
1462
2096
 
1463
2097
  /**
1464
- * 发起TCP, UDP请求的协议请求数据
2098
+ * 请求包大小
1465
2099
  */
1466
- ReqData?: string
2100
+ ReqPkgSize: number
1467
2101
 
1468
2102
  /**
1469
- * 缺省为0。0 表示响应为字符串类型。1表示为二进制类型
2103
+ * 回应包大小
1470
2104
  */
1471
- RespDataType?: number
2105
+ RspPkgSize: number
1472
2106
 
1473
2107
  /**
1474
- * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
2108
+ * 拨测请求
1475
2109
  */
1476
- RespData?: string
2110
+ ReqMsg: string
1477
2111
 
1478
2112
  /**
1479
- * 目的DNS服务器 可以为空字符串
2113
+ * 拨测回应
1480
2114
  */
1481
- DnsSvr?: string
2115
+ RespMsg: string
1482
2116
 
1483
2117
  /**
1484
- * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
2118
+ * 客户端IP
1485
2119
  */
1486
- DnsCheckIp?: string
2120
+ ClientIp: string
1487
2121
 
1488
2122
  /**
1489
- * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
2123
+ * 拨测点所在城市名称
1490
2124
  */
1491
- DnsQueryType?: string
2125
+ CityName: string
1492
2126
 
1493
2127
  /**
1494
- * 是否使用安全链接SSL, 0 不使用,1 使用
2128
+ * 拨测点所在运营商名称
1495
2129
  */
1496
- UseSecConn?: number
2130
+ IspName: string
1497
2131
 
1498
2132
  /**
1499
- * FTP登录验证方式, 0 不验证 , 1 匿名登录, 2 需要身份验证
2133
+ * 解析耗时,单位毫秒
1500
2134
  */
1501
- NeedAuth?: number
2135
+ ParseTime: number
1502
2136
 
1503
2137
  /**
1504
- * 拨测目标的端口号
2138
+ * 连接耗时,单位毫秒
1505
2139
  */
1506
- Port?: number
2140
+ ConnectTime: number
1507
2141
 
1508
2142
  /**
1509
- * Type=0 默认 (站点监控)Type=2 可用率监控
2143
+ * 数据发送耗时,单位毫秒
1510
2144
  */
1511
- Type?: number
2145
+ SendTime: number
1512
2146
 
1513
2147
  /**
1514
- * IsVerify=0 非验证任务 IsVerify=1 验证任务,不传则默认为0
2148
+ * 等待耗时,单位毫秒
1515
2149
  */
1516
- IsVerify?: number
2150
+ WaitTime: number
1517
2151
 
1518
2152
  /**
1519
- * 跟随跳转次数,取值范围0-5,不传则表示不跟随
2153
+ * 接收耗时,单位毫秒
1520
2154
  */
1521
- RedirectFollowNum?: number
2155
+ ReceiveTime: number
1522
2156
  }
1523
2157
 
1524
2158
  /**
1525
- * GetTaskTotalNumber请求参数结构体
2159
+ * DescribeAgentGroups请求参数结构体
1526
2160
  */
1527
- export type GetTaskTotalNumberRequest = null
2161
+ export type DescribeAgentGroupsRequest = null
1528
2162
 
1529
2163
  /**
1530
2164
  * 可用性监控任务状态及告警信息
@@ -1582,284 +2216,307 @@ export interface TaskAlarm {
1582
2216
  }
1583
2217
 
1584
2218
  /**
1585
- * DescribeTasksByType请求参数结构体
2219
+ * DescribeCatLogs返回参数结构体
1586
2220
  */
1587
- export interface DescribeTasksByTypeRequest {
1588
- /**
1589
- * 从第Offset 条开始查询。缺省值为0
1590
- */
1591
- Offset?: number
1592
-
2221
+ export interface DescribeCatLogsResponse {
1593
2222
  /**
1594
- * 本批次查询Limit 条记录。缺省值为20
2223
+ * 符合条件的总记录数
1595
2224
  */
1596
- Limit?: number
2225
+ TotalCount?: number
1597
2226
 
1598
2227
  /**
1599
- * 拨测任务类型。0 站点监控,2 可用性监控。缺省值为2
2228
+ * 拨测记录列表
1600
2229
  */
1601
- Type?: number
1602
- }
2230
+ CatLogs?: Array<CatLog>
1603
2231
 
1604
- /**
1605
- * VerifyResult请求参数结构体
1606
- */
1607
- export interface VerifyResultRequest {
1608
2232
  /**
1609
- * 要查询的拨测任务的结果id
2233
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1610
2234
  */
1611
- ResultId: number
2235
+ RequestId?: string
1612
2236
  }
1613
2237
 
1614
2238
  /**
1615
- * VerifyResult返回参数结构体
2239
+ * 单条详细拨测数据
1616
2240
  */
1617
- export interface VerifyResultResponse {
2241
+ export interface DetailedSingleDataDefine {
1618
2242
  /**
1619
- * 错误的原因
2243
+ * 拨测时间戳
1620
2244
  */
1621
- ErrorReason?: string
2245
+ ProbeTime: number
1622
2246
 
1623
2247
  /**
1624
- * 错误号
2248
+ * 储存所有string类型字段
1625
2249
  */
1626
- ResultCode?: number
2250
+ Labels: Array<Label>
1627
2251
 
1628
2252
  /**
1629
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2253
+ * 储存所有float类型字段
1630
2254
  */
1631
- RequestId?: string
2255
+ Fields: Array<Field>
1632
2256
  }
1633
2257
 
1634
2258
  /**
1635
- * 任务信息和告警策略组
2259
+ * GetReturnCodeInfo返回参数结构体
1636
2260
  */
1637
- export interface CatTaskDetail {
1638
- /**
1639
- * 任务ID
1640
- */
1641
- TaskId: number
1642
-
1643
- /**
1644
- * 任务名称
1645
- */
1646
- TaskName: string
1647
-
1648
- /**
1649
- * 任务周期,单位为分钟。目前支持1,5,15,30几种取值
1650
- */
1651
- Period: number
1652
-
1653
- /**
1654
- * 拨测类型。http, https, ping, tcp 之一
1655
- */
1656
- CatTypeName: string
1657
-
1658
- /**
1659
- * 拨测任务的URL
1660
- */
1661
- CgiUrl: string
1662
-
1663
- /**
1664
- * 拨测分组ID
1665
- */
1666
- AgentGroupId: number
1667
-
1668
- /**
1669
- * 告警策略组ID
1670
- */
1671
- PolicyGroupId: number
1672
-
1673
- /**
1674
- * 任务状态。1表示暂停,2表示运行中,0为初始态
1675
- */
1676
- Status?: number
1677
-
1678
- /**
1679
- * 任务创建时间
1680
- */
1681
- AddTime?: string
1682
-
2261
+ export interface GetReturnCodeInfoResponse {
1683
2262
  /**
1684
- * 任务类型。0 站点监控,2 可用性监控
2263
+ * 拨测失败详情列表
1685
2264
  */
1686
- Type?: number
2265
+ Details?: Array<CatReturnDetail>
1687
2266
 
1688
2267
  /**
1689
- * 绑定的统一告警主题ID
2268
+ * 拨测失败汇总列表
1690
2269
  */
1691
- TopicId?: string
2270
+ Summary?: Array<CatReturnSummary>
1692
2271
 
1693
2272
  /**
1694
- * 告警状态。0 未启用,1, 启用
2273
+ * 开始时间
1695
2274
  */
1696
- AlarmStatus?: number
2275
+ BeginTime?: string
1697
2276
 
1698
2277
  /**
1699
- * 指定的域名
2278
+ * 截至时间
1700
2279
  */
1701
- Host?: string
2280
+ EndTime?: string
1702
2281
 
1703
2282
  /**
1704
- * 拨测目标的端口号
2283
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1705
2284
  */
1706
- Port?: number
2285
+ RequestId?: string
2286
+ }
1707
2287
 
2288
+ /**
2289
+ * BindAlarmPolicy返回参数结构体
2290
+ */
2291
+ export interface BindAlarmPolicyResponse {
1708
2292
  /**
1709
- * 要在结果中进行匹配的字符串
2293
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1710
2294
  */
1711
- CheckStr?: string
2295
+ RequestId?: string
2296
+ }
1712
2297
 
2298
+ /**
2299
+ * RunTask返回参数结构体
2300
+ */
2301
+ export interface RunTaskResponse {
1713
2302
  /**
1714
- * 1 表示通过检查结果是否包含CheckStr 进行校验
2303
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1715
2304
  */
1716
- CheckType?: number
2305
+ RequestId?: string
2306
+ }
1717
2307
 
2308
+ /**
2309
+ * 储存float类型字段
2310
+ */
2311
+ export interface Field {
1718
2312
  /**
1719
- * 用户Agent信息
2313
+ * 自定义字段编号
1720
2314
  */
1721
- UserAgent?: string
2315
+ ID: number
1722
2316
 
1723
2317
  /**
1724
- * 设置的Cookie信息
2318
+ * 自定义字段名称/说明
1725
2319
  */
1726
- Cookie?: string
2320
+ Name: string
1727
2321
 
1728
2322
  /**
1729
- * POST 请求数据。空字符串表示非POST请求
2323
+ * 字段值
1730
2324
  */
1731
- PostData?: string
2325
+ Value: number
2326
+ }
1732
2327
 
2328
+ /**
2329
+ * type ProbeTaskBasicConfiguration struct {
2330
+ TaskID TaskID `json:"TaskId" gorm:"column:task_id"`
2331
+ Name string `json:"Name" binding:"required" gorm:"column:name"`
2332
+ TargetAddress string `json:"TargetAddress" binding:"required" gorm:"column:target_address"`
2333
+ }
2334
+ */
2335
+ export interface ProbeTaskBasicConfiguration {
1733
2336
  /**
1734
- * SSL协议版本
2337
+ * 拨测任务名称
1735
2338
  */
1736
- SslVer?: string
2339
+ Name: string
1737
2340
 
1738
2341
  /**
1739
- * 是否为Header请求。非0 Header 请求
2342
+ * 拨测目标地址
1740
2343
  */
1741
- IsHeader?: number
2344
+ TargetAddress: string
2345
+ }
1742
2346
 
2347
+ /**
2348
+ * VerifyResult请求参数结构体
2349
+ */
2350
+ export interface VerifyResultRequest {
1743
2351
  /**
1744
- * 目的DNS服务器
2352
+ * 要查询的拨测任务的结果id
1745
2353
  */
1746
- DnsSvr?: string
2354
+ ResultId: number
2355
+ }
2356
+
2357
+ /**
2358
+ * GetTaskTotalNumber请求参数结构体
2359
+ */
2360
+ export type GetTaskTotalNumberRequest = null
1747
2361
 
2362
+ /**
2363
+ * ModifyAgentGroup返回参数结构体
2364
+ */
2365
+ export interface ModifyAgentGroupResponse {
1748
2366
  /**
1749
- * 需要检验是否在DNS IP列表的IP
2367
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1750
2368
  */
1751
- DnsCheckIp?: string
2369
+ RequestId?: string
2370
+ }
1752
2371
 
2372
+ /**
2373
+ * DescribeTaskDetail请求参数结构体
2374
+ */
2375
+ export interface DescribeTaskDetailRequest {
1753
2376
  /**
1754
- * DNS查询类型
2377
+ * 拨测任务id 数组
1755
2378
  */
1756
- DnsQueryType?: string
2379
+ TaskIds: Array<number>
2380
+ }
1757
2381
 
2382
+ /**
2383
+ * GetResultSummary返回参数结构体
2384
+ */
2385
+ export interface GetResultSummaryResponse {
1758
2386
  /**
1759
- * 登录服务器的账号
2387
+ * 实时统计数据
1760
2388
  */
1761
- UserName?: string
2389
+ RealData?: Array<ResultSummary>
1762
2390
 
1763
2391
  /**
1764
- * 登录服务器的密码
2392
+ * 按天的统计数据
1765
2393
  */
1766
- PassWord?: string
2394
+ DayData?: Array<ResultSummary>
1767
2395
 
1768
2396
  /**
1769
- * 是否使用安全链接SSL, 0 不使用,1 使用
2397
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1770
2398
  */
1771
- UseSecConn?: number
2399
+ RequestId?: string
2400
+ }
1772
2401
 
2402
+ /**
2403
+ * VerifyResult返回参数结构体
2404
+ */
2405
+ export interface VerifyResultResponse {
1773
2406
  /**
1774
- * FTP登录验证方式 0 不验证 1 匿名登录 2 需要身份验证
2407
+ * 错误的原因
1775
2408
  */
1776
- NeedAuth?: number
2409
+ ErrorReason?: string
1777
2410
 
1778
2411
  /**
1779
- * 请求数据类型。0 表示请求为字符串类型。1表示为二进制类型
2412
+ * 错误号
1780
2413
  */
1781
- ReqDataType?: number
2414
+ ResultCode?: number
1782
2415
 
1783
2416
  /**
1784
- * 发起TCP, UDP请求的协议请求数据
2417
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1785
2418
  */
1786
- ReqData?: string
2419
+ RequestId?: string
2420
+ }
1787
2421
 
2422
+ /**
2423
+ * 告警主题
2424
+ */
2425
+ export interface AlarmTopic {
1788
2426
  /**
1789
- * 响应数据类型。0 表示响应为字符串类型。1表示为二进制类型
2427
+ * 主题的ID
1790
2428
  */
1791
- RespDataType?: number
2429
+ TopicId: string
1792
2430
 
1793
2431
  /**
1794
- * 预期的UDP请求的回应数据
2432
+ * 主题的名称
1795
2433
  */
1796
- RespData?: string
2434
+ TopicName: string
2435
+ }
1797
2436
 
2437
+ /**
2438
+ * DeleteTasks请求参数结构体
2439
+ */
2440
+ export interface DeleteTasksRequest {
1798
2441
  /**
1799
- * 跟随跳转次数
2442
+ * 拨测任务id
1800
2443
  */
1801
- RedirectFollowNum?: number
2444
+ TaskIds: Array<number>
1802
2445
  }
1803
2446
 
1804
2447
  /**
1805
- * GetReturnCodeHistory返回参数结构体
2448
+ * DescribeProbeTasks请求参数结构体
1806
2449
  */
1807
- export interface GetReturnCodeHistoryResponse {
2450
+ export interface DescribeProbeTasksRequest {
1808
2451
  /**
1809
- * 拨测失败详情列表
2452
+ * 任务 ID 列表
1810
2453
  */
1811
- Details?: Array<CatReturnDetail>
2454
+ TaskIDs?: Array<string>
1812
2455
 
1813
2456
  /**
1814
- * 拨测失败汇总列表
2457
+ * 任务名
1815
2458
  */
1816
- Summary?: Array<CatReturnSummary>
2459
+ TaskName?: string
1817
2460
 
1818
2461
  /**
1819
- * 开始时间
2462
+ * 探测目标
1820
2463
  */
1821
- BeginTime?: string
2464
+ TargetAddress?: string
1822
2465
 
1823
2466
  /**
1824
- * 截至时间
2467
+ * 任务状态列表
1825
2468
  */
1826
- EndTime?: string
2469
+ TaskStatus?: Array<number>
1827
2470
 
1828
2471
  /**
1829
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2472
+ * 偏移量,默认为0
1830
2473
  */
1831
- RequestId?: string
1832
- }
2474
+ Offset?: number
1833
2475
 
1834
- /**
1835
- * 时延等数据,数据点
1836
- */
1837
- export interface DataPoint {
1838
2476
  /**
1839
- * 数据点的时间
2477
+ * 返回数量,默认为20,最大值为100
1840
2478
  */
1841
- LogTime: string
2479
+ Limit?: number
1842
2480
 
1843
2481
  /**
1844
- * 数据值
2482
+ * 付费模式
2483
+ <li>1 = 试用版本</li>
2484
+ <li> 2 = 付费版本 </li>
2485
+ */
2486
+ PayMode?: number
2487
+
2488
+ /**
2489
+ * 订单状态
2490
+ <li>1 = 正常</li>
2491
+ <li> 2 = 欠费 </li>
2492
+ */
2493
+ OrderState?: number
2494
+
2495
+ /**
2496
+ * 拨测类型
1845
2497
  */
1846
- MetricValue: number
1847
- }
2498
+ TaskType?: Array<number>
1848
2499
 
1849
- /**
1850
- * DescribeAlarmTopic返回参数结构体
1851
- */
1852
- export interface DescribeAlarmTopicResponse {
1853
2500
  /**
1854
- * 主题个数
2501
+ * 节点类型
1855
2502
  */
1856
- TotalCount?: number
2503
+ TaskCategory?: Array<number>
1857
2504
 
1858
2505
  /**
1859
- * 主题列表
2506
+ * 排序的列
1860
2507
  */
1861
- Topics?: Array<AlarmTopic>
2508
+ OrderBy?: string
2509
+
2510
+ /**
2511
+ * 是否正序
2512
+ */
2513
+ Ascend?: boolean
2514
+ }
1862
2515
 
2516
+ /**
2517
+ * PauseTask返回参数结构体
2518
+ */
2519
+ export interface PauseTaskResponse {
1863
2520
  /**
1864
2521
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1865
2522
  */
@@ -1867,11 +2524,11 @@ export interface DescribeAlarmTopicResponse {
1867
2524
  }
1868
2525
 
1869
2526
  /**
1870
- * GetRealAvailRatio返回参数结构体
2527
+ * GetDailyAvailRatio返回参数结构体
1871
2528
  */
1872
- export interface GetRealAvailRatioResponse {
2529
+ export interface GetDailyAvailRatioResponse {
1873
2530
  /**
1874
- * 国内平均可用率
2531
+ * 整体平均可用率
1875
2532
  */
1876
2533
  AvgAvailRatio?: number
1877
2534
 
@@ -1885,11 +2542,6 @@ export interface GetRealAvailRatioResponse {
1885
2542
  */
1886
2543
  LowestProvince?: string
1887
2544
 
1888
- /**
1889
- * 可用率最低的运营商
1890
- */
1891
- LowestIsp?: string
1892
-
1893
2545
  /**
1894
2546
  * 分省份的可用率数据
1895
2547
  */
@@ -1920,11 +2572,6 @@ export interface GetRealAvailRatioResponse {
1920
2572
  */
1921
2573
  LowestProvince2?: string
1922
2574
 
1923
- /**
1924
- * 国外可用率最低的运营商
1925
- */
1926
- LowestIsp2?: string
1927
-
1928
2575
  /**
1929
2576
  * 国外分区域的可用率数据
1930
2577
  */
@@ -1937,56 +2584,56 @@ export interface GetRealAvailRatioResponse {
1937
2584
  }
1938
2585
 
1939
2586
  /**
1940
- * RunTask返回参数结构体
2587
+ * DeleteAgentGroup请求参数结构体
1941
2588
  */
1942
- export interface RunTaskResponse {
2589
+ export interface DeleteAgentGroupRequest {
1943
2590
  /**
1944
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2591
+ * 拨测分组id
1945
2592
  */
1946
- RequestId?: string
2593
+ GroupId: number
1947
2594
  }
1948
2595
 
1949
2596
  /**
1950
- * 拨测Agent 所在省份、运营商
2597
+ * GetRealAvailRatio请求参数结构体
1951
2598
  */
1952
- export interface CatAgent {
2599
+ export interface GetRealAvailRatioRequest {
1953
2600
  /**
1954
- * 拨测结点所在的省份(拼音缩写)
2601
+ * 拨测任务Id
1955
2602
  */
1956
- Province: string
2603
+ TaskId: number
2604
+ }
1957
2605
 
2606
+ /**
2607
+ * DeleteProbeTask返回参数结构体
2608
+ */
2609
+ export interface DeleteProbeTaskResponse {
1958
2610
  /**
1959
- * 拨测结点所在的运营商(英文缩写)
2611
+ * 任务总量
1960
2612
  */
1961
- Isp: string
2613
+ Total: number
1962
2614
 
1963
2615
  /**
1964
- * 拨测结点所在的省份(中文名称)
2616
+ * 任务成功量
1965
2617
  注意:此字段可能返回 null,表示取不到有效值。
1966
2618
  */
1967
- ProvinceName?: string
2619
+ SuccessCount: number
1968
2620
 
1969
2621
  /**
1970
- * 拨测结点所在的运营商(中文名称)
2622
+ * 任务执行结果
1971
2623
  注意:此字段可能返回 null,表示取不到有效值。
1972
2624
  */
1973
- IspName?: string
1974
- }
1975
-
1976
- /**
1977
- * DescribeCatLogs返回参数结构体
1978
- */
1979
- export interface DescribeCatLogsResponse {
1980
- /**
1981
- * 符合条件的总记录数
1982
- */
1983
- TotalCount?: number
2625
+ Results: Array<TaskResult>
1984
2626
 
1985
2627
  /**
1986
- * 拨测记录列表
2628
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1987
2629
  */
1988
- CatLogs?: Array<CatLog>
2630
+ RequestId?: string
2631
+ }
1989
2632
 
2633
+ /**
2634
+ * CreateProbeTasks返回参数结构体
2635
+ */
2636
+ export interface CreateProbeTasksResponse {
1990
2637
  /**
1991
2638
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1992
2639
  */
@@ -1994,41 +2641,66 @@ export interface DescribeCatLogsResponse {
1994
2641
  }
1995
2642
 
1996
2643
  /**
1997
- * GetTaskTotalNumber返回参数结构体
2644
+ * DescribeProbeNodes请求参数结构体
1998
2645
  */
1999
- export interface GetTaskTotalNumberResponse {
2646
+ export interface DescribeProbeNodesRequest {
2000
2647
  /**
2001
- * 拨测任务总数
2648
+ * 节点类型
2649
+ <li> 1 = IDC </li>
2650
+ <li> 2 = LastMile </li>
2651
+ <li> 3 = Mobile </li>
2652
+ */
2653
+ NodeType?: number
2654
+
2655
+ /**
2656
+ * 节点区域
2657
+ <li> 1 = 中国大陆 </li>
2658
+ <li> 2 = 港澳台 </li>
2659
+ <li> 3 = 海外 </li>
2660
+ */
2661
+ Location?: number
2662
+
2663
+ /**
2664
+ * 是否IPv6
2002
2665
  */
2003
- TotalCount?: number
2666
+ IsIPv6?: boolean
2004
2667
 
2005
2668
  /**
2006
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2669
+ * 名字模糊搜索
2007
2670
  */
2008
- RequestId?: string
2671
+ NodeName?: string
2672
+
2673
+ /**
2674
+ * 付费模式
2675
+ <li>1 = 试用版本</li>
2676
+ <li> 2 = 付费版本 </li>
2677
+ */
2678
+ PayMode?: number
2009
2679
  }
2010
2680
 
2011
2681
  /**
2012
- * CreateTaskEx返回参数结构体
2682
+ * 拨测Agent 所在省份、运营商
2013
2683
  */
2014
- export interface CreateTaskExResponse {
2684
+ export interface CatAgent {
2015
2685
  /**
2016
- * 拨测结果查询ID。接下来可以使用查询拨测是否能够成功,验证能否通过。
2686
+ * 拨测结点所在的省份(拼音缩写)
2017
2687
  */
2018
- ResultId?: number
2688
+ Province: string
2019
2689
 
2020
2690
  /**
2021
- * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
2691
+ * 拨测结点所在的运营商(英文缩写)
2022
2692
  */
2023
- TaskId?: number
2693
+ Isp: string
2024
2694
 
2025
2695
  /**
2026
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2027
- */
2028
- RequestId?: string
2029
- }
2696
+ * 拨测结点所在的省份(中文名称)
2697
+ 注意:此字段可能返回 null,表示取不到有效值。
2698
+ */
2699
+ ProvinceName?: string
2030
2700
 
2031
- /**
2032
- * DescribeUserLimit请求参数结构体
2033
- */
2034
- export type DescribeUserLimitRequest = null
2701
+ /**
2702
+ * 拨测结点所在的运营商(中文名称)
2703
+ 注意:此字段可能返回 null,表示取不到有效值。
2704
+ */
2705
+ IspName?: string
2706
+ }