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
@@ -1,28 +1,3 @@
1
- /**
2
- * GetReturnCodeInfo返回参数结构体
3
- */
4
- export interface GetReturnCodeInfoResponse {
5
- /**
6
- * 拨测失败详情列表
7
- */
8
- Details?: Array<CatReturnDetail>;
9
- /**
10
- * 拨测失败汇总列表
11
- */
12
- Summary?: Array<CatReturnSummary>;
13
- /**
14
- * 开始时间
15
- */
16
- BeginTime?: string;
17
- /**
18
- * 截至时间
19
- */
20
- EndTime?: string;
21
- /**
22
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
23
- */
24
- RequestId?: string;
25
- }
26
1
  /**
27
2
  * ModifyAgentGroup请求参数结构体
28
3
  */
@@ -44,15 +19,6 @@ export interface ModifyAgentGroupRequest {
44
19
  */
45
20
  Agents: Array<CatAgent>;
46
21
  }
47
- /**
48
- * BindAlarmPolicy返回参数结构体
49
- */
50
- export interface BindAlarmPolicyResponse {
51
- /**
52
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
53
- */
54
- RequestId?: string;
55
- }
56
22
  /**
57
23
  * 拨测告警信息
58
24
  */
@@ -95,18 +61,13 @@ export interface AlarmInfo {
95
61
  ObjId?: string;
96
62
  }
97
63
  /**
98
- * GetDailyAvailRatio请求参数结构体
64
+ * CreateTaskEx返回参数结构体
99
65
  */
100
- export interface GetDailyAvailRatioRequest {
66
+ export interface CreateTaskExResponse {
101
67
  /**
102
- * 拨测任务Id
68
+ * 拨测结果查询ID。接下来可以使用查询拨测是否能够成功,验证能否通过。
103
69
  */
104
- TaskId: number;
105
- }
106
- /**
107
- * ModifyTaskEx返回参数结构体
108
- */
109
- export interface ModifyTaskExResponse {
70
+ ResultId?: number;
110
71
  /**
111
72
  * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
112
73
  */
@@ -117,62 +78,18 @@ export interface ModifyTaskExResponse {
117
78
  RequestId?: string;
118
79
  }
119
80
  /**
120
- * DescribeAgents请求参数结构体
121
- */
122
- export declare type DescribeAgentsRequest = null;
123
- /**
124
- * 拨测失败返回情况汇总
125
- */
126
- export interface CatReturnSummary {
127
- /**
128
- * 拨测失败个数
129
- */
130
- ResultCount: number;
131
- /**
132
- * 拨测失败返回码
133
- */
134
- ResultCode: number;
135
- /**
136
- * 拨测失败原因描述
137
- */
138
- ErrorReason: string;
139
- }
140
- /**
141
- * 拨测失败详情
81
+ * DescribeProbeNodes返回参数结构体
142
82
  */
143
- export interface CatReturnDetail {
144
- /**
145
- * 运营商名称
146
- */
147
- IspName: string;
148
- /**
149
- * 省份全拼
150
- */
151
- Province: string;
152
- /**
153
- * 省份中文名称
154
- */
155
- ProvinceName: string;
156
- /**
157
- * Map键值
158
- */
159
- MapKey: string;
160
- /**
161
- * 拨测目标的IP
162
- */
163
- ServerIp: string;
164
- /**
165
- * 拨测失败个数
166
- */
167
- ResultCount: number;
83
+ export interface DescribeProbeNodesResponse {
168
84
  /**
169
- * 拨测失败返回码
85
+ * 节点列表
86
+ 注意:此字段可能返回 null,表示取不到有效值。
170
87
  */
171
- ResultCode: number;
88
+ NodeSet: Array<NodeDefine>;
172
89
  /**
173
- * 拨测失败原因描述
90
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
174
91
  */
175
- ErrorReason: string;
92
+ RequestId?: string;
176
93
  }
177
94
  /**
178
95
  * RunTask请求参数结构体
@@ -184,458 +101,455 @@ export interface RunTaskRequest {
184
101
  TaskId: number;
185
102
  }
186
103
  /**
187
- * 拨测点维度信息
188
- */
189
- export interface DimensionsDetail {
190
- /**
191
- * 运营商列表
192
- */
193
- Isp?: Array<string>;
194
- /**
195
- * 省份列表
196
- */
197
- Province?: Array<string>;
198
- }
199
- /**
200
- * GetRespTimeTrendEx返回参数结构体
104
+ * DescribeTaskDetail返回参数结构体
201
105
  */
202
- export interface GetRespTimeTrendExResponse {
106
+ export interface DescribeTaskDetailResponse {
203
107
  /**
204
- * 数据点集合,时延等走势数据
108
+ * 拨测任务列表
205
109
  */
206
- DataPoints?: Array<DataPointMetric>;
110
+ Tasks?: Array<CatTaskDetail>;
207
111
  /**
208
112
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
209
113
  */
210
114
  RequestId?: string;
211
115
  }
212
116
  /**
213
- * ModifyAgentGroup返回参数结构体
117
+ * DeleteTasks返回参数结构体
214
118
  */
215
- export interface ModifyAgentGroupResponse {
119
+ export interface DeleteTasksResponse {
216
120
  /**
217
121
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
218
122
  */
219
123
  RequestId?: string;
220
124
  }
221
125
  /**
222
- * DescribeTaskDetail返回参数结构体
126
+ * 任务信息和告警策略组
223
127
  */
224
- export interface DescribeTaskDetailResponse {
128
+ export interface CatTaskDetail {
225
129
  /**
226
- * 拨测任务列表
130
+ * 任务ID
227
131
  */
228
- Tasks?: Array<CatTaskDetail>;
132
+ TaskId: number;
229
133
  /**
230
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
134
+ * 任务名称
231
135
  */
232
- RequestId?: string;
233
- }
234
- /**
235
- * 运营商可用率
236
- */
237
- export interface IspDetail {
136
+ TaskName: string;
238
137
  /**
239
- * 运营商名称
138
+ * 任务周期,单位为分钟。目前支持1,5,15,30几种取值
240
139
  */
241
- IspName: string;
140
+ Period: number;
242
141
  /**
243
- * 可用率
142
+ * 拨测类型。http, https, ping, tcp 之一
244
143
  */
245
- AvailRatio: number;
144
+ CatTypeName: string;
246
145
  /**
247
- * 平均耗时
248
- 注意:此字段可能返回 null,表示取不到有效值。
146
+ * 拨测任务的URL
249
147
  */
250
- AvgTime: number;
251
- }
252
- /**
253
- * 包含MetricName的DataPoint数据
254
- */
255
- export interface DataPointMetric {
148
+ CgiUrl: string;
256
149
  /**
257
- * 数据项
150
+ * 拨测分组ID
258
151
  */
259
- MetricName: string;
152
+ AgentGroupId: number;
260
153
  /**
261
- * 数据点的时间和值
154
+ * 告警策略组ID
262
155
  */
263
- Points: Array<DataPoint>;
264
- }
265
- /**
266
- * GetReturnCodeInfo请求参数结构体
267
- */
268
- export interface GetReturnCodeInfoRequest {
156
+ PolicyGroupId: number;
269
157
  /**
270
- * 正整数。验证成功的拨测任务id
158
+ * 任务状态。1表示暂停,2表示运行中,0为初始态
271
159
  */
272
- TaskId: number;
160
+ Status?: number;
273
161
  /**
274
- * 开始时间点。格式如:2017-05-09 10:20:00,最多拉群两天的数据
162
+ * 任务创建时间
275
163
  */
276
- BeginTime: string;
164
+ AddTime?: string;
277
165
  /**
278
- * 结束时间点。格式如:2017-05-09 10:25:00,最多拉群两天的数据
166
+ * 任务类型。0 站点监控,2 可用性监控
279
167
  */
280
- EndTime: string;
168
+ Type?: number;
281
169
  /**
282
- * 省份名称的全拼
170
+ * 绑定的统一告警主题ID
283
171
  */
284
- Province?: string;
285
- }
286
- /**
287
- * DescribeCatLogs请求参数结构体
288
- */
289
- export interface DescribeCatLogsRequest {
172
+ TopicId?: string;
290
173
  /**
291
- * 拨测任务Id
174
+ * 告警状态。0 未启用,1, 启用
292
175
  */
293
- TaskId: number;
176
+ AlarmStatus?: number;
294
177
  /**
295
- * 从第Offset 条开始查询。缺省值为0
178
+ * 指定的域名
296
179
  */
297
- Offset?: number;
180
+ Host?: string;
298
181
  /**
299
- * 本批次查询Limit 条记录。缺省值为20
182
+ * 拨测目标的端口号
300
183
  */
301
- Limit?: number;
184
+ Port?: number;
302
185
  /**
303
- * 格式如:2017-05-09 00:00:00 缺省为当天0点,最多拉取1天的数据
186
+ * 要在结果中进行匹配的字符串
304
187
  */
305
- BeginTime?: string;
188
+ CheckStr?: string;
306
189
  /**
307
- * 格式如:2017-05-10 00:00:00 缺省为当前时间
190
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
308
191
  */
309
- EndTime?: string;
192
+ CheckType?: number;
310
193
  /**
311
- * 按时间升序或降序。默认降序。可选值: Desc, Asc
194
+ * 用户Agent信息
312
195
  */
313
- SortType?: string;
314
- }
315
- /**
316
- * DescribeAgents返回参数结构体
317
- */
318
- export interface DescribeAgentsResponse {
196
+ UserAgent?: string;
319
197
  /**
320
- * 本用户可选的拨测点列表
198
+ * 设置的Cookie信息
321
199
  */
322
- Agents?: Array<CatAgent>;
200
+ Cookie?: string;
323
201
  /**
324
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
202
+ * POST 请求数据。空字符串表示非POST请求
325
203
  */
326
- RequestId?: string;
327
- }
328
- /**
329
- * GetAvailRatioHistory返回参数结构体
330
- */
331
- export interface GetAvailRatioHistoryResponse {
204
+ PostData?: string;
332
205
  /**
333
- * 整体平均可用率
206
+ * SSL协议版本
334
207
  */
335
- AvgAvailRatio?: number;
208
+ SslVer?: string;
336
209
  /**
337
- * 各省份最低可用率
210
+ * 是否为Header请求。非0 Header 请求
338
211
  */
339
- LowestAvailRatio?: number;
212
+ IsHeader?: number;
340
213
  /**
341
- * 可用率最低的省份
214
+ * 目的DNS服务器
342
215
  */
343
- LowestProvince?: string;
216
+ DnsSvr?: string;
344
217
  /**
345
- * 可用率最低的运营商
218
+ * 需要检验是否在DNS IP列表的IP
346
219
  */
347
- LowestIsp?: string;
220
+ DnsCheckIp?: string;
348
221
  /**
349
- * 分省份的可用率数据
222
+ * DNS查询类型
350
223
  */
351
- ProvinceData?: Array<ProvinceDetail>;
224
+ DnsQueryType?: string;
352
225
  /**
353
- * 国内平均耗时,单位毫秒
226
+ * 登录服务器的账号
354
227
  */
355
- AvgTime?: number;
228
+ UserName?: string;
356
229
  /**
357
- * 国外平均可用率
230
+ * 登录服务器的密码
358
231
  */
359
- AvgAvailRatio2?: number;
232
+ PassWord?: string;
360
233
  /**
361
- * 国外平均耗时,单位毫秒
234
+ * 是否使用安全链接SSL, 0 不使用,1 使用
362
235
  */
363
- AvgTime2?: number;
236
+ UseSecConn?: number;
364
237
  /**
365
- * 国外最低可用率
238
+ * FTP登录验证方式 0 不验证 1 匿名登录 2 需要身份验证
366
239
  */
367
- LowestAvailRatio2?: number;
240
+ NeedAuth?: number;
368
241
  /**
369
- * 国外可用率最低的区域
242
+ * 请求数据类型。0 表示请求为字符串类型。1表示为二进制类型
370
243
  */
371
- LowestProvince2?: string;
244
+ ReqDataType?: number;
372
245
  /**
373
- * 国外可用率最低的运营商
246
+ * 发起TCP, UDP请求的协议请求数据
374
247
  */
375
- LowestIsp2?: string;
248
+ ReqData?: string;
376
249
  /**
377
- * 国外分区域的可用率数据
250
+ * 响应数据类型。0 表示响应为字符串类型。1表示为二进制类型
378
251
  */
379
- ProvinceData2?: Array<ProvinceDetail>;
252
+ RespDataType?: number;
380
253
  /**
381
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
254
+ * 预期的UDP请求的回应数据
382
255
  */
383
- RequestId?: string;
256
+ RespData?: string;
257
+ /**
258
+ * 跟随跳转次数
259
+ */
260
+ RedirectFollowNum?: number;
384
261
  }
385
262
  /**
386
- * CreateAgentGroup返回参数结构体
263
+ * BindAlarmPolicy请求参数结构体
387
264
  */
388
- export interface CreateAgentGroupResponse {
265
+ export interface BindAlarmPolicyRequest {
389
266
  /**
390
- * 拨测分组Id
267
+ * 拨测任务Id
391
268
  */
392
- GroupId?: number;
269
+ TaskId: number;
393
270
  /**
394
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
271
+ * 告警策略组Id
395
272
  */
396
- RequestId?: string;
273
+ PolicyGroupId: number;
274
+ /**
275
+ * 是否绑定操作。非0 为绑定, 0 为 解绑。缺省表示 绑定。
276
+ */
277
+ IfBind?: number;
278
+ /**
279
+ * 告警主题Id
280
+ */
281
+ TopicId?: string;
397
282
  }
398
283
  /**
399
- * DeleteTasks返回参数结构体
284
+ * DeleteProbeTask请求参数结构体
400
285
  */
401
- export interface DeleteTasksResponse {
286
+ export interface DeleteProbeTaskRequest {
402
287
  /**
403
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
288
+ * 任务 ID
404
289
  */
405
- RequestId?: string;
290
+ TaskIds: Array<string>;
406
291
  }
407
292
  /**
408
- * DescribeAlarms返回参数结构体
293
+ * 实时统计数据
409
294
  */
410
- export interface DescribeAlarmsResponse {
295
+ export interface ResultSummary {
411
296
  /**
412
- * 告警总条数
297
+ * 统计时间
413
298
  */
414
- TotalCount?: number;
299
+ LogTime: string;
415
300
  /**
416
- * 本批告警信息列表
301
+ * 任务ID
417
302
  */
418
- AlarmInfos?: Array<AlarmInfo>;
303
+ TaskId: number;
419
304
  /**
420
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
305
+ * 实时可用率
421
306
  */
422
- RequestId?: string;
423
- }
424
- /**
425
- * GetRealAvailRatio请求参数结构体
426
- */
427
- export interface GetRealAvailRatioRequest {
307
+ AvailRatio: number;
428
308
  /**
429
- * 拨测任务Id
309
+ * 实时响应时间
430
310
  */
431
- TaskId: number;
311
+ ReponseTime: number;
432
312
  }
433
313
  /**
434
- * DeleteAgentGroup返回参数结构体
314
+ * DescribeDetailedSingleProbeData返回参数结构体
435
315
  */
436
- export interface DeleteAgentGroupResponse {
316
+ export interface DescribeDetailedSingleProbeDataResponse {
317
+ /**
318
+ * 单次详情数据
319
+ */
320
+ DataSet: Array<DetailedSingleDataDefine>;
321
+ /**
322
+ * 符合条件的数据总数
323
+ */
324
+ TotalNumber: number;
437
325
  /**
438
326
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
439
327
  */
440
328
  RequestId?: string;
441
329
  }
442
330
  /**
443
- * 拨测分组
331
+ * DescribeAlarmsByTask请求参数结构体
444
332
  */
445
- export interface AgentGroup {
446
- /**
447
- * 拨测分组ID
448
- */
449
- GroupId: number;
333
+ export interface DescribeAlarmsByTaskRequest {
450
334
  /**
451
- * 拨测分组名称
335
+ * 拨测任务Id
452
336
  */
453
- GroupName: string;
337
+ TaskId: number;
454
338
  /**
455
- * 是否默认拨测分组。1表示是,0表示否
339
+ * 从第Offset 条开始查询。缺省值为0
456
340
  */
457
- IsDefault?: number;
341
+ Offset?: number;
458
342
  /**
459
- * 使用本拨测分组的任务数
343
+ * 本批次查询Limit 条记录。缺省值为20
460
344
  */
461
- TaskNum?: number;
345
+ Limit?: number;
462
346
  /**
463
- * 拨测结点列表
347
+ * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态
464
348
  */
465
- GroupDetail?: Array<CatAgent>;
349
+ Status?: number;
466
350
  /**
467
- * 最大拨测分组数
351
+ * 格式如:2017-05-09 00:00:00 缺省为7天前0点
468
352
  */
469
- MaxGroupNum?: number;
470
- }
471
- /**
472
- * DescribeTaskDetail请求参数结构体
473
- */
474
- export interface DescribeTaskDetailRequest {
353
+ BeginTime?: string;
475
354
  /**
476
- * 拨测任务id 数组
355
+ * 格式如:2017-05-10 00:00:00 缺省为明天0点
477
356
  */
478
- TaskIds: Array<number>;
479
- }
480
- /**
481
- * DescribeTasksByType返回参数结构体
482
- */
483
- export interface DescribeTasksByTypeResponse {
357
+ EndTime?: string;
484
358
  /**
485
- * 符合条件的总任务数
359
+ * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time
486
360
  */
487
- TotalCount?: number;
361
+ SortBy?: string;
488
362
  /**
489
- * 任务列表
363
+ * 升序或降序。可为Desc, Asc之一。缺省为Desc
490
364
  */
491
- Tasks?: Array<TaskAlarm>;
365
+ SortType?: string;
492
366
  /**
493
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
367
+ * 告警对象的名称
494
368
  */
495
- RequestId?: string;
369
+ ObjName?: string;
496
370
  }
497
371
  /**
498
- * GetResultSummary返回参数结构体
372
+ * DescribeAlarms请求参数结构体
499
373
  */
500
- export interface GetResultSummaryResponse {
374
+ export interface DescribeAlarmsRequest {
501
375
  /**
502
- * 实时统计数据
376
+ * 从第Offset 条开始查询。缺省值为0
503
377
  */
504
- RealData?: Array<ResultSummary>;
378
+ Offset?: number;
505
379
  /**
506
- * 按天的统计数据
380
+ * 本批次查询Limit 条记录。缺省值为20
507
381
  */
508
- DayData?: Array<ResultSummary>;
382
+ Limit?: number;
509
383
  /**
510
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
384
+ * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态。
511
385
  */
512
- RequestId?: string;
513
- }
514
- /**
515
- * GetReturnCodeHistory请求参数结构体
516
- */
517
- export interface GetReturnCodeHistoryRequest {
386
+ Status?: number;
518
387
  /**
519
- * 正整数。验证成功的拨测任务id
388
+ * 格式如:2017-05-09 00:00:00 缺省为7天前0点
520
389
  */
521
- TaskId: number;
390
+ BeginTime?: string;
522
391
  /**
523
- * 开始时间点。格式如:2017-05-09 10:20:00。注意,BeginTime 和 EndTime 需要在同一天
392
+ * 格式如:2017-05-10 00:00:00 缺省为明天0点
524
393
  */
525
- BeginTime: string;
394
+ EndTime?: string;
526
395
  /**
527
- * 结束时间点。格式如:2017-05-09 10:25:00。注意,BeginTime 和 EndTime 需要在同一天
396
+ * 告警任务名
528
397
  */
529
- EndTime: string;
398
+ ObjName?: string;
530
399
  /**
531
- * 省份名称的全拼
400
+ * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time。
532
401
  */
533
- Province: string;
402
+ SortBy?: string;
403
+ /**
404
+ * 升序或降序。可为Desc, Asc之一。缺省为Desc。
405
+ */
406
+ SortType?: string;
534
407
  }
535
408
  /**
536
- * BindAlarmPolicy请求参数结构体
409
+ * DescribeUserLimit返回参数结构体
537
410
  */
538
- export interface BindAlarmPolicyRequest {
411
+ export interface DescribeUserLimitResponse {
539
412
  /**
540
- * 拨测任务Id
413
+ * 用户可建立的最大任务数
541
414
  */
542
- TaskId: number;
415
+ MaxTaskNum?: number;
543
416
  /**
544
- * 告警策略组Id
417
+ * 用户可用的最大拨测结点数
545
418
  */
546
- PolicyGroupId: number;
419
+ MaxAgentNum?: number;
547
420
  /**
548
- * 是否绑定操作。非0 为绑定, 0 为 解绑。缺省表示 绑定。
421
+ * 用户可建立的最大拨测分组数
549
422
  */
550
- IfBind?: number;
423
+ MaxGroupNum?: number;
551
424
  /**
552
- * 告警主题Id
425
+ * 用户可用的最小拨测间隔
553
426
  */
554
- TopicId?: string;
427
+ MinPeriod?: number;
428
+ /**
429
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
430
+ */
431
+ RequestId?: string;
555
432
  }
556
433
  /**
557
- * DescribeAgentGroups返回参数结构体
434
+ * CreateTaskEx请求参数结构体
558
435
  */
559
- export interface DescribeAgentGroupsResponse {
436
+ export interface CreateTaskExRequest {
560
437
  /**
561
- * 用户所属的系统默认拨测分组
438
+ * http, https, ping, tcp, ftp, smtp, udp, dns 之一
562
439
  */
563
- SysDefaultGroup?: AgentGroup;
440
+ CatTypeName: string;
564
441
  /**
565
- * 用户创建的拨测分组列表
442
+ * 拨测的URL, 例如:www.qq.com (URL域名解析需要能解析出具体的IP)
566
443
  */
567
- CustomGroups?: Array<AgentGroup>;
444
+ Url: string;
568
445
  /**
569
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
446
+ * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
570
447
  */
571
- RequestId?: string;
572
- }
573
- /**
574
- * 省份可用率
575
- */
576
- export interface ProvinceDetail {
448
+ Period: number;
577
449
  /**
578
- * 可用率
450
+ * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
579
451
  */
580
- AvgAvailRatio: number;
452
+ TaskName: string;
581
453
  /**
582
- * 省份名称
454
+ * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroups 接口,本参数使用返回结果里的GroupId的值。注意: Type为0时,AgentGroupId为必填
583
455
  */
584
- ProvinceName: string;
456
+ AgentGroupId?: number;
585
457
  /**
586
- * 省份英文名称
458
+ * 指定域名(如需要)
587
459
  */
588
- Mapkey: string;
460
+ Host?: string;
589
461
  /**
590
- * 统计时间点
462
+ * 是否为Header请求(非0 发起Header 请求。为0,且PostData 非空,发起POST请求。为0,PostData 为空,发起GET请求)
591
463
  */
592
- TimeStamp: string;
464
+ IsHeader?: number;
593
465
  /**
594
- * 分运营商可用率
466
+ * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
595
467
  */
596
- IspDetail: Array<IspDetail>;
468
+ SslVer?: string;
597
469
  /**
598
- * 平均耗时,单位毫秒
470
+ * POST请求数据。空字符串表示非POST请求
599
471
  */
600
- AvgTime: number;
472
+ PostData?: string;
601
473
  /**
602
- * 省份
474
+ * 用户Agent信息
603
475
  */
604
- Province: string;
605
- }
606
- /**
607
- * 告警主题
608
- */
609
- export interface AlarmTopic {
476
+ UserAgent?: string;
610
477
  /**
611
- * 主题的ID
478
+ * 要在结果中进行匹配的字符串
612
479
  */
613
- TopicId: string;
480
+ CheckStr?: string;
614
481
  /**
615
- * 主题的名称
482
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
616
483
  */
617
- TopicName: string;
618
- }
619
- /**
620
- * 实时统计数据
621
- */
622
- export interface ResultSummary {
484
+ CheckType?: number;
623
485
  /**
624
- * 统计时间
486
+ * 需要设置的Cookie信息
625
487
  */
626
- LogTime: string;
488
+ Cookie?: string;
627
489
  /**
628
- * 任务ID
490
+ * 任务ID,用于验证且修改任务时传入原任务ID
629
491
  */
630
- TaskId: number;
492
+ TaskId?: number;
631
493
  /**
632
- * 实时可用率
494
+ * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
633
495
  */
634
- AvailRatio: number;
496
+ UserName?: string;
635
497
  /**
636
- * 实时响应时间
498
+ * 登录服务器的密码
637
499
  */
638
- ReponseTime: number;
500
+ PassWord?: string;
501
+ /**
502
+ * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
503
+ */
504
+ ReqDataType?: number;
505
+ /**
506
+ * 发起TCP, UDP请求的协议请求数据
507
+ */
508
+ ReqData?: string;
509
+ /**
510
+ * 缺省为0。0 表示响应为字符串类型。1表示为二进制类型
511
+ */
512
+ RespDataType?: number;
513
+ /**
514
+ * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
515
+ */
516
+ RespData?: string;
517
+ /**
518
+ * 目的DNS服务器 可以为空字符串
519
+ */
520
+ DnsSvr?: string;
521
+ /**
522
+ * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
523
+ */
524
+ DnsCheckIp?: string;
525
+ /**
526
+ * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
527
+ */
528
+ DnsQueryType?: string;
529
+ /**
530
+ * 是否使用安全链接SSL, 0 不使用,1 使用
531
+ */
532
+ UseSecConn?: number;
533
+ /**
534
+ * FTP登录验证方式, 0 不验证 , 1 匿名登录, 2 需要身份验证
535
+ */
536
+ NeedAuth?: number;
537
+ /**
538
+ * 拨测目标的端口号
539
+ */
540
+ Port?: number;
541
+ /**
542
+ * Type=0 默认 (站点监控)Type=2 可用率监控
543
+ */
544
+ Type?: number;
545
+ /**
546
+ * IsVerify=0 非验证任务 IsVerify=1 验证任务,不传则默认为0
547
+ */
548
+ IsVerify?: number;
549
+ /**
550
+ * 跟随跳转次数,取值范围0-5,不传则表示不跟随
551
+ */
552
+ RedirectFollowNum?: number;
639
553
  }
640
554
  /**
641
555
  * PauseTask请求参数结构体
@@ -656,265 +570,898 @@ export interface GetResultSummaryRequest {
656
570
  TaskIds: Array<number>;
657
571
  }
658
572
  /**
659
- * DescribeAlarms请求参数结构体
573
+ * 探测任务
660
574
  */
661
- export interface DescribeAlarmsRequest {
575
+ export interface ProbeTask {
662
576
  /**
663
- * 从第Offset 条开始查询。缺省值为0
577
+ * 任务名
578
+ 注意:此字段可能返回 null,表示取不到有效值。
664
579
  */
665
- Offset?: number;
580
+ Name: string;
666
581
  /**
667
- * 本批次查询Limit 条记录。缺省值为20
582
+ * 任务 ID
668
583
  */
669
- Limit?: number;
584
+ TaskId: string;
670
585
  /**
671
- * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态。
586
+ * 任务类型
672
587
  */
673
- Status?: number;
588
+ TaskType: number;
674
589
  /**
675
- * 格式如:2017-05-09 00:00:00 缺省为7天前0点
590
+ * 探测节点列表
676
591
  */
677
- BeginTime?: string;
592
+ Nodes: Array<string>;
678
593
  /**
679
- * 格式如:2017-05-10 00:00:00 缺省为明天0点
594
+ * 探测间隔
680
595
  */
681
- EndTime?: string;
596
+ Interval: number;
682
597
  /**
683
- * 告警任务名
598
+ * 探测参数
684
599
  */
685
- ObjName?: string;
600
+ Parameters: string;
686
601
  /**
687
- * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time。
602
+ * 任务状态
688
603
  */
689
- SortBy?: string;
604
+ Status: number;
690
605
  /**
691
- * 升序或降序。可为Desc, Asc之一。缺省为Desc。
606
+ * 目标地址
692
607
  */
693
- SortType?: string;
608
+ TargetAddress: string;
609
+ /**
610
+ * 付费模式
611
+ <li>1 = 试用版本</li>
612
+ <li> 2 = 付费版本 </li>
613
+ */
614
+ PayMode: number;
615
+ /**
616
+ * 订单状态
617
+ <li>1 = 正常</li>
618
+ <li> 2 = 欠费 </li>
619
+ */
620
+ OrderState: number;
621
+ /**
622
+ * 任务分类
623
+ <li>1 = PC</li>
624
+ <li> 2 = Mobile </li>
625
+ */
626
+ TaskCategory: number;
627
+ /**
628
+ * 创建时间
629
+ */
630
+ CreatedAt: string;
631
+ /**
632
+ * 定时任务cron表达式
633
+ 注意:此字段可能返回 null,表示取不到有效值。
634
+ */
635
+ Cron: string;
636
+ /**
637
+ * 定时任务启动状态
638
+ 注意:此字段可能返回 null,表示取不到有效值。
639
+ */
640
+ CronState: number;
694
641
  }
695
642
  /**
696
- * DescribeUserLimit返回参数结构体
643
+ * 时延等数据,数据点
697
644
  */
698
- export interface DescribeUserLimitResponse {
645
+ export interface DataPoint {
699
646
  /**
700
- * 用户可建立的最大任务数
647
+ * 数据点的时间
701
648
  */
702
- MaxTaskNum?: number;
649
+ LogTime: string;
703
650
  /**
704
- * 用户可用的最大拨测结点数
651
+ * 数据值
705
652
  */
706
- MaxAgentNum?: number;
653
+ MetricValue: number;
654
+ }
655
+ /**
656
+ * DescribeAlarmTopic返回参数结构体
657
+ */
658
+ export interface DescribeAlarmTopicResponse {
707
659
  /**
708
- * 用户可建立的最大拨测分组数
660
+ * 主题个数
709
661
  */
710
- MaxGroupNum?: number;
662
+ TotalCount?: number;
711
663
  /**
712
- * 用户可用的最小拨测间隔
664
+ * 主题列表
713
665
  */
714
- MinPeriod?: number;
666
+ Topics?: Array<AlarmTopic>;
715
667
  /**
716
668
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
717
669
  */
718
670
  RequestId?: string;
719
671
  }
720
672
  /**
721
- * GetRespTimeTrendEx请求参数结构体
673
+ * DescribeUserLimit请求参数结构体
722
674
  */
723
- export interface GetRespTimeTrendExRequest {
675
+ export declare type DescribeUserLimitRequest = null;
676
+ /**
677
+ * 保存string类型字段
678
+ */
679
+ export interface Label {
724
680
  /**
725
- * 验证成功的拨测任务id
681
+ * 自定义字段编号
726
682
  */
727
- TaskId: number;
683
+ ID: number;
728
684
  /**
729
- * 统计数据的发生日期。格式如:2017-05-09
685
+ * 自定义字段名称/说明
730
686
  */
731
- Date: string;
687
+ Name: string;
732
688
  /**
733
- * 数据的采集周期,单位分钟。取值可为 1, 5, 15, 30
689
+ * 字段值
734
690
  */
735
- Period: number;
691
+ Value: string;
692
+ }
693
+ /**
694
+ * DescribeAgents请求参数结构体
695
+ */
696
+ export declare type DescribeAgentsRequest = null;
697
+ /**
698
+ * 拨测失败详情
699
+ */
700
+ export interface CatReturnDetail {
736
701
  /**
737
- * 可为 Isp, Province
702
+ * 运营商名称
738
703
  */
739
- Dimensions?: DimensionsDetail;
704
+ IspName: string;
740
705
  /**
741
- * 可为 totalTime, parseTime, connectTime, sendTime, waitTime, receiveTime, availRatio。缺省值为 totalTime
706
+ * 省份全拼
742
707
  */
743
- MetricName?: string;
744
- }
745
- /**
746
- * DeleteTasks请求参数结构体
747
- */
748
- export interface DeleteTasksRequest {
708
+ Province: string;
749
709
  /**
750
- * 拨测任务id
710
+ * 省份中文名称
751
711
  */
752
- TaskIds: Array<number>;
712
+ ProvinceName: string;
713
+ /**
714
+ * Map键值
715
+ */
716
+ MapKey: string;
717
+ /**
718
+ * 拨测目标的IP
719
+ */
720
+ ServerIp: string;
721
+ /**
722
+ * 拨测失败个数
723
+ */
724
+ ResultCount: number;
725
+ /**
726
+ * 拨测失败返回码
727
+ */
728
+ ResultCode: number;
729
+ /**
730
+ * 拨测失败原因描述
731
+ */
732
+ ErrorReason: string;
753
733
  }
754
734
  /**
755
- * DescribeAlarmsByTask请求参数结构体
735
+ * 运营商可用率
756
736
  */
757
- export interface DescribeAlarmsByTaskRequest {
737
+ export interface IspDetail {
758
738
  /**
759
- * 拨测任务Id
739
+ * 运营商名称
760
740
  */
761
- TaskId: number;
741
+ IspName: string;
762
742
  /**
763
- * 从第Offset 条开始查询。缺省值为0
743
+ * 可用率
764
744
  */
765
- Offset?: number;
745
+ AvailRatio: number;
766
746
  /**
767
- * 本批次查询Limit 条记录。缺省值为20
747
+ * 平均耗时
748
+ 注意:此字段可能返回 null,表示取不到有效值。
768
749
  */
769
- Limit?: number;
750
+ AvgTime: number;
751
+ }
752
+ /**
753
+ * GetReturnCodeInfo请求参数结构体
754
+ */
755
+ export interface GetReturnCodeInfoRequest {
770
756
  /**
771
- * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态
757
+ * 正整数。验证成功的拨测任务id
772
758
  */
773
- Status?: number;
759
+ TaskId: number;
774
760
  /**
775
- * 格式如:2017-05-09 00:00:00 缺省为7天前0点
761
+ * 开始时间点。格式如:2017-05-09 10:20:00,最多拉群两天的数据
776
762
  */
777
- BeginTime?: string;
763
+ BeginTime: string;
778
764
  /**
779
- * 格式如:2017-05-10 00:00:00 缺省为明天0点
765
+ * 结束时间点。格式如:2017-05-09 10:25:00,最多拉群两天的数据
780
766
  */
781
- EndTime?: string;
767
+ EndTime: string;
782
768
  /**
783
- * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time
769
+ * 省份名称的全拼
784
770
  */
785
- SortBy?: string;
771
+ Province?: string;
772
+ }
773
+ /**
774
+ * DescribeAgents返回参数结构体
775
+ */
776
+ export interface DescribeAgentsResponse {
786
777
  /**
787
- * 升序或降序。可为Desc, Asc之一。缺省为Desc
778
+ * 本用户可选的拨测点列表
788
779
  */
789
- SortType?: string;
780
+ Agents?: Array<CatAgent>;
790
781
  /**
791
- * 告警对象的名称
782
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
792
783
  */
793
- ObjName?: string;
784
+ RequestId?: string;
785
+ }
786
+ /**
787
+ * CreateAgentGroup返回参数结构体
788
+ */
789
+ export interface CreateAgentGroupResponse {
790
+ /**
791
+ * 拨测分组Id
792
+ */
793
+ GroupId?: number;
794
+ /**
795
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
796
+ */
797
+ RequestId?: string;
798
+ }
799
+ /**
800
+ * DescribeDetailedSingleProbeData请求参数结构体
801
+ */
802
+ export interface DescribeDetailedSingleProbeDataRequest {
803
+ /**
804
+ * 开始时间戳(毫秒级)
805
+ */
806
+ BeginTime: number;
807
+ /**
808
+ * 结束时间戳(毫秒级)
809
+ */
810
+ EndTime: number;
811
+ /**
812
+ * 任务类型
813
+ */
814
+ TaskType: string;
815
+ /**
816
+ * 待排序字段
817
+ */
818
+ SortField: string;
819
+ /**
820
+ * true表示升序
821
+ */
822
+ Ascending: boolean;
823
+ /**
824
+ * 选中字段
825
+ */
826
+ SelectedFields: Array<string>;
827
+ /**
828
+ * 起始取数位置
829
+ */
830
+ Offset: number;
831
+ /**
832
+ * 取数数量
833
+ */
834
+ Limit: number;
835
+ /**
836
+ * 任务ID
837
+ */
838
+ TaskID?: Array<string>;
839
+ /**
840
+ * 拨测点运营商
841
+ */
842
+ Operators?: Array<string>;
843
+ /**
844
+ * 拨测点地区
845
+ */
846
+ Districts?: Array<string>;
847
+ /**
848
+ * 错误类型
849
+ */
850
+ ErrorTypes?: Array<string>;
851
+ }
852
+ /**
853
+ * DeleteAgentGroup返回参数结构体
854
+ */
855
+ export interface DeleteAgentGroupResponse {
856
+ /**
857
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
858
+ */
859
+ RequestId?: string;
860
+ }
861
+ /**
862
+ * 拨测分组
863
+ */
864
+ export interface AgentGroup {
865
+ /**
866
+ * 拨测分组ID
867
+ */
868
+ GroupId: number;
869
+ /**
870
+ * 拨测分组名称
871
+ */
872
+ GroupName: string;
873
+ /**
874
+ * 是否默认拨测分组。1表示是,0表示否
875
+ */
876
+ IsDefault?: number;
877
+ /**
878
+ * 使用本拨测分组的任务数
879
+ */
880
+ TaskNum?: number;
881
+ /**
882
+ * 拨测结点列表
883
+ */
884
+ GroupDetail?: Array<CatAgent>;
885
+ /**
886
+ * 最大拨测分组数
887
+ */
888
+ MaxGroupNum?: number;
889
+ }
890
+ /**
891
+ * GetReturnCodeHistory请求参数结构体
892
+ */
893
+ export interface GetReturnCodeHistoryRequest {
894
+ /**
895
+ * 正整数。验证成功的拨测任务id
896
+ */
897
+ TaskId: number;
898
+ /**
899
+ * 开始时间点。格式如:2017-05-09 10:20:00。注意,BeginTime 和 EndTime 需要在同一天
900
+ */
901
+ BeginTime: string;
902
+ /**
903
+ * 结束时间点。格式如:2017-05-09 10:25:00。注意,BeginTime 和 EndTime 需要在同一天
904
+ */
905
+ EndTime: string;
906
+ /**
907
+ * 省份名称的全拼
908
+ */
909
+ Province: string;
910
+ }
911
+ /**
912
+ * 省份可用率
913
+ */
914
+ export interface ProvinceDetail {
915
+ /**
916
+ * 可用率
917
+ */
918
+ AvgAvailRatio: number;
919
+ /**
920
+ * 省份名称
921
+ */
922
+ ProvinceName: string;
923
+ /**
924
+ * 省份英文名称
925
+ */
926
+ Mapkey: string;
927
+ /**
928
+ * 统计时间点
929
+ */
930
+ TimeStamp: string;
931
+ /**
932
+ * 分运营商可用率
933
+ */
934
+ IspDetail: Array<IspDetail>;
935
+ /**
936
+ * 平均耗时,单位毫秒
937
+ */
938
+ AvgTime: number;
939
+ /**
940
+ * 省份
941
+ */
942
+ Province: string;
943
+ }
944
+ /**
945
+ * GetRealAvailRatio返回参数结构体
946
+ */
947
+ export interface GetRealAvailRatioResponse {
948
+ /**
949
+ * 国内平均可用率
950
+ */
951
+ AvgAvailRatio?: number;
952
+ /**
953
+ * 各省份最低可用率
954
+ */
955
+ LowestAvailRatio?: number;
956
+ /**
957
+ * 可用率最低的省份
958
+ */
959
+ LowestProvince?: string;
960
+ /**
961
+ * 可用率最低的运营商
962
+ */
963
+ LowestIsp?: string;
964
+ /**
965
+ * 分省份的可用率数据
966
+ */
967
+ ProvinceData?: Array<ProvinceDetail>;
968
+ /**
969
+ * 国内平均耗时,单位毫秒
970
+ */
971
+ AvgTime?: number;
972
+ /**
973
+ * 国外平均可用率
974
+ */
975
+ AvgAvailRatio2?: number;
976
+ /**
977
+ * 国外平均耗时,单位毫秒
978
+ */
979
+ AvgTime2?: number;
980
+ /**
981
+ * 国外最低可用率
982
+ */
983
+ LowestAvailRatio2?: number;
984
+ /**
985
+ * 国外可用率最低的区域
986
+ */
987
+ LowestProvince2?: string;
988
+ /**
989
+ * 国外可用率最低的运营商
990
+ */
991
+ LowestIsp2?: string;
992
+ /**
993
+ * 国外分区域的可用率数据
994
+ */
995
+ ProvinceData2?: Array<ProvinceDetail>;
996
+ /**
997
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
998
+ */
999
+ RequestId?: string;
1000
+ }
1001
+ /**
1002
+ * UpdateProbeTaskConfigurationList返回参数结构体
1003
+ */
1004
+ export interface UpdateProbeTaskConfigurationListResponse {
1005
+ /**
1006
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1007
+ */
1008
+ RequestId?: string;
1009
+ }
1010
+ /**
1011
+ * CreateAgentGroup请求参数结构体
1012
+ */
1013
+ export interface CreateAgentGroupRequest {
1014
+ /**
1015
+ * 拨测分组名称,不超过32个字符
1016
+ */
1017
+ GroupName: string;
1018
+ /**
1019
+ * 是否为默认分组,取值可为 0 或 1。取 1 时表示设置为默认分组
1020
+ */
1021
+ IsDefault: number;
1022
+ /**
1023
+ * Province, Isp 需要成对地进行选择。参数对的取值范围。参见:DescribeAgents 的返回结果。
1024
+ */
1025
+ Agents: Array<CatAgent>;
1026
+ }
1027
+ /**
1028
+ * ResumeProbeTask返回参数结构体
1029
+ */
1030
+ export interface ResumeProbeTaskResponse {
1031
+ /**
1032
+ * 任务总量
1033
+ */
1034
+ Total: number;
1035
+ /**
1036
+ * 任务成功量
1037
+ 注意:此字段可能返回 null,表示取不到有效值。
1038
+ */
1039
+ SuccessCount: number;
1040
+ /**
1041
+ * 任务执行详情
1042
+ 注意:此字段可能返回 null,表示取不到有效值。
1043
+ */
1044
+ Results: Array<TaskResult>;
1045
+ /**
1046
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1047
+ */
1048
+ RequestId?: string;
1049
+ }
1050
+ /**
1051
+ * ModifyTaskEx返回参数结构体
1052
+ */
1053
+ export interface ModifyTaskExResponse {
1054
+ /**
1055
+ * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
1056
+ */
1057
+ TaskId?: number;
1058
+ /**
1059
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1060
+ */
1061
+ RequestId?: string;
1062
+ }
1063
+ /**
1064
+ * DescribeAlarmsByTask返回参数结构体
1065
+ */
1066
+ export interface DescribeAlarmsByTaskResponse {
1067
+ /**
1068
+ * 告警信息列表
1069
+ */
1070
+ AlarmInfos?: Array<AlarmInfo>;
1071
+ /**
1072
+ * 故障率
1073
+ */
1074
+ FaultRatio?: number;
1075
+ /**
1076
+ * 故障总时长
1077
+ */
1078
+ FaultTimeSpec?: string;
1079
+ /**
1080
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1081
+ */
1082
+ RequestId?: string;
1083
+ }
1084
+ /**
1085
+ * ModifyTaskEx请求参数结构体
1086
+ */
1087
+ export interface ModifyTaskExRequest {
1088
+ /**
1089
+ * http, https, ping, tcp, ftp, smtp, udp, dns 之一
1090
+ */
1091
+ CatTypeName: string;
1092
+ /**
1093
+ * 拨测的URL,例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1094
+ */
1095
+ Url: string;
1096
+ /**
1097
+ * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1098
+ */
1099
+ Period: number;
1100
+ /**
1101
+ * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1102
+ */
1103
+ TaskName: string;
1104
+ /**
1105
+ * 验证成功的拨测任务ID
1106
+ */
1107
+ TaskId: number;
1108
+ /**
1109
+ * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroupList 接口,本参数使用返回结果里的GroupId的值。注意,Type为0时,AgentGroupId为必填
1110
+ */
1111
+ AgentGroupId?: number;
1112
+ /**
1113
+ * 指定域名(如需要)
1114
+ */
1115
+ Host?: string;
1116
+ /**
1117
+ * 拨测目标的端口号
1118
+ */
1119
+ Port?: number;
1120
+ /**
1121
+ * 是否为Header请求(非0 发起Header 请求。为0,且PostData非空,发起POST请求。为0,PostData为空,发起GET请求)
1122
+ */
1123
+ IsHeader?: number;
1124
+ /**
1125
+ * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
1126
+ */
1127
+ SslVer?: string;
1128
+ /**
1129
+ * POST 请求数据,空字符串表示非POST请求
1130
+ */
1131
+ PostData?: string;
1132
+ /**
1133
+ * 用户Agent信息
1134
+ */
1135
+ UserAgent?: string;
1136
+ /**
1137
+ * 要在结果中进行匹配的字符串
1138
+ */
1139
+ CheckStr?: string;
1140
+ /**
1141
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
1142
+ */
1143
+ CheckType?: number;
1144
+ /**
1145
+ * 需要设置的Cookie信息
1146
+ */
1147
+ Cookie?: string;
1148
+ /**
1149
+ * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1150
+ */
1151
+ UserName?: string;
1152
+ /**
1153
+ * 登录服务器的密码
1154
+ */
1155
+ PassWord?: string;
1156
+ /**
1157
+ * 缺省为0,0 表示请求为字符串类型, 1表示为二进制类型
1158
+ */
1159
+ ReqDataType?: number;
1160
+ /**
1161
+ * 发起TCP, UDP请求的协议请求数据
1162
+ */
1163
+ ReqData?: string;
1164
+ /**
1165
+ * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1166
+ */
1167
+ RespDataType?: string;
1168
+ /**
1169
+ * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1170
+ */
1171
+ RespData?: string;
1172
+ /**
1173
+ * 目的DNS服务器,可以为空字符串
1174
+ */
1175
+ DnsSvr?: string;
1176
+ /**
1177
+ * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1178
+ */
1179
+ DnsCheckIp?: string;
1180
+ /**
1181
+ * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1182
+ */
1183
+ DnsQueryType?: string;
1184
+ /**
1185
+ * 是否使用安全链接SSL, 0 不使用,1 使用
1186
+ */
1187
+ UseSecConn?: number;
1188
+ /**
1189
+ * FTP登录验证方式, 0 不验证 1 匿名登录 2 需要身份验证
1190
+ */
1191
+ NeedAuth?: number;
1192
+ /**
1193
+ * Type=0 默认 (站点监控) Type=2 可用率监控
1194
+ */
1195
+ Type?: number;
1196
+ /**
1197
+ * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1198
+ */
1199
+ RedirectFollowNum?: number;
1200
+ }
1201
+ /**
1202
+ * ResumeProbeTask请求参数结构体
1203
+ */
1204
+ export interface ResumeProbeTaskRequest {
1205
+ /**
1206
+ * 任务 ID
1207
+ */
1208
+ TaskIds: Array<string>;
1209
+ }
1210
+ /**
1211
+ * DescribeTasksByType请求参数结构体
1212
+ */
1213
+ export interface DescribeTasksByTypeRequest {
1214
+ /**
1215
+ * 从第Offset 条开始查询。缺省值为0
1216
+ */
1217
+ Offset?: number;
1218
+ /**
1219
+ * 本批次查询Limit 条记录。缺省值为20
1220
+ */
1221
+ Limit?: number;
1222
+ /**
1223
+ * 拨测任务类型。0 站点监控,2 可用性监控。缺省值为2
1224
+ */
1225
+ Type?: number;
1226
+ }
1227
+ /**
1228
+ * 探测节点
1229
+ */
1230
+ export interface NodeDefine {
1231
+ /**
1232
+ * 节点名称
1233
+ */
1234
+ Name: string;
1235
+ /**
1236
+ * 节点代码
1237
+ */
1238
+ Code: string;
1239
+ /**
1240
+ * 节点类型
1241
+ <li> 1 = IDC </li>
1242
+ <li> 2 = LastMile </li>
1243
+ <li> 3 = Mobile </li>
1244
+ */
1245
+ Type: number;
1246
+ /**
1247
+ * 网络服务商
1248
+ */
1249
+ NetService: string;
1250
+ /**
1251
+ * 区域
1252
+ */
1253
+ District: string;
1254
+ /**
1255
+ * 城市
1256
+ */
1257
+ City: string;
1258
+ /**
1259
+ * IP 类型
1260
+ <li> 1 = IPv4 </li>
1261
+ <li> 2 = IPv6 </li>
1262
+ 注意:此字段可能返回 null,表示取不到有效值。
1263
+ */
1264
+ IPType: number;
1265
+ /**
1266
+ * 区域
1267
+ <li> 1 = 中国大陆 </li>
1268
+ <li> 2 = 港澳台 </li>
1269
+ <li> 3 = 国外 </li>
1270
+ 注意:此字段可能返回 null,表示取不到有效值。
1271
+ */
1272
+ Location: number;
1273
+ }
1274
+ /**
1275
+ * GetReturnCodeHistory返回参数结构体
1276
+ */
1277
+ export interface GetReturnCodeHistoryResponse {
1278
+ /**
1279
+ * 拨测失败详情列表
1280
+ */
1281
+ Details?: Array<CatReturnDetail>;
1282
+ /**
1283
+ * 拨测失败汇总列表
1284
+ */
1285
+ Summary?: Array<CatReturnSummary>;
1286
+ /**
1287
+ * 开始时间
1288
+ */
1289
+ BeginTime?: string;
1290
+ /**
1291
+ * 截至时间
1292
+ */
1293
+ EndTime?: string;
1294
+ /**
1295
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1296
+ */
1297
+ RequestId?: string;
1298
+ }
1299
+ /**
1300
+ * GetAvailRatioHistory请求参数结构体
1301
+ */
1302
+ export interface GetAvailRatioHistoryRequest {
1303
+ /**
1304
+ * 拨测任务Id
1305
+ */
1306
+ TaskId: number;
1307
+ /**
1308
+ * 具体时间点
1309
+ */
1310
+ TimeStamp: string;
794
1311
  }
795
1312
  /**
796
- * PauseTask返回参数结构体
1313
+ * GetTaskTotalNumber返回参数结构体
797
1314
  */
798
- export interface PauseTaskResponse {
1315
+ export interface GetTaskTotalNumberResponse {
1316
+ /**
1317
+ * 拨测任务总数
1318
+ */
1319
+ TotalCount?: number;
799
1320
  /**
800
1321
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
801
1322
  */
802
1323
  RequestId?: string;
803
1324
  }
804
1325
  /**
805
- * CreateAgentGroup请求参数结构体
1326
+ * 拨测点维度信息
806
1327
  */
807
- export interface CreateAgentGroupRequest {
808
- /**
809
- * 拨测分组名称,不超过32个字符
810
- */
811
- GroupName: string;
1328
+ export interface DimensionsDetail {
812
1329
  /**
813
- * 是否为默认分组,取值可为 0 或 1。取 1 时表示设置为默认分组
1330
+ * 运营商列表
814
1331
  */
815
- IsDefault: number;
1332
+ Isp?: Array<string>;
816
1333
  /**
817
- * Province, Isp 需要成对地进行选择。参数对的取值范围。参见:DescribeAgents 的返回结果。
1334
+ * 省份列表
818
1335
  */
819
- Agents: Array<CatAgent>;
1336
+ Province?: Array<string>;
820
1337
  }
821
1338
  /**
822
- * 拨测记录
1339
+ * GetDailyAvailRatio请求参数结构体
823
1340
  */
824
- export interface CatLog {
825
- /**
826
- * 拨测时间点
827
- */
828
- Time: string;
1341
+ export interface GetDailyAvailRatioRequest {
829
1342
  /**
830
- * 拨测类型
1343
+ * 拨测任务Id
831
1344
  */
832
- CatTypeName: string;
1345
+ TaskId: number;
1346
+ }
1347
+ /**
1348
+ * 拨测失败返回情况汇总
1349
+ */
1350
+ export interface CatReturnSummary {
833
1351
  /**
834
- * 任务ID
1352
+ * 拨测失败个数
835
1353
  */
836
- TaskId: number;
1354
+ ResultCount: number;
837
1355
  /**
838
- * 拨测点所在城市
1356
+ * 拨测失败返回码
839
1357
  */
840
- City: string;
1358
+ ResultCode: number;
841
1359
  /**
842
- * 拨测点所在运营商
1360
+ * 拨测失败原因描述
843
1361
  */
844
- Isp: string;
1362
+ ErrorReason: string;
1363
+ }
1364
+ /**
1365
+ * 任务执行结果
1366
+ */
1367
+ export interface TaskResult {
845
1368
  /**
846
- * 被拨测Server的IP
1369
+ * 任务 ID
847
1370
  */
848
- ServerIp: string;
1371
+ TaskId: string;
849
1372
  /**
850
- * 被拨测Server的域名
1373
+ * 是否成功
1374
+ 注意:此字段可能返回 null,表示取不到有效值。
851
1375
  */
852
- DomainName: string;
1376
+ Success: boolean;
853
1377
  /**
854
- * 执行耗时,单位毫秒
1378
+ * 错误信息
1379
+ 注意:此字段可能返回 null,表示取不到有效值。
855
1380
  */
856
- TotalTime: number;
1381
+ ErrorMessage: string;
1382
+ }
1383
+ /**
1384
+ * SuspendProbeTask返回参数结构体
1385
+ */
1386
+ export interface SuspendProbeTaskResponse {
857
1387
  /**
858
- * 成功失败(1 失败,0 成功)
1388
+ * 任务总量
859
1389
  */
860
- ResultType: number;
1390
+ Total: number;
861
1391
  /**
862
- * 失败错误码
1392
+ * 任务成功量
1393
+ 注意:此字段可能返回 null,表示取不到有效值。
863
1394
  */
864
- ResultCode: number;
1395
+ SuccessCount: number;
865
1396
  /**
866
- * 请求包大小
1397
+ * 任务执行结果
1398
+ 注意:此字段可能返回 null,表示取不到有效值。
867
1399
  */
868
- ReqPkgSize: number;
1400
+ Results: Array<TaskResult>;
869
1401
  /**
870
- * 回应包大小
1402
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
871
1403
  */
872
- RspPkgSize: number;
1404
+ RequestId?: string;
1405
+ }
1406
+ /**
1407
+ * GetRespTimeTrendEx返回参数结构体
1408
+ */
1409
+ export interface GetRespTimeTrendExResponse {
873
1410
  /**
874
- * 拨测请求
1411
+ * 数据点集合,时延等走势数据
875
1412
  */
876
- ReqMsg: string;
1413
+ DataPoints?: Array<DataPointMetric>;
877
1414
  /**
878
- * 拨测回应
1415
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
879
1416
  */
880
- RespMsg: string;
1417
+ RequestId?: string;
1418
+ }
1419
+ /**
1420
+ * 包含MetricName的DataPoint数据
1421
+ */
1422
+ export interface DataPointMetric {
881
1423
  /**
882
- * 客户端IP
1424
+ * 数据项
883
1425
  */
884
- ClientIp: string;
1426
+ MetricName: string;
885
1427
  /**
886
- * 拨测点所在城市名称
1428
+ * 数据点的时间和值
887
1429
  */
888
- CityName: string;
1430
+ Points: Array<DataPoint>;
1431
+ }
1432
+ /**
1433
+ * DescribeCatLogs请求参数结构体
1434
+ */
1435
+ export interface DescribeCatLogsRequest {
889
1436
  /**
890
- * 拨测点所在运营商名称
1437
+ * 拨测任务Id
891
1438
  */
892
- IspName: string;
1439
+ TaskId: number;
893
1440
  /**
894
- * 解析耗时,单位毫秒
1441
+ * 从第Offset 条开始查询。缺省值为0
895
1442
  */
896
- ParseTime: number;
1443
+ Offset?: number;
897
1444
  /**
898
- * 连接耗时,单位毫秒
1445
+ * 本批次查询Limit 条记录。缺省值为20
899
1446
  */
900
- ConnectTime: number;
1447
+ Limit?: number;
901
1448
  /**
902
- * 数据发送耗时,单位毫秒
1449
+ * 格式如:2017-05-09 00:00:00 缺省为当天0点,最多拉取1天的数据
903
1450
  */
904
- SendTime: number;
1451
+ BeginTime?: string;
905
1452
  /**
906
- * 等待耗时,单位毫秒
1453
+ * 格式如:2017-05-10 00:00:00 缺省为当前时间
907
1454
  */
908
- WaitTime: number;
1455
+ EndTime?: string;
909
1456
  /**
910
- * 接收耗时,单位毫秒
1457
+ * 按时间升序或降序。默认降序。可选值: Desc, Asc
911
1458
  */
912
- ReceiveTime: number;
1459
+ SortType?: string;
913
1460
  }
914
1461
  /**
915
- * GetDailyAvailRatio返回参数结构体
1462
+ * GetAvailRatioHistory返回参数结构体
916
1463
  */
917
- export interface GetDailyAvailRatioResponse {
1464
+ export interface GetAvailRatioHistoryResponse {
918
1465
  /**
919
1466
  * 整体平均可用率
920
1467
  */
@@ -927,6 +1474,10 @@ export interface GetDailyAvailRatioResponse {
927
1474
  * 可用率最低的省份
928
1475
  */
929
1476
  LowestProvince?: string;
1477
+ /**
1478
+ * 可用率最低的运营商
1479
+ */
1480
+ LowestIsp?: string;
930
1481
  /**
931
1482
  * 分省份的可用率数据
932
1483
  */
@@ -951,6 +1502,10 @@ export interface GetDailyAvailRatioResponse {
951
1502
  * 国外可用率最低的区域
952
1503
  */
953
1504
  LowestProvince2?: string;
1505
+ /**
1506
+ * 国外可用率最低的运营商
1507
+ */
1508
+ LowestIsp2?: string;
954
1509
  /**
955
1510
  * 国外分区域的可用率数据
956
1511
  */
@@ -961,303 +1516,274 @@ export interface GetDailyAvailRatioResponse {
961
1516
  RequestId?: string;
962
1517
  }
963
1518
  /**
964
- * DeleteAgentGroup请求参数结构体
1519
+ * DescribeProbeTasks返回参数结构体
965
1520
  */
966
- export interface DeleteAgentGroupRequest {
1521
+ export interface DescribeProbeTasksResponse {
967
1522
  /**
968
- * 拨测分组id
1523
+ * 任务列表
1524
+ 注意:此字段可能返回 null,表示取不到有效值。
969
1525
  */
970
- GroupId: number;
971
- }
972
- /**
973
- * GetAvailRatioHistory请求参数结构体
974
- */
975
- export interface GetAvailRatioHistoryRequest {
1526
+ TaskSet: Array<ProbeTask>;
976
1527
  /**
977
- * 拨测任务Id
1528
+ * 任务总数
978
1529
  */
979
- TaskId: number;
1530
+ Total: number;
980
1531
  /**
981
- * 具体时间点
1532
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
982
1533
  */
983
- TimeStamp: string;
1534
+ RequestId?: string;
984
1535
  }
985
1536
  /**
986
- * DescribeAgentGroups请求参数结构体
987
- */
988
- export declare type DescribeAgentGroupsRequest = null;
989
- /**
990
- * DescribeAlarmsByTask返回参数结构体
1537
+ * DescribeAlarms返回参数结构体
991
1538
  */
992
- export interface DescribeAlarmsByTaskResponse {
993
- /**
994
- * 告警信息列表
995
- */
996
- AlarmInfos?: Array<AlarmInfo>;
1539
+ export interface DescribeAlarmsResponse {
997
1540
  /**
998
- * 故障率
1541
+ * 告警总条数
999
1542
  */
1000
- FaultRatio?: number;
1543
+ TotalCount?: number;
1001
1544
  /**
1002
- * 故障总时长
1545
+ * 本批告警信息列表
1003
1546
  */
1004
- FaultTimeSpec?: string;
1547
+ AlarmInfos?: Array<AlarmInfo>;
1005
1548
  /**
1006
1549
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1007
1550
  */
1008
1551
  RequestId?: string;
1009
1552
  }
1010
1553
  /**
1011
- * ModifyTaskEx请求参数结构体
1554
+ * DescribeTasksByType返回参数结构体
1012
1555
  */
1013
- export interface ModifyTaskExRequest {
1014
- /**
1015
- * http, https, ping, tcp, ftp, smtp, udp, dns 之一
1016
- */
1017
- CatTypeName: string;
1018
- /**
1019
- * 拨测的URL,例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1020
- */
1021
- Url: string;
1022
- /**
1023
- * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1024
- */
1025
- Period: number;
1026
- /**
1027
- * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1028
- */
1029
- TaskName: string;
1030
- /**
1031
- * 验证成功的拨测任务ID
1032
- */
1033
- TaskId: number;
1034
- /**
1035
- * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroupList 接口,本参数使用返回结果里的GroupId的值。注意,Type为0时,AgentGroupId为必填
1036
- */
1037
- AgentGroupId?: number;
1038
- /**
1039
- * 指定域名(如需要)
1040
- */
1041
- Host?: string;
1042
- /**
1043
- * 拨测目标的端口号
1044
- */
1045
- Port?: number;
1046
- /**
1047
- * 是否为Header请求(非0 发起Header 请求。为0,且PostData非空,发起POST请求。为0,PostData为空,发起GET请求)
1048
- */
1049
- IsHeader?: number;
1050
- /**
1051
- * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
1052
- */
1053
- SslVer?: string;
1054
- /**
1055
- * POST 请求数据,空字符串表示非POST请求
1056
- */
1057
- PostData?: string;
1556
+ export interface DescribeTasksByTypeResponse {
1058
1557
  /**
1059
- * 用户Agent信息
1558
+ * 符合条件的总任务数
1060
1559
  */
1061
- UserAgent?: string;
1560
+ TotalCount?: number;
1062
1561
  /**
1063
- * 要在结果中进行匹配的字符串
1562
+ * 任务列表
1064
1563
  */
1065
- CheckStr?: string;
1564
+ Tasks?: Array<TaskAlarm>;
1066
1565
  /**
1067
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1566
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1068
1567
  */
1069
- CheckType?: number;
1568
+ RequestId?: string;
1569
+ }
1570
+ /**
1571
+ * DescribeAlarmTopic请求参数结构体
1572
+ */
1573
+ export interface DescribeAlarmTopicRequest {
1070
1574
  /**
1071
- * 需要设置的Cookie信息
1575
+ * 如果不存在拨测相关的主题,是否自动创建一个。取值可为0, 1,默认为0
1072
1576
  */
1073
- Cookie?: string;
1577
+ NeedAdd?: number;
1578
+ }
1579
+ /**
1580
+ * DescribeAgentGroups返回参数结构体
1581
+ */
1582
+ export interface DescribeAgentGroupsResponse {
1074
1583
  /**
1075
- * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1584
+ * 用户所属的系统默认拨测分组
1076
1585
  */
1077
- UserName?: string;
1586
+ SysDefaultGroup?: AgentGroup;
1078
1587
  /**
1079
- * 登录服务器的密码
1588
+ * 用户创建的拨测分组列表
1080
1589
  */
1081
- PassWord?: string;
1590
+ CustomGroups?: Array<AgentGroup>;
1082
1591
  /**
1083
- * 缺省为0,0 表示请求为字符串类型, 1表示为二进制类型
1592
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1084
1593
  */
1085
- ReqDataType?: number;
1594
+ RequestId?: string;
1595
+ }
1596
+ /**
1597
+ * SuspendProbeTask请求参数结构体
1598
+ */
1599
+ export interface SuspendProbeTaskRequest {
1086
1600
  /**
1087
- * 发起TCP, UDP请求的协议请求数据
1601
+ * 任务 ID
1088
1602
  */
1089
- ReqData?: string;
1603
+ TaskIds: Array<string>;
1604
+ }
1605
+ /**
1606
+ * GetRespTimeTrendEx请求参数结构体
1607
+ */
1608
+ export interface GetRespTimeTrendExRequest {
1090
1609
  /**
1091
- * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1610
+ * 验证成功的拨测任务id
1092
1611
  */
1093
- RespDataType?: string;
1612
+ TaskId: number;
1094
1613
  /**
1095
- * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1614
+ * 统计数据的发生日期。格式如:2017-05-09
1096
1615
  */
1097
- RespData?: string;
1616
+ Date: string;
1098
1617
  /**
1099
- * 目的DNS服务器,可以为空字符串
1618
+ * 数据的采集周期,单位分钟。取值可为 1, 5, 15, 30
1100
1619
  */
1101
- DnsSvr?: string;
1620
+ Period: number;
1102
1621
  /**
1103
- * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1622
+ * 可为 Isp, Province
1104
1623
  */
1105
- DnsCheckIp?: string;
1624
+ Dimensions?: DimensionsDetail;
1106
1625
  /**
1107
- * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1626
+ * 可为 totalTime, parseTime, connectTime, sendTime, waitTime, receiveTime, availRatio。缺省值为 totalTime
1108
1627
  */
1109
- DnsQueryType?: string;
1628
+ MetricName?: string;
1629
+ }
1630
+ /**
1631
+ * UpdateProbeTaskConfigurationList请求参数结构体
1632
+ */
1633
+ export interface UpdateProbeTaskConfigurationListRequest {
1110
1634
  /**
1111
- * 是否使用安全链接SSL, 0 不使用,1 使用
1635
+ * 任务 ID
1112
1636
  */
1113
- UseSecConn?: number;
1637
+ TaskIds: Array<string>;
1114
1638
  /**
1115
- * FTP登录验证方式, 0 不验证 1 匿名登录 2 需要身份验证
1639
+ * 拨测节点
1116
1640
  */
1117
- NeedAuth?: number;
1641
+ Nodes: Array<string>;
1118
1642
  /**
1119
- * Type=0 默认 (站点监控) Type=2 可用率监控
1643
+ * 拨测间隔
1120
1644
  */
1121
- Type?: number;
1645
+ Interval: number;
1122
1646
  /**
1123
- * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1647
+ * 拨测参数
1124
1648
  */
1125
- RedirectFollowNum?: number;
1126
- }
1127
- /**
1128
- * DescribeAlarmTopic请求参数结构体
1129
- */
1130
- export interface DescribeAlarmTopicRequest {
1649
+ Parameters: string;
1131
1650
  /**
1132
- * 如果不存在拨测相关的主题,是否自动创建一个。取值可为0, 1,默认为0
1651
+ * 定时任务cron表达式
1133
1652
  */
1134
- NeedAdd?: number;
1653
+ Cron?: string;
1135
1654
  }
1136
1655
  /**
1137
- * CreateTaskEx请求参数结构体
1656
+ * CreateProbeTasks请求参数结构体
1138
1657
  */
1139
- export interface CreateTaskExRequest {
1658
+ export interface CreateProbeTasksRequest {
1140
1659
  /**
1141
- * http, https, ping, tcp, ftp, smtp, udp, dns 之一
1660
+ * 批量任务名-地址
1142
1661
  */
1143
- CatTypeName: string;
1662
+ BatchTasks: Array<ProbeTaskBasicConfiguration>;
1144
1663
  /**
1145
- * 拨测的URL, 例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1664
+ * 任务类型
1146
1665
  */
1147
- Url: string;
1666
+ TaskType: number;
1148
1667
  /**
1149
- * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1668
+ * 探测节点
1150
1669
  */
1151
- Period: number;
1670
+ Nodes: Array<string>;
1152
1671
  /**
1153
- * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1672
+ * 探测间隔
1154
1673
  */
1155
- TaskName: string;
1674
+ Interval: number;
1156
1675
  /**
1157
- * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroups 接口,本参数使用返回结果里的GroupId的值。注意: Type为0时,AgentGroupId为必填
1676
+ * 探测参数
1158
1677
  */
1159
- AgentGroupId?: number;
1678
+ Parameters: string;
1160
1679
  /**
1161
- * 指定域名(如需要)
1680
+ * 任务分类
1681
+ <li>1 = PC</li>
1682
+ <li> 2 = Mobile </li>
1162
1683
  */
1163
- Host?: string;
1684
+ TaskCategory: number;
1164
1685
  /**
1165
- * 是否为Header请求(非0 发起Header 请求。为0,且PostData 非空,发起POST请求。为0,PostData 为空,发起GET请求)
1686
+ * 定时任务cron表达式
1166
1687
  */
1167
- IsHeader?: number;
1688
+ Cron?: string;
1689
+ }
1690
+ /**
1691
+ * 拨测记录
1692
+ */
1693
+ export interface CatLog {
1168
1694
  /**
1169
- * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
1695
+ * 拨测时间点
1170
1696
  */
1171
- SslVer?: string;
1697
+ Time: string;
1172
1698
  /**
1173
- * POST请求数据。空字符串表示非POST请求
1699
+ * 拨测类型
1174
1700
  */
1175
- PostData?: string;
1701
+ CatTypeName: string;
1176
1702
  /**
1177
- * 用户Agent信息
1703
+ * 任务ID
1178
1704
  */
1179
- UserAgent?: string;
1705
+ TaskId: number;
1180
1706
  /**
1181
- * 要在结果中进行匹配的字符串
1707
+ * 拨测点所在城市
1182
1708
  */
1183
- CheckStr?: string;
1709
+ City: string;
1184
1710
  /**
1185
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1711
+ * 拨测点所在运营商
1186
1712
  */
1187
- CheckType?: number;
1713
+ Isp: string;
1188
1714
  /**
1189
- * 需要设置的Cookie信息
1715
+ * 被拨测Server的IP
1190
1716
  */
1191
- Cookie?: string;
1717
+ ServerIp: string;
1192
1718
  /**
1193
- * 任务ID,用于验证且修改任务时传入原任务ID
1719
+ * 被拨测Server的域名
1194
1720
  */
1195
- TaskId?: number;
1721
+ DomainName: string;
1196
1722
  /**
1197
- * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1723
+ * 执行耗时,单位毫秒
1198
1724
  */
1199
- UserName?: string;
1725
+ TotalTime: number;
1200
1726
  /**
1201
- * 登录服务器的密码
1727
+ * 成功失败(1 失败,0 成功)
1202
1728
  */
1203
- PassWord?: string;
1729
+ ResultType: number;
1204
1730
  /**
1205
- * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1731
+ * 失败错误码
1206
1732
  */
1207
- ReqDataType?: number;
1733
+ ResultCode: number;
1208
1734
  /**
1209
- * 发起TCP, UDP请求的协议请求数据
1735
+ * 请求包大小
1210
1736
  */
1211
- ReqData?: string;
1737
+ ReqPkgSize: number;
1212
1738
  /**
1213
- * 缺省为0。0 表示响应为字符串类型。1表示为二进制类型
1739
+ * 回应包大小
1214
1740
  */
1215
- RespDataType?: number;
1741
+ RspPkgSize: number;
1216
1742
  /**
1217
- * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1743
+ * 拨测请求
1218
1744
  */
1219
- RespData?: string;
1745
+ ReqMsg: string;
1220
1746
  /**
1221
- * 目的DNS服务器 可以为空字符串
1747
+ * 拨测回应
1222
1748
  */
1223
- DnsSvr?: string;
1749
+ RespMsg: string;
1224
1750
  /**
1225
- * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1751
+ * 客户端IP
1226
1752
  */
1227
- DnsCheckIp?: string;
1753
+ ClientIp: string;
1228
1754
  /**
1229
- * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1755
+ * 拨测点所在城市名称
1230
1756
  */
1231
- DnsQueryType?: string;
1757
+ CityName: string;
1232
1758
  /**
1233
- * 是否使用安全链接SSL, 0 不使用,1 使用
1759
+ * 拨测点所在运营商名称
1234
1760
  */
1235
- UseSecConn?: number;
1761
+ IspName: string;
1236
1762
  /**
1237
- * FTP登录验证方式, 0 不验证 , 1 匿名登录, 2 需要身份验证
1763
+ * 解析耗时,单位毫秒
1238
1764
  */
1239
- NeedAuth?: number;
1765
+ ParseTime: number;
1240
1766
  /**
1241
- * 拨测目标的端口号
1767
+ * 连接耗时,单位毫秒
1242
1768
  */
1243
- Port?: number;
1769
+ ConnectTime: number;
1244
1770
  /**
1245
- * Type=0 默认 (站点监控)Type=2 可用率监控
1771
+ * 数据发送耗时,单位毫秒
1246
1772
  */
1247
- Type?: number;
1773
+ SendTime: number;
1248
1774
  /**
1249
- * IsVerify=0 非验证任务 IsVerify=1 验证任务,不传则默认为0
1775
+ * 等待耗时,单位毫秒
1250
1776
  */
1251
- IsVerify?: number;
1777
+ WaitTime: number;
1252
1778
  /**
1253
- * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1779
+ * 接收耗时,单位毫秒
1254
1780
  */
1255
- RedirectFollowNum?: number;
1781
+ ReceiveTime: number;
1256
1782
  }
1257
1783
  /**
1258
- * GetTaskTotalNumber请求参数结构体
1784
+ * DescribeAgentGroups请求参数结构体
1259
1785
  */
1260
- export declare type GetTaskTotalNumberRequest = null;
1786
+ export declare type DescribeAgentGroupsRequest = null;
1261
1787
  /**
1262
1788
  * 可用性监控任务状态及告警信息
1263
1789
  */
@@ -1304,246 +1830,275 @@ export interface TaskAlarm {
1304
1830
  UpdateTime: string;
1305
1831
  }
1306
1832
  /**
1307
- * DescribeTasksByType请求参数结构体
1833
+ * DescribeCatLogs返回参数结构体
1308
1834
  */
1309
- export interface DescribeTasksByTypeRequest {
1310
- /**
1311
- * 从第Offset 条开始查询。缺省值为0
1312
- */
1313
- Offset?: number;
1835
+ export interface DescribeCatLogsResponse {
1314
1836
  /**
1315
- * 本批次查询Limit 条记录。缺省值为20
1837
+ * 符合条件的总记录数
1316
1838
  */
1317
- Limit?: number;
1839
+ TotalCount?: number;
1318
1840
  /**
1319
- * 拨测任务类型。0 站点监控,2 可用性监控。缺省值为2
1841
+ * 拨测记录列表
1320
1842
  */
1321
- Type?: number;
1322
- }
1323
- /**
1324
- * VerifyResult请求参数结构体
1325
- */
1326
- export interface VerifyResultRequest {
1843
+ CatLogs?: Array<CatLog>;
1327
1844
  /**
1328
- * 要查询的拨测任务的结果id
1845
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1329
1846
  */
1330
- ResultId: number;
1847
+ RequestId?: string;
1331
1848
  }
1332
1849
  /**
1333
- * VerifyResult返回参数结构体
1850
+ * 单条详细拨测数据
1334
1851
  */
1335
- export interface VerifyResultResponse {
1852
+ export interface DetailedSingleDataDefine {
1336
1853
  /**
1337
- * 错误的原因
1854
+ * 拨测时间戳
1338
1855
  */
1339
- ErrorReason?: string;
1856
+ ProbeTime: number;
1340
1857
  /**
1341
- * 错误号
1858
+ * 储存所有string类型字段
1342
1859
  */
1343
- ResultCode?: number;
1860
+ Labels: Array<Label>;
1344
1861
  /**
1345
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1862
+ * 储存所有float类型字段
1346
1863
  */
1347
- RequestId?: string;
1864
+ Fields: Array<Field>;
1348
1865
  }
1349
1866
  /**
1350
- * 任务信息和告警策略组
1867
+ * GetReturnCodeInfo返回参数结构体
1351
1868
  */
1352
- export interface CatTaskDetail {
1353
- /**
1354
- * 任务ID
1355
- */
1356
- TaskId: number;
1357
- /**
1358
- * 任务名称
1359
- */
1360
- TaskName: string;
1361
- /**
1362
- * 任务周期,单位为分钟。目前支持1,5,15,30几种取值
1363
- */
1364
- Period: number;
1365
- /**
1366
- * 拨测类型。http, https, ping, tcp 之一
1367
- */
1368
- CatTypeName: string;
1869
+ export interface GetReturnCodeInfoResponse {
1369
1870
  /**
1370
- * 拨测任务的URL
1871
+ * 拨测失败详情列表
1371
1872
  */
1372
- CgiUrl: string;
1873
+ Details?: Array<CatReturnDetail>;
1373
1874
  /**
1374
- * 拨测分组ID
1875
+ * 拨测失败汇总列表
1375
1876
  */
1376
- AgentGroupId: number;
1877
+ Summary?: Array<CatReturnSummary>;
1377
1878
  /**
1378
- * 告警策略组ID
1879
+ * 开始时间
1379
1880
  */
1380
- PolicyGroupId: number;
1881
+ BeginTime?: string;
1381
1882
  /**
1382
- * 任务状态。1表示暂停,2表示运行中,0为初始态
1883
+ * 截至时间
1383
1884
  */
1384
- Status?: number;
1885
+ EndTime?: string;
1385
1886
  /**
1386
- * 任务创建时间
1887
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1387
1888
  */
1388
- AddTime?: string;
1889
+ RequestId?: string;
1890
+ }
1891
+ /**
1892
+ * BindAlarmPolicy返回参数结构体
1893
+ */
1894
+ export interface BindAlarmPolicyResponse {
1389
1895
  /**
1390
- * 任务类型。0 站点监控,2 可用性监控
1896
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1391
1897
  */
1392
- Type?: number;
1898
+ RequestId?: string;
1899
+ }
1900
+ /**
1901
+ * RunTask返回参数结构体
1902
+ */
1903
+ export interface RunTaskResponse {
1393
1904
  /**
1394
- * 绑定的统一告警主题ID
1905
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1395
1906
  */
1396
- TopicId?: string;
1907
+ RequestId?: string;
1908
+ }
1909
+ /**
1910
+ * 储存float类型字段
1911
+ */
1912
+ export interface Field {
1397
1913
  /**
1398
- * 告警状态。0 未启用,1, 启用
1914
+ * 自定义字段编号
1399
1915
  */
1400
- AlarmStatus?: number;
1916
+ ID: number;
1401
1917
  /**
1402
- * 指定的域名
1918
+ * 自定义字段名称/说明
1403
1919
  */
1404
- Host?: string;
1920
+ Name: string;
1405
1921
  /**
1406
- * 拨测目标的端口号
1922
+ * 字段值
1407
1923
  */
1408
- Port?: number;
1924
+ Value: number;
1925
+ }
1926
+ /**
1927
+ * type ProbeTaskBasicConfiguration struct {
1928
+ TaskID TaskID `json:"TaskId" gorm:"column:task_id"`
1929
+ Name string `json:"Name" binding:"required" gorm:"column:name"`
1930
+ TargetAddress string `json:"TargetAddress" binding:"required" gorm:"column:target_address"`
1931
+ }
1932
+ */
1933
+ export interface ProbeTaskBasicConfiguration {
1409
1934
  /**
1410
- * 要在结果中进行匹配的字符串
1935
+ * 拨测任务名称
1411
1936
  */
1412
- CheckStr?: string;
1937
+ Name: string;
1413
1938
  /**
1414
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1939
+ * 拨测目标地址
1415
1940
  */
1416
- CheckType?: number;
1941
+ TargetAddress: string;
1942
+ }
1943
+ /**
1944
+ * VerifyResult请求参数结构体
1945
+ */
1946
+ export interface VerifyResultRequest {
1417
1947
  /**
1418
- * 用户Agent信息
1948
+ * 要查询的拨测任务的结果id
1419
1949
  */
1420
- UserAgent?: string;
1950
+ ResultId: number;
1951
+ }
1952
+ /**
1953
+ * GetTaskTotalNumber请求参数结构体
1954
+ */
1955
+ export declare type GetTaskTotalNumberRequest = null;
1956
+ /**
1957
+ * ModifyAgentGroup返回参数结构体
1958
+ */
1959
+ export interface ModifyAgentGroupResponse {
1421
1960
  /**
1422
- * 设置的Cookie信息
1961
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1423
1962
  */
1424
- Cookie?: string;
1963
+ RequestId?: string;
1964
+ }
1965
+ /**
1966
+ * DescribeTaskDetail请求参数结构体
1967
+ */
1968
+ export interface DescribeTaskDetailRequest {
1425
1969
  /**
1426
- * POST 请求数据。空字符串表示非POST请求
1970
+ * 拨测任务id 数组
1427
1971
  */
1428
- PostData?: string;
1972
+ TaskIds: Array<number>;
1973
+ }
1974
+ /**
1975
+ * GetResultSummary返回参数结构体
1976
+ */
1977
+ export interface GetResultSummaryResponse {
1429
1978
  /**
1430
- * SSL协议版本
1979
+ * 实时统计数据
1431
1980
  */
1432
- SslVer?: string;
1981
+ RealData?: Array<ResultSummary>;
1433
1982
  /**
1434
- * 是否为Header请求。非0 Header 请求
1983
+ * 按天的统计数据
1435
1984
  */
1436
- IsHeader?: number;
1985
+ DayData?: Array<ResultSummary>;
1437
1986
  /**
1438
- * 目的DNS服务器
1987
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1439
1988
  */
1440
- DnsSvr?: string;
1989
+ RequestId?: string;
1990
+ }
1991
+ /**
1992
+ * VerifyResult返回参数结构体
1993
+ */
1994
+ export interface VerifyResultResponse {
1441
1995
  /**
1442
- * 需要检验是否在DNS IP列表的IP
1996
+ * 错误的原因
1443
1997
  */
1444
- DnsCheckIp?: string;
1998
+ ErrorReason?: string;
1445
1999
  /**
1446
- * DNS查询类型
2000
+ * 错误号
1447
2001
  */
1448
- DnsQueryType?: string;
2002
+ ResultCode?: number;
1449
2003
  /**
1450
- * 登录服务器的账号
2004
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1451
2005
  */
1452
- UserName?: string;
2006
+ RequestId?: string;
2007
+ }
2008
+ /**
2009
+ * 告警主题
2010
+ */
2011
+ export interface AlarmTopic {
1453
2012
  /**
1454
- * 登录服务器的密码
2013
+ * 主题的ID
1455
2014
  */
1456
- PassWord?: string;
2015
+ TopicId: string;
1457
2016
  /**
1458
- * 是否使用安全链接SSL, 0 不使用,1 使用
2017
+ * 主题的名称
1459
2018
  */
1460
- UseSecConn?: number;
2019
+ TopicName: string;
2020
+ }
2021
+ /**
2022
+ * DeleteTasks请求参数结构体
2023
+ */
2024
+ export interface DeleteTasksRequest {
1461
2025
  /**
1462
- * FTP登录验证方式 0 不验证 1 匿名登录 2 需要身份验证
2026
+ * 拨测任务id
1463
2027
  */
1464
- NeedAuth?: number;
2028
+ TaskIds: Array<number>;
2029
+ }
2030
+ /**
2031
+ * DescribeProbeTasks请求参数结构体
2032
+ */
2033
+ export interface DescribeProbeTasksRequest {
1465
2034
  /**
1466
- * 请求数据类型。0 表示请求为字符串类型。1表示为二进制类型
2035
+ * 任务 ID 列表
1467
2036
  */
1468
- ReqDataType?: number;
2037
+ TaskIDs?: Array<string>;
1469
2038
  /**
1470
- * 发起TCP, UDP请求的协议请求数据
2039
+ * 任务名
1471
2040
  */
1472
- ReqData?: string;
2041
+ TaskName?: string;
1473
2042
  /**
1474
- * 响应数据类型。0 表示响应为字符串类型。1表示为二进制类型
2043
+ * 探测目标
1475
2044
  */
1476
- RespDataType?: number;
2045
+ TargetAddress?: string;
1477
2046
  /**
1478
- * 预期的UDP请求的回应数据
2047
+ * 任务状态列表
1479
2048
  */
1480
- RespData?: string;
2049
+ TaskStatus?: Array<number>;
1481
2050
  /**
1482
- * 跟随跳转次数
2051
+ * 偏移量,默认为0
1483
2052
  */
1484
- RedirectFollowNum?: number;
1485
- }
1486
- /**
1487
- * GetReturnCodeHistory返回参数结构体
1488
- */
1489
- export interface GetReturnCodeHistoryResponse {
2053
+ Offset?: number;
1490
2054
  /**
1491
- * 拨测失败详情列表
2055
+ * 返回数量,默认为20,最大值为100
1492
2056
  */
1493
- Details?: Array<CatReturnDetail>;
2057
+ Limit?: number;
1494
2058
  /**
1495
- * 拨测失败汇总列表
2059
+ * 付费模式
2060
+ <li>1 = 试用版本</li>
2061
+ <li> 2 = 付费版本 </li>
1496
2062
  */
1497
- Summary?: Array<CatReturnSummary>;
2063
+ PayMode?: number;
1498
2064
  /**
1499
- * 开始时间
2065
+ * 订单状态
2066
+ <li>1 = 正常</li>
2067
+ <li> 2 = 欠费 </li>
1500
2068
  */
1501
- BeginTime?: string;
2069
+ OrderState?: number;
1502
2070
  /**
1503
- * 截至时间
2071
+ * 拨测类型
1504
2072
  */
1505
- EndTime?: string;
2073
+ TaskType?: Array<number>;
1506
2074
  /**
1507
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2075
+ * 节点类型
1508
2076
  */
1509
- RequestId?: string;
1510
- }
1511
- /**
1512
- * 时延等数据,数据点
1513
- */
1514
- export interface DataPoint {
2077
+ TaskCategory?: Array<number>;
1515
2078
  /**
1516
- * 数据点的时间
2079
+ * 排序的列
1517
2080
  */
1518
- LogTime: string;
2081
+ OrderBy?: string;
1519
2082
  /**
1520
- * 数据值
2083
+ * 是否正序
1521
2084
  */
1522
- MetricValue: number;
2085
+ Ascend?: boolean;
1523
2086
  }
1524
2087
  /**
1525
- * DescribeAlarmTopic返回参数结构体
2088
+ * PauseTask返回参数结构体
1526
2089
  */
1527
- export interface DescribeAlarmTopicResponse {
1528
- /**
1529
- * 主题个数
1530
- */
1531
- TotalCount?: number;
1532
- /**
1533
- * 主题列表
1534
- */
1535
- Topics?: Array<AlarmTopic>;
2090
+ export interface PauseTaskResponse {
1536
2091
  /**
1537
2092
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1538
2093
  */
1539
2094
  RequestId?: string;
1540
2095
  }
1541
2096
  /**
1542
- * GetRealAvailRatio返回参数结构体
2097
+ * GetDailyAvailRatio返回参数结构体
1543
2098
  */
1544
- export interface GetRealAvailRatioResponse {
2099
+ export interface GetDailyAvailRatioResponse {
1545
2100
  /**
1546
- * 国内平均可用率
2101
+ * 整体平均可用率
1547
2102
  */
1548
2103
  AvgAvailRatio?: number;
1549
2104
  /**
@@ -1554,10 +2109,6 @@ export interface GetRealAvailRatioResponse {
1554
2109
  * 可用率最低的省份
1555
2110
  */
1556
2111
  LowestProvince?: string;
1557
- /**
1558
- * 可用率最低的运营商
1559
- */
1560
- LowestIsp?: string;
1561
2112
  /**
1562
2113
  * 分省份的可用率数据
1563
2114
  */
@@ -1582,10 +2133,6 @@ export interface GetRealAvailRatioResponse {
1582
2133
  * 国外可用率最低的区域
1583
2134
  */
1584
2135
  LowestProvince2?: string;
1585
- /**
1586
- * 国外可用率最低的运营商
1587
- */
1588
- LowestIsp2?: string;
1589
2136
  /**
1590
2137
  * 国外分区域的可用率数据
1591
2138
  */
@@ -1596,85 +2143,108 @@ export interface GetRealAvailRatioResponse {
1596
2143
  RequestId?: string;
1597
2144
  }
1598
2145
  /**
1599
- * RunTask返回参数结构体
2146
+ * DeleteAgentGroup请求参数结构体
1600
2147
  */
1601
- export interface RunTaskResponse {
2148
+ export interface DeleteAgentGroupRequest {
1602
2149
  /**
1603
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2150
+ * 拨测分组id
1604
2151
  */
1605
- RequestId?: string;
2152
+ GroupId: number;
1606
2153
  }
1607
2154
  /**
1608
- * 拨测Agent 所在省份、运营商
2155
+ * GetRealAvailRatio请求参数结构体
1609
2156
  */
1610
- export interface CatAgent {
2157
+ export interface GetRealAvailRatioRequest {
1611
2158
  /**
1612
- * 拨测结点所在的省份(拼音缩写)
2159
+ * 拨测任务Id
1613
2160
  */
1614
- Province: string;
2161
+ TaskId: number;
2162
+ }
2163
+ /**
2164
+ * DeleteProbeTask返回参数结构体
2165
+ */
2166
+ export interface DeleteProbeTaskResponse {
1615
2167
  /**
1616
- * 拨测结点所在的运营商(英文缩写)
2168
+ * 任务总量
1617
2169
  */
1618
- Isp: string;
2170
+ Total: number;
1619
2171
  /**
1620
- * 拨测结点所在的省份(中文名称)
2172
+ * 任务成功量
1621
2173
  注意:此字段可能返回 null,表示取不到有效值。
1622
2174
  */
1623
- ProvinceName?: string;
2175
+ SuccessCount: number;
1624
2176
  /**
1625
- * 拨测结点所在的运营商(中文名称)
2177
+ * 任务执行结果
1626
2178
  注意:此字段可能返回 null,表示取不到有效值。
1627
2179
  */
1628
- IspName?: string;
2180
+ Results: Array<TaskResult>;
2181
+ /**
2182
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2183
+ */
2184
+ RequestId?: string;
1629
2185
  }
1630
2186
  /**
1631
- * DescribeCatLogs返回参数结构体
2187
+ * CreateProbeTasks返回参数结构体
1632
2188
  */
1633
- export interface DescribeCatLogsResponse {
1634
- /**
1635
- * 符合条件的总记录数
1636
- */
1637
- TotalCount?: number;
1638
- /**
1639
- * 拨测记录列表
1640
- */
1641
- CatLogs?: Array<CatLog>;
2189
+ export interface CreateProbeTasksResponse {
1642
2190
  /**
1643
2191
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1644
2192
  */
1645
2193
  RequestId?: string;
1646
2194
  }
1647
2195
  /**
1648
- * GetTaskTotalNumber返回参数结构体
2196
+ * DescribeProbeNodes请求参数结构体
1649
2197
  */
1650
- export interface GetTaskTotalNumberResponse {
2198
+ export interface DescribeProbeNodesRequest {
1651
2199
  /**
1652
- * 拨测任务总数
2200
+ * 节点类型
2201
+ <li> 1 = IDC </li>
2202
+ <li> 2 = LastMile </li>
2203
+ <li> 3 = Mobile </li>
1653
2204
  */
1654
- TotalCount?: number;
2205
+ NodeType?: number;
1655
2206
  /**
1656
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2207
+ * 节点区域
2208
+ <li> 1 = 中国大陆 </li>
2209
+ <li> 2 = 港澳台 </li>
2210
+ <li> 3 = 海外 </li>
1657
2211
  */
1658
- RequestId?: string;
2212
+ Location?: number;
2213
+ /**
2214
+ * 是否IPv6
2215
+ */
2216
+ IsIPv6?: boolean;
2217
+ /**
2218
+ * 名字模糊搜索
2219
+ */
2220
+ NodeName?: string;
2221
+ /**
2222
+ * 付费模式
2223
+ <li>1 = 试用版本</li>
2224
+ <li> 2 = 付费版本 </li>
2225
+ */
2226
+ PayMode?: number;
1659
2227
  }
1660
2228
  /**
1661
- * CreateTaskEx返回参数结构体
2229
+ * 拨测Agent 所在省份、运营商
1662
2230
  */
1663
- export interface CreateTaskExResponse {
2231
+ export interface CatAgent {
1664
2232
  /**
1665
- * 拨测结果查询ID。接下来可以使用查询拨测是否能够成功,验证能否通过。
2233
+ * 拨测结点所在的省份(拼音缩写)
1666
2234
  */
1667
- ResultId?: number;
2235
+ Province: string;
1668
2236
  /**
1669
- * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
2237
+ * 拨测结点所在的运营商(英文缩写)
1670
2238
  */
1671
- TaskId?: number;
2239
+ Isp: string;
1672
2240
  /**
1673
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2241
+ * 拨测结点所在的省份(中文名称)
2242
+ 注意:此字段可能返回 null,表示取不到有效值。
1674
2243
  */
1675
- RequestId?: string;
2244
+ ProvinceName?: string;
2245
+ /**
2246
+ * 拨测结点所在的运营商(中文名称)
2247
+ 注意:此字段可能返回 null,表示取不到有效值。
2248
+ */
2249
+ IspName?: string;
1676
2250
  }
1677
- /**
1678
- * DescribeUserLimit请求参数结构体
1679
- */
1680
- export declare type DescribeUserLimitRequest = null;