tencentcloud-sdk-nodejs 4.0.258 → 4.0.262

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 (224) hide show
  1. package/CHANGELOG.md +1086 -95
  2. package/SERVICE_CHANGELOG.md +68050 -0
  3. package/package.json +1 -1
  4. package/products.md +56 -55
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ame/v20190916/ame_models.ts +6 -4
  7. package/src/services/ams/v20201229/ams_client.ts +1 -1
  8. package/src/services/ams/v20201229/ams_models.ts +24 -0
  9. package/src/services/antiddos/v20200309/antiddos_client.ts +40 -3
  10. package/src/services/antiddos/v20200309/antiddos_models.ts +226 -121
  11. package/src/services/asr/v20190614/asr_models.ts +5 -0
  12. package/src/services/cam/v20190116/cam_client.ts +32 -8
  13. package/src/services/cam/v20190116/cam_models.ts +118 -18
  14. package/src/services/cat/v20180409/cat_client.ts +160 -55
  15. package/src/services/cat/v20180409/cat_models.ts +1626 -908
  16. package/src/services/cbs/v20170312/cbs_client.ts +6 -5
  17. package/src/services/cbs/v20170312/cbs_models.ts +122 -87
  18. package/src/services/cdb/v20170320/cdb_client.ts +27 -39
  19. package/src/services/cdb/v20170320/cdb_models.ts +172 -174
  20. package/src/services/cdn/v20180606/cdn_models.ts +11 -0
  21. package/src/services/chdfs/v20201112/chdfs_models.ts +55 -11
  22. package/src/services/ckafka/v20190819/ckafka_client.ts +50 -9
  23. package/src/services/ckafka/v20190819/ckafka_models.ts +308 -28
  24. package/src/services/clb/v20180317/clb_client.ts +14 -2
  25. package/src/services/clb/v20180317/clb_models.ts +19 -19
  26. package/src/services/cls/v20201016/cls_client.ts +65 -15
  27. package/src/services/cls/v20201016/cls_models.ts +258 -70
  28. package/src/services/cme/v20191029/cme_client.ts +2 -1
  29. package/src/services/cme/v20191029/cme_models.ts +31 -14
  30. package/src/services/cvm/v20170312/cvm_client.ts +168 -76
  31. package/src/services/cvm/v20170312/cvm_models.ts +935 -188
  32. package/src/services/dcdb/v20180411/dcdb_client.ts +12 -0
  33. package/src/services/dcdb/v20180411/dcdb_models.ts +35 -0
  34. package/src/services/dlc/v20210125/dlc_client.ts +19 -6
  35. package/src/services/dlc/v20210125/dlc_models.ts +333 -36
  36. package/src/services/dnspod/v20210323/dnspod_models.ts +8 -8
  37. package/src/services/dts/v20180330/dts_models.ts +10 -9
  38. package/src/services/ecdn/v20191012/ecdn_client.ts +5 -4
  39. package/src/services/ecdn/v20191012/ecdn_models.ts +127 -77
  40. package/src/services/es/v20180416/es_client.ts +17 -2
  41. package/src/services/es/v20180416/es_models.ts +291 -18
  42. package/src/services/essbasic/v20210526/essbasic_client.ts +72 -17
  43. package/src/services/essbasic/v20210526/essbasic_models.ts +495 -162
  44. package/src/services/faceid/v20180301/faceid_client.ts +3 -2
  45. package/src/services/faceid/v20180301/faceid_models.ts +6 -6
  46. package/src/services/gme/v20180711/gme_client.ts +1 -3
  47. package/src/services/gme/v20180711/gme_models.ts +8 -3
  48. package/src/services/iecp/index.ts +5 -0
  49. package/src/services/iecp/v20210914/iecp_client.ts +1064 -0
  50. package/src/services/iecp/v20210914/iecp_models.ts +5727 -0
  51. package/src/services/iecp/v20210914/index.ts +6 -0
  52. package/src/services/index.ts +1 -0
  53. package/src/services/kms/v20190118/kms_client.ts +1 -1
  54. package/src/services/kms/v20190118/kms_models.ts +63 -41
  55. package/src/services/lighthouse/v20200324/lighthouse_client.ts +14 -13
  56. package/src/services/lighthouse/v20200324/lighthouse_models.ts +114 -66
  57. package/src/services/mariadb/v20170312/mariadb_client.ts +12 -0
  58. package/src/services/mariadb/v20170312/mariadb_models.ts +30 -0
  59. package/src/services/nlp/v20190408/nlp_client.ts +4 -4
  60. package/src/services/nlp/v20190408/nlp_models.ts +3 -3
  61. package/src/services/oceanus/v20190422/oceanus_models.ts +10 -0
  62. package/src/services/ocr/v20181119/ocr_models.ts +8 -2
  63. package/src/services/postgres/v20170312/postgres_models.ts +56 -12
  64. package/src/services/privatedns/v20201028/privatedns_models.ts +1 -1
  65. package/src/services/scf/v20180416/scf_client.ts +1 -1
  66. package/src/services/scf/v20180416/scf_models.ts +13 -13
  67. package/src/services/sqlserver/v20180328/sqlserver_models.ts +10 -10
  68. package/src/services/ssl/v20191205/ssl_models.ts +2 -2
  69. package/src/services/taf/v20200210/taf_client.ts +1 -0
  70. package/src/services/taf/v20200210/taf_models.ts +20 -0
  71. package/src/services/tcss/v20201101/tcss_models.ts +33 -7
  72. package/src/services/tdmq/v20200217/tdmq_client.ts +29 -3
  73. package/src/services/tdmq/v20200217/tdmq_models.ts +337 -148
  74. package/src/services/tem/v20210701/tem_client.ts +139 -88
  75. package/src/services/tem/v20210701/tem_models.ts +171 -16
  76. package/src/services/thpc/v20211109/thpc_client.ts +25 -10
  77. package/src/services/thpc/v20211109/thpc_models.ts +259 -141
  78. package/src/services/tiia/v20190529/tiia_client.ts +1 -6
  79. package/src/services/tiia/v20190529/tiia_models.ts +1 -1
  80. package/src/services/tiw/v20190919/tiw_models.ts +13 -2
  81. package/src/services/tke/v20180525/tke_models.ts +26 -6
  82. package/src/services/tms/v20201229/tms_models.ts +13 -1
  83. package/src/services/tsf/v20180326/tsf_client.ts +2 -0
  84. package/src/services/tsf/v20180326/tsf_models.ts +61 -1
  85. package/src/services/tts/v20190823/tts_models.ts +1 -1
  86. package/src/services/vm/v20201229/vm_models.ts +30 -0
  87. package/src/services/vod/v20180717/vod_client.ts +2 -2
  88. package/src/services/vod/v20180717/vod_models.ts +360 -360
  89. package/src/services/vpc/v20170312/vpc_models.ts +94 -2
  90. package/src/services/wav/v20210129/wav_client.ts +45 -7
  91. package/src/services/wav/v20210129/wav_models.ts +370 -134
  92. package/tencentcloud/common/sdk_version.d.ts +1 -1
  93. package/tencentcloud/common/sdk_version.js +1 -1
  94. package/tencentcloud/services/ame/v20190916/ame_models.d.ts +4 -2
  95. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +1 -1
  96. package/tencentcloud/services/ams/v20201229/ams_client.js +1 -1
  97. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +20 -0
  98. package/tencentcloud/services/antiddos/v20200309/antiddos_client.d.ts +13 -1
  99. package/tencentcloud/services/antiddos/v20200309/antiddos_client.js +18 -0
  100. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +196 -105
  101. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +4 -0
  102. package/tencentcloud/services/cam/v20190116/cam_client.d.ts +11 -3
  103. package/tencentcloud/services/cam/v20190116/cam_client.js +15 -3
  104. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +102 -16
  105. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +35 -3
  106. package/tencentcloud/services/cat/v20180409/cat_client.js +51 -3
  107. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1446 -837
  108. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +1 -1
  109. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +103 -74
  110. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +10 -14
  111. package/tencentcloud/services/cdb/v20170320/cdb_client.js +13 -19
  112. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +144 -147
  113. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +9 -0
  114. package/tencentcloud/services/chdfs/v20201112/chdfs_models.d.ts +47 -11
  115. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +15 -3
  116. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +21 -3
  117. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +261 -24
  118. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +13 -1
  119. package/tencentcloud/services/clb/v20180317/clb_client.js +13 -1
  120. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +19 -19
  121. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +21 -5
  122. package/tencentcloud/services/cls/v20201016/cls_client.js +30 -6
  123. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +228 -67
  124. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +28 -13
  125. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +76 -44
  126. package/tencentcloud/services/cvm/v20170312/cvm_client.js +95 -49
  127. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +747 -122
  128. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +5 -1
  129. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +6 -0
  130. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +30 -0
  131. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +9 -5
  132. package/tencentcloud/services/dlc/v20210125/dlc_client.js +10 -4
  133. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +277 -32
  134. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +8 -8
  135. package/tencentcloud/services/dts/v20180330/dts_models.d.ts +9 -9
  136. package/tencentcloud/services/ecdn/v20191012/ecdn_client.d.ts +1 -1
  137. package/tencentcloud/services/ecdn/v20191012/ecdn_models.d.ts +113 -70
  138. package/tencentcloud/services/es/v20180416/es_client.d.ts +5 -1
  139. package/tencentcloud/services/es/v20180416/es_client.js +6 -0
  140. package/tencentcloud/services/es/v20180416/es_models.d.ts +242 -18
  141. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +31 -5
  142. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +38 -6
  143. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +401 -121
  144. package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +2 -1
  145. package/tencentcloud/services/faceid/v20180301/faceid_client.js +2 -1
  146. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +6 -6
  147. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +1 -3
  148. package/tencentcloud/services/gme/v20180711/gme_client.js +1 -3
  149. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +7 -3
  150. package/tencentcloud/services/iecp/index.d.ts +6 -0
  151. package/tencentcloud/services/iecp/index.js +7 -0
  152. package/tencentcloud/services/iecp/v20210914/iecp_client.d.ts +334 -0
  153. package/tencentcloud/services/iecp/v20210914/iecp_client.js +517 -0
  154. package/tencentcloud/services/iecp/v20210914/iecp_models.d.ts +4845 -0
  155. package/tencentcloud/services/iecp/v20210914/iecp_models.js +18 -0
  156. package/tencentcloud/services/iecp/v20210914/index.d.ts +6 -0
  157. package/tencentcloud/services/iecp/v20210914/index.js +9 -0
  158. package/tencentcloud/services/index.d.ts +1 -0
  159. package/tencentcloud/services/index.js +2 -0
  160. package/tencentcloud/services/kms/v20190118/kms_client.d.ts +1 -1
  161. package/tencentcloud/services/kms/v20190118/kms_client.js +1 -1
  162. package/tencentcloud/services/kms/v20190118/kms_models.d.ts +57 -39
  163. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +13 -13
  164. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +13 -13
  165. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +106 -66
  166. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +5 -1
  167. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +6 -0
  168. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +26 -0
  169. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +4 -4
  170. package/tencentcloud/services/nlp/v20190408/nlp_client.js +4 -4
  171. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +3 -3
  172. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +8 -0
  173. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +7 -2
  174. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +46 -10
  175. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +1 -1
  176. package/tencentcloud/services/scf/v20180416/scf_client.d.ts +1 -1
  177. package/tencentcloud/services/scf/v20180416/scf_client.js +1 -1
  178. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +13 -13
  179. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +10 -10
  180. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +2 -2
  181. package/tencentcloud/services/taf/v20200210/taf_models.d.ts +17 -0
  182. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +27 -5
  183. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +9 -1
  184. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +12 -0
  185. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +288 -128
  186. package/tencentcloud/services/tem/v20210701/tem_client.d.ts +52 -33
  187. package/tencentcloud/services/tem/v20210701/tem_client.js +75 -48
  188. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +147 -15
  189. package/tencentcloud/services/thpc/v20211109/thpc_client.d.ts +5 -1
  190. package/tencentcloud/services/thpc/v20211109/thpc_client.js +6 -0
  191. package/tencentcloud/services/thpc/v20211109/thpc_models.d.ts +235 -135
  192. package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +0 -5
  193. package/tencentcloud/services/tiia/v20190529/tiia_client.js +0 -5
  194. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +1 -1
  195. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +12 -2
  196. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +22 -6
  197. package/tencentcloud/services/tms/v20201229/tms_models.d.ts +11 -1
  198. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +51 -1
  199. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +1 -1
  200. package/tencentcloud/services/vm/v20201229/vm_models.d.ts +25 -0
  201. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +2 -2
  202. package/tencentcloud/services/vod/v20180717/vod_client.js +2 -2
  203. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +360 -360
  204. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +78 -2
  205. package/tencentcloud/services/wav/v20210129/wav_client.d.ts +13 -1
  206. package/tencentcloud/services/wav/v20210129/wav_client.js +18 -0
  207. package/tencentcloud/services/wav/v20210129/wav_models.d.ts +314 -116
  208. package/test/antiddos.v20200309.test.js +30 -0
  209. package/test/cam.v20190116.test.js +22 -2
  210. package/test/cat.v20180409.test.js +82 -2
  211. package/test/cdb.v20170320.test.js +20 -30
  212. package/test/ckafka.v20190819.test.js +32 -2
  213. package/test/cls.v20201016.test.js +44 -4
  214. package/test/cvm.v20170312.test.js +82 -12
  215. package/test/dcdb.v20180411.test.js +10 -0
  216. package/test/dlc.v20210125.test.js +10 -0
  217. package/test/es.v20180416.test.js +10 -0
  218. package/test/essbasic.v20210526.test.js +34 -4
  219. package/test/iecp.v20210914.test.js +831 -0
  220. package/test/mariadb.v20170312.test.js +10 -0
  221. package/test/tdmq.v20200217.test.js +20 -0
  222. package/test/tem.v20210701.test.js +74 -34
  223. package/test/thpc.v20211109.test.js +10 -0
  224. package/test/wav.v20210129.test.js +30 -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,929 @@ 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;
641
+ /**
642
+ * 任务当前绑定的标签
643
+ 注意:此字段可能返回 null,表示取不到有效值。
644
+ */
645
+ TagInfoList: Array<KeyValuePair>;
694
646
  }
695
647
  /**
696
- * DescribeUserLimit返回参数结构体
648
+ * 时延等数据,数据点
697
649
  */
698
- export interface DescribeUserLimitResponse {
650
+ export interface DataPoint {
699
651
  /**
700
- * 用户可建立的最大任务数
652
+ * 数据点的时间
701
653
  */
702
- MaxTaskNum?: number;
654
+ LogTime: string;
703
655
  /**
704
- * 用户可用的最大拨测结点数
656
+ * 数据值
705
657
  */
706
- MaxAgentNum?: number;
658
+ MetricValue: number;
659
+ }
660
+ /**
661
+ * DescribeAlarmTopic返回参数结构体
662
+ */
663
+ export interface DescribeAlarmTopicResponse {
707
664
  /**
708
- * 用户可建立的最大拨测分组数
665
+ * 主题个数
709
666
  */
710
- MaxGroupNum?: number;
667
+ TotalCount?: number;
711
668
  /**
712
- * 用户可用的最小拨测间隔
669
+ * 主题列表
713
670
  */
714
- MinPeriod?: number;
671
+ Topics?: Array<AlarmTopic>;
715
672
  /**
716
673
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
717
674
  */
718
675
  RequestId?: string;
719
676
  }
720
677
  /**
721
- * GetRespTimeTrendEx请求参数结构体
678
+ * DescribeUserLimit请求参数结构体
722
679
  */
723
- export interface GetRespTimeTrendExRequest {
680
+ export declare type DescribeUserLimitRequest = null;
681
+ /**
682
+ * 保存string类型字段
683
+ */
684
+ export interface Label {
724
685
  /**
725
- * 验证成功的拨测任务id
686
+ * 自定义字段编号
726
687
  */
727
- TaskId: number;
688
+ ID: number;
728
689
  /**
729
- * 统计数据的发生日期。格式如:2017-05-09
690
+ * 自定义字段名称/说明
730
691
  */
731
- Date: string;
692
+ Name: string;
732
693
  /**
733
- * 数据的采集周期,单位分钟。取值可为 1, 5, 15, 30
694
+ * 字段值
734
695
  */
735
- Period: number;
696
+ Value: string;
697
+ }
698
+ /**
699
+ * DescribeAgents请求参数结构体
700
+ */
701
+ export declare type DescribeAgentsRequest = null;
702
+ /**
703
+ * 健值对
704
+ */
705
+ export interface KeyValuePair {
736
706
  /**
737
- * 可为 Isp, Province
707
+ *
738
708
  */
739
- Dimensions?: DimensionsDetail;
709
+ Key: string;
740
710
  /**
741
- * 可为 totalTime, parseTime, connectTime, sendTime, waitTime, receiveTime, availRatio。缺省值为 totalTime
711
+ *
742
712
  */
743
- MetricName?: string;
713
+ Value: string;
744
714
  }
745
715
  /**
746
- * DeleteTasks请求参数结构体
716
+ * 拨测失败详情
747
717
  */
748
- export interface DeleteTasksRequest {
718
+ export interface CatReturnDetail {
749
719
  /**
750
- * 拨测任务id
720
+ * 运营商名称
751
721
  */
752
- TaskIds: Array<number>;
722
+ IspName: string;
723
+ /**
724
+ * 省份全拼
725
+ */
726
+ Province: string;
727
+ /**
728
+ * 省份中文名称
729
+ */
730
+ ProvinceName: string;
731
+ /**
732
+ * Map键值
733
+ */
734
+ MapKey: string;
735
+ /**
736
+ * 拨测目标的IP
737
+ */
738
+ ServerIp: string;
739
+ /**
740
+ * 拨测失败个数
741
+ */
742
+ ResultCount: number;
743
+ /**
744
+ * 拨测失败返回码
745
+ */
746
+ ResultCode: number;
747
+ /**
748
+ * 拨测失败原因描述
749
+ */
750
+ ErrorReason: string;
753
751
  }
754
752
  /**
755
- * DescribeAlarmsByTask请求参数结构体
753
+ * 运营商可用率
756
754
  */
757
- export interface DescribeAlarmsByTaskRequest {
755
+ export interface IspDetail {
758
756
  /**
759
- * 拨测任务Id
757
+ * 运营商名称
760
758
  */
761
- TaskId: number;
759
+ IspName: string;
762
760
  /**
763
- * 从第Offset 条开始查询。缺省值为0
761
+ * 可用率
764
762
  */
765
- Offset?: number;
763
+ AvailRatio: number;
766
764
  /**
767
- * 本批次查询Limit 条记录。缺省值为20
765
+ * 平均耗时
766
+ 注意:此字段可能返回 null,表示取不到有效值。
768
767
  */
769
- Limit?: number;
768
+ AvgTime: number;
769
+ }
770
+ /**
771
+ * GetReturnCodeInfo请求参数结构体
772
+ */
773
+ export interface GetReturnCodeInfoRequest {
770
774
  /**
771
- * 0 全部, 1 已恢复, 2 未恢复 默认为0。其他值,视为0 查全部状态
775
+ * 正整数。验证成功的拨测任务id
772
776
  */
773
- Status?: number;
777
+ TaskId: number;
774
778
  /**
775
- * 格式如:2017-05-09 00:00:00 缺省为7天前0点
779
+ * 开始时间点。格式如:2017-05-09 10:20:00,最多拉群两天的数据
776
780
  */
777
- BeginTime?: string;
781
+ BeginTime: string;
778
782
  /**
779
- * 格式如:2017-05-10 00:00:00 缺省为明天0点
783
+ * 结束时间点。格式如:2017-05-09 10:25:00,最多拉群两天的数据
780
784
  */
781
- EndTime?: string;
785
+ EndTime: string;
782
786
  /**
783
- * 排序字段,可为Time, ObjName, Duration, Status, Content 之一。缺省为Time
787
+ * 省份名称的全拼
784
788
  */
785
- SortBy?: string;
789
+ Province?: string;
790
+ }
791
+ /**
792
+ * DescribeAgents返回参数结构体
793
+ */
794
+ export interface DescribeAgentsResponse {
786
795
  /**
787
- * 升序或降序。可为Desc, Asc之一。缺省为Desc
796
+ * 本用户可选的拨测点列表
788
797
  */
789
- SortType?: string;
798
+ Agents?: Array<CatAgent>;
799
+ /**
800
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
801
+ */
802
+ RequestId?: string;
803
+ }
804
+ /**
805
+ * CreateAgentGroup返回参数结构体
806
+ */
807
+ export interface CreateAgentGroupResponse {
808
+ /**
809
+ * 拨测分组Id
810
+ */
811
+ GroupId?: number;
812
+ /**
813
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
814
+ */
815
+ RequestId?: string;
816
+ }
817
+ /**
818
+ * DescribeDetailedSingleProbeData请求参数结构体
819
+ */
820
+ export interface DescribeDetailedSingleProbeDataRequest {
821
+ /**
822
+ * 开始时间戳(毫秒级)
823
+ */
824
+ BeginTime: number;
825
+ /**
826
+ * 结束时间戳(毫秒级)
827
+ */
828
+ EndTime: number;
829
+ /**
830
+ * 任务类型
831
+ */
832
+ TaskType: string;
833
+ /**
834
+ * 待排序字段
835
+ */
836
+ SortField: string;
837
+ /**
838
+ * true表示升序
839
+ */
840
+ Ascending: boolean;
841
+ /**
842
+ * 选中字段
843
+ */
844
+ SelectedFields: Array<string>;
845
+ /**
846
+ * 起始取数位置
847
+ */
848
+ Offset: number;
849
+ /**
850
+ * 取数数量
851
+ */
852
+ Limit: number;
853
+ /**
854
+ * 任务ID
855
+ */
856
+ TaskID?: Array<string>;
857
+ /**
858
+ * 拨测点运营商
859
+ */
860
+ Operators?: Array<string>;
861
+ /**
862
+ * 拨测点地区
863
+ */
864
+ Districts?: Array<string>;
865
+ /**
866
+ * 错误类型
867
+ */
868
+ ErrorTypes?: Array<string>;
869
+ }
870
+ /**
871
+ * DeleteAgentGroup返回参数结构体
872
+ */
873
+ export interface DeleteAgentGroupResponse {
874
+ /**
875
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
876
+ */
877
+ RequestId?: string;
878
+ }
879
+ /**
880
+ * 拨测分组
881
+ */
882
+ export interface AgentGroup {
883
+ /**
884
+ * 拨测分组ID
885
+ */
886
+ GroupId: number;
887
+ /**
888
+ * 拨测分组名称
889
+ */
890
+ GroupName: string;
891
+ /**
892
+ * 是否默认拨测分组。1表示是,0表示否
893
+ */
894
+ IsDefault?: number;
895
+ /**
896
+ * 使用本拨测分组的任务数
897
+ */
898
+ TaskNum?: number;
899
+ /**
900
+ * 拨测结点列表
901
+ */
902
+ GroupDetail?: Array<CatAgent>;
903
+ /**
904
+ * 最大拨测分组数
905
+ */
906
+ MaxGroupNum?: number;
907
+ }
908
+ /**
909
+ * 资源的标签,通过标签对资源进行划分用于支持细粒度的鉴权、分账等场景
910
+ */
911
+ export interface Tag {
912
+ /**
913
+ * key
914
+ */
915
+ TagKey: string;
916
+ /**
917
+ * value
918
+ */
919
+ TagValue: string;
920
+ }
921
+ /**
922
+ * GetReturnCodeHistory请求参数结构体
923
+ */
924
+ export interface GetReturnCodeHistoryRequest {
925
+ /**
926
+ * 正整数。验证成功的拨测任务id
927
+ */
928
+ TaskId: number;
929
+ /**
930
+ * 开始时间点。格式如:2017-05-09 10:20:00。注意,BeginTime 和 EndTime 需要在同一天
931
+ */
932
+ BeginTime: string;
933
+ /**
934
+ * 结束时间点。格式如:2017-05-09 10:25:00。注意,BeginTime 和 EndTime 需要在同一天
935
+ */
936
+ EndTime: string;
937
+ /**
938
+ * 省份名称的全拼
939
+ */
940
+ Province: string;
941
+ }
942
+ /**
943
+ * 省份可用率
944
+ */
945
+ export interface ProvinceDetail {
946
+ /**
947
+ * 可用率
948
+ */
949
+ AvgAvailRatio: number;
950
+ /**
951
+ * 省份名称
952
+ */
953
+ ProvinceName: string;
954
+ /**
955
+ * 省份英文名称
956
+ */
957
+ Mapkey: string;
958
+ /**
959
+ * 统计时间点
960
+ */
961
+ TimeStamp: string;
962
+ /**
963
+ * 分运营商可用率
964
+ */
965
+ IspDetail: Array<IspDetail>;
966
+ /**
967
+ * 平均耗时,单位毫秒
968
+ */
969
+ AvgTime: number;
970
+ /**
971
+ * 省份
972
+ */
973
+ Province: string;
974
+ }
975
+ /**
976
+ * GetRealAvailRatio返回参数结构体
977
+ */
978
+ export interface GetRealAvailRatioResponse {
979
+ /**
980
+ * 国内平均可用率
981
+ */
982
+ AvgAvailRatio?: number;
983
+ /**
984
+ * 各省份最低可用率
985
+ */
986
+ LowestAvailRatio?: number;
987
+ /**
988
+ * 可用率最低的省份
989
+ */
990
+ LowestProvince?: string;
991
+ /**
992
+ * 可用率最低的运营商
993
+ */
994
+ LowestIsp?: string;
995
+ /**
996
+ * 分省份的可用率数据
997
+ */
998
+ ProvinceData?: Array<ProvinceDetail>;
999
+ /**
1000
+ * 国内平均耗时,单位毫秒
1001
+ */
1002
+ AvgTime?: number;
1003
+ /**
1004
+ * 国外平均可用率
1005
+ */
1006
+ AvgAvailRatio2?: number;
1007
+ /**
1008
+ * 国外平均耗时,单位毫秒
1009
+ */
1010
+ AvgTime2?: number;
1011
+ /**
1012
+ * 国外最低可用率
1013
+ */
1014
+ LowestAvailRatio2?: number;
1015
+ /**
1016
+ * 国外可用率最低的区域
1017
+ */
1018
+ LowestProvince2?: string;
1019
+ /**
1020
+ * 国外可用率最低的运营商
1021
+ */
1022
+ LowestIsp2?: string;
1023
+ /**
1024
+ * 国外分区域的可用率数据
1025
+ */
1026
+ ProvinceData2?: Array<ProvinceDetail>;
1027
+ /**
1028
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1029
+ */
1030
+ RequestId?: string;
1031
+ }
1032
+ /**
1033
+ * UpdateProbeTaskConfigurationList返回参数结构体
1034
+ */
1035
+ export interface UpdateProbeTaskConfigurationListResponse {
1036
+ /**
1037
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1038
+ */
1039
+ RequestId?: string;
1040
+ }
1041
+ /**
1042
+ * CreateAgentGroup请求参数结构体
1043
+ */
1044
+ export interface CreateAgentGroupRequest {
1045
+ /**
1046
+ * 拨测分组名称,不超过32个字符
1047
+ */
1048
+ GroupName: string;
1049
+ /**
1050
+ * 是否为默认分组,取值可为 0 或 1。取 1 时表示设置为默认分组
1051
+ */
1052
+ IsDefault: number;
1053
+ /**
1054
+ * Province, Isp 需要成对地进行选择。参数对的取值范围。参见:DescribeAgents 的返回结果。
1055
+ */
1056
+ Agents: Array<CatAgent>;
1057
+ }
1058
+ /**
1059
+ * ResumeProbeTask返回参数结构体
1060
+ */
1061
+ export interface ResumeProbeTaskResponse {
1062
+ /**
1063
+ * 任务总量
1064
+ */
1065
+ Total: number;
1066
+ /**
1067
+ * 任务成功量
1068
+ 注意:此字段可能返回 null,表示取不到有效值。
1069
+ */
1070
+ SuccessCount: number;
1071
+ /**
1072
+ * 任务执行详情
1073
+ 注意:此字段可能返回 null,表示取不到有效值。
1074
+ */
1075
+ Results: Array<TaskResult>;
1076
+ /**
1077
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1078
+ */
1079
+ RequestId?: string;
1080
+ }
1081
+ /**
1082
+ * ModifyTaskEx返回参数结构体
1083
+ */
1084
+ export interface ModifyTaskExResponse {
1085
+ /**
1086
+ * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
1087
+ */
1088
+ TaskId?: number;
1089
+ /**
1090
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1091
+ */
1092
+ RequestId?: string;
1093
+ }
1094
+ /**
1095
+ * DescribeAlarmsByTask返回参数结构体
1096
+ */
1097
+ export interface DescribeAlarmsByTaskResponse {
1098
+ /**
1099
+ * 告警信息列表
1100
+ */
1101
+ AlarmInfos?: Array<AlarmInfo>;
1102
+ /**
1103
+ * 故障率
1104
+ */
1105
+ FaultRatio?: number;
1106
+ /**
1107
+ * 故障总时长
1108
+ */
1109
+ FaultTimeSpec?: string;
1110
+ /**
1111
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1112
+ */
1113
+ RequestId?: string;
1114
+ }
1115
+ /**
1116
+ * ModifyTaskEx请求参数结构体
1117
+ */
1118
+ export interface ModifyTaskExRequest {
1119
+ /**
1120
+ * http, https, ping, tcp, ftp, smtp, udp, dns 之一
1121
+ */
1122
+ CatTypeName: string;
1123
+ /**
1124
+ * 拨测的URL,例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1125
+ */
1126
+ Url: string;
1127
+ /**
1128
+ * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1129
+ */
1130
+ Period: number;
1131
+ /**
1132
+ * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1133
+ */
1134
+ TaskName: string;
1135
+ /**
1136
+ * 验证成功的拨测任务ID
1137
+ */
1138
+ TaskId: number;
1139
+ /**
1140
+ * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroupList 接口,本参数使用返回结果里的GroupId的值。注意,Type为0时,AgentGroupId为必填
1141
+ */
1142
+ AgentGroupId?: number;
1143
+ /**
1144
+ * 指定域名(如需要)
1145
+ */
1146
+ Host?: string;
1147
+ /**
1148
+ * 拨测目标的端口号
1149
+ */
1150
+ Port?: number;
1151
+ /**
1152
+ * 是否为Header请求(非0 发起Header 请求。为0,且PostData非空,发起POST请求。为0,PostData为空,发起GET请求)
1153
+ */
1154
+ IsHeader?: number;
1155
+ /**
1156
+ * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
1157
+ */
1158
+ SslVer?: string;
1159
+ /**
1160
+ * POST 请求数据,空字符串表示非POST请求
1161
+ */
1162
+ PostData?: string;
1163
+ /**
1164
+ * 用户Agent信息
1165
+ */
1166
+ UserAgent?: string;
1167
+ /**
1168
+ * 要在结果中进行匹配的字符串
1169
+ */
1170
+ CheckStr?: string;
1171
+ /**
1172
+ * 1 表示通过检查结果是否包含CheckStr 进行校验
1173
+ */
1174
+ CheckType?: number;
1175
+ /**
1176
+ * 需要设置的Cookie信息
1177
+ */
1178
+ Cookie?: string;
1179
+ /**
1180
+ * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1181
+ */
1182
+ UserName?: string;
1183
+ /**
1184
+ * 登录服务器的密码
1185
+ */
1186
+ PassWord?: string;
1187
+ /**
1188
+ * 缺省为0,0 表示请求为字符串类型, 1表示为二进制类型
1189
+ */
1190
+ ReqDataType?: number;
1191
+ /**
1192
+ * 发起TCP, UDP请求的协议请求数据
1193
+ */
1194
+ ReqData?: string;
1195
+ /**
1196
+ * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1197
+ */
1198
+ RespDataType?: string;
1199
+ /**
1200
+ * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1201
+ */
1202
+ RespData?: string;
1203
+ /**
1204
+ * 目的DNS服务器,可以为空字符串
1205
+ */
1206
+ DnsSvr?: string;
1207
+ /**
1208
+ * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1209
+ */
1210
+ DnsCheckIp?: string;
1211
+ /**
1212
+ * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1213
+ */
1214
+ DnsQueryType?: string;
1215
+ /**
1216
+ * 是否使用安全链接SSL, 0 不使用,1 使用
1217
+ */
1218
+ UseSecConn?: number;
1219
+ /**
1220
+ * FTP登录验证方式, 0 不验证 1 匿名登录 2 需要身份验证
1221
+ */
1222
+ NeedAuth?: number;
1223
+ /**
1224
+ * Type=0 默认 (站点监控) Type=2 可用率监控
1225
+ */
1226
+ Type?: number;
1227
+ /**
1228
+ * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1229
+ */
1230
+ RedirectFollowNum?: number;
1231
+ }
1232
+ /**
1233
+ * ResumeProbeTask请求参数结构体
1234
+ */
1235
+ export interface ResumeProbeTaskRequest {
1236
+ /**
1237
+ * 任务 ID
1238
+ */
1239
+ TaskIds: Array<string>;
1240
+ }
1241
+ /**
1242
+ * DescribeTasksByType请求参数结构体
1243
+ */
1244
+ export interface DescribeTasksByTypeRequest {
1245
+ /**
1246
+ * 从第Offset 条开始查询。缺省值为0
1247
+ */
1248
+ Offset?: number;
1249
+ /**
1250
+ * 本批次查询Limit 条记录。缺省值为20
1251
+ */
1252
+ Limit?: number;
1253
+ /**
1254
+ * 拨测任务类型。0 站点监控,2 可用性监控。缺省值为2
1255
+ */
1256
+ Type?: number;
1257
+ }
1258
+ /**
1259
+ * 探测节点
1260
+ */
1261
+ export interface NodeDefine {
1262
+ /**
1263
+ * 节点名称
1264
+ */
1265
+ Name: string;
1266
+ /**
1267
+ * 节点代码
1268
+ */
1269
+ Code: string;
1270
+ /**
1271
+ * 节点类型
1272
+ <li> 1 = IDC </li>
1273
+ <li> 2 = LastMile </li>
1274
+ <li> 3 = Mobile </li>
1275
+ */
1276
+ Type: number;
1277
+ /**
1278
+ * 网络服务商
1279
+ */
1280
+ NetService: string;
1281
+ /**
1282
+ * 区域
1283
+ */
1284
+ District: string;
1285
+ /**
1286
+ * 城市
1287
+ */
1288
+ City: string;
1289
+ /**
1290
+ * IP 类型
1291
+ <li> 1 = IPv4 </li>
1292
+ <li> 2 = IPv6 </li>
1293
+ 注意:此字段可能返回 null,表示取不到有效值。
1294
+ */
1295
+ IPType: number;
1296
+ /**
1297
+ * 区域
1298
+ <li> 1 = 中国大陆 </li>
1299
+ <li> 2 = 港澳台 </li>
1300
+ <li> 3 = 国外 </li>
1301
+ 注意:此字段可能返回 null,表示取不到有效值。
1302
+ */
1303
+ Location: number;
1304
+ }
1305
+ /**
1306
+ * GetReturnCodeHistory返回参数结构体
1307
+ */
1308
+ export interface GetReturnCodeHistoryResponse {
1309
+ /**
1310
+ * 拨测失败详情列表
1311
+ */
1312
+ Details?: Array<CatReturnDetail>;
1313
+ /**
1314
+ * 拨测失败汇总列表
1315
+ */
1316
+ Summary?: Array<CatReturnSummary>;
1317
+ /**
1318
+ * 开始时间
1319
+ */
1320
+ BeginTime?: string;
1321
+ /**
1322
+ * 截至时间
1323
+ */
1324
+ EndTime?: string;
1325
+ /**
1326
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1327
+ */
1328
+ RequestId?: string;
1329
+ }
1330
+ /**
1331
+ * GetAvailRatioHistory请求参数结构体
1332
+ */
1333
+ export interface GetAvailRatioHistoryRequest {
1334
+ /**
1335
+ * 拨测任务Id
1336
+ */
1337
+ TaskId: number;
790
1338
  /**
791
- * 告警对象的名称
1339
+ * 具体时间点
792
1340
  */
793
- ObjName?: string;
1341
+ TimeStamp: string;
794
1342
  }
795
1343
  /**
796
- * PauseTask返回参数结构体
1344
+ * GetTaskTotalNumber返回参数结构体
797
1345
  */
798
- export interface PauseTaskResponse {
1346
+ export interface GetTaskTotalNumberResponse {
1347
+ /**
1348
+ * 拨测任务总数
1349
+ */
1350
+ TotalCount?: number;
799
1351
  /**
800
1352
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
801
1353
  */
802
1354
  RequestId?: string;
803
1355
  }
804
1356
  /**
805
- * CreateAgentGroup请求参数结构体
1357
+ * 拨测点维度信息
806
1358
  */
807
- export interface CreateAgentGroupRequest {
808
- /**
809
- * 拨测分组名称,不超过32个字符
810
- */
811
- GroupName: string;
1359
+ export interface DimensionsDetail {
812
1360
  /**
813
- * 是否为默认分组,取值可为 0 或 1。取 1 时表示设置为默认分组
1361
+ * 运营商列表
814
1362
  */
815
- IsDefault: number;
1363
+ Isp?: Array<string>;
816
1364
  /**
817
- * Province, Isp 需要成对地进行选择。参数对的取值范围。参见:DescribeAgents 的返回结果。
1365
+ * 省份列表
818
1366
  */
819
- Agents: Array<CatAgent>;
1367
+ Province?: Array<string>;
820
1368
  }
821
1369
  /**
822
- * 拨测记录
1370
+ * GetDailyAvailRatio请求参数结构体
823
1371
  */
824
- export interface CatLog {
825
- /**
826
- * 拨测时间点
827
- */
828
- Time: string;
1372
+ export interface GetDailyAvailRatioRequest {
829
1373
  /**
830
- * 拨测类型
1374
+ * 拨测任务Id
831
1375
  */
832
- CatTypeName: string;
1376
+ TaskId: number;
1377
+ }
1378
+ /**
1379
+ * 拨测失败返回情况汇总
1380
+ */
1381
+ export interface CatReturnSummary {
833
1382
  /**
834
- * 任务ID
1383
+ * 拨测失败个数
835
1384
  */
836
- TaskId: number;
1385
+ ResultCount: number;
837
1386
  /**
838
- * 拨测点所在城市
1387
+ * 拨测失败返回码
839
1388
  */
840
- City: string;
1389
+ ResultCode: number;
841
1390
  /**
842
- * 拨测点所在运营商
1391
+ * 拨测失败原因描述
843
1392
  */
844
- Isp: string;
1393
+ ErrorReason: string;
1394
+ }
1395
+ /**
1396
+ * 任务执行结果
1397
+ */
1398
+ export interface TaskResult {
845
1399
  /**
846
- * 被拨测Server的IP
1400
+ * 任务 ID
847
1401
  */
848
- ServerIp: string;
1402
+ TaskId: string;
849
1403
  /**
850
- * 被拨测Server的域名
1404
+ * 是否成功
1405
+ 注意:此字段可能返回 null,表示取不到有效值。
851
1406
  */
852
- DomainName: string;
1407
+ Success: boolean;
853
1408
  /**
854
- * 执行耗时,单位毫秒
1409
+ * 错误信息
1410
+ 注意:此字段可能返回 null,表示取不到有效值。
855
1411
  */
856
- TotalTime: number;
1412
+ ErrorMessage: string;
1413
+ }
1414
+ /**
1415
+ * SuspendProbeTask返回参数结构体
1416
+ */
1417
+ export interface SuspendProbeTaskResponse {
857
1418
  /**
858
- * 成功失败(1 失败,0 成功)
1419
+ * 任务总量
859
1420
  */
860
- ResultType: number;
1421
+ Total: number;
861
1422
  /**
862
- * 失败错误码
1423
+ * 任务成功量
1424
+ 注意:此字段可能返回 null,表示取不到有效值。
863
1425
  */
864
- ResultCode: number;
1426
+ SuccessCount: number;
865
1427
  /**
866
- * 请求包大小
1428
+ * 任务执行结果
1429
+ 注意:此字段可能返回 null,表示取不到有效值。
867
1430
  */
868
- ReqPkgSize: number;
1431
+ Results: Array<TaskResult>;
869
1432
  /**
870
- * 回应包大小
1433
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
871
1434
  */
872
- RspPkgSize: number;
1435
+ RequestId?: string;
1436
+ }
1437
+ /**
1438
+ * GetRespTimeTrendEx返回参数结构体
1439
+ */
1440
+ export interface GetRespTimeTrendExResponse {
873
1441
  /**
874
- * 拨测请求
1442
+ * 数据点集合,时延等走势数据
875
1443
  */
876
- ReqMsg: string;
1444
+ DataPoints?: Array<DataPointMetric>;
877
1445
  /**
878
- * 拨测回应
1446
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
879
1447
  */
880
- RespMsg: string;
1448
+ RequestId?: string;
1449
+ }
1450
+ /**
1451
+ * 包含MetricName的DataPoint数据
1452
+ */
1453
+ export interface DataPointMetric {
881
1454
  /**
882
- * 客户端IP
1455
+ * 数据项
883
1456
  */
884
- ClientIp: string;
1457
+ MetricName: string;
885
1458
  /**
886
- * 拨测点所在城市名称
1459
+ * 数据点的时间和值
887
1460
  */
888
- CityName: string;
1461
+ Points: Array<DataPoint>;
1462
+ }
1463
+ /**
1464
+ * DescribeCatLogs请求参数结构体
1465
+ */
1466
+ export interface DescribeCatLogsRequest {
889
1467
  /**
890
- * 拨测点所在运营商名称
1468
+ * 拨测任务Id
891
1469
  */
892
- IspName: string;
1470
+ TaskId: number;
893
1471
  /**
894
- * 解析耗时,单位毫秒
1472
+ * 从第Offset 条开始查询。缺省值为0
895
1473
  */
896
- ParseTime: number;
1474
+ Offset?: number;
897
1475
  /**
898
- * 连接耗时,单位毫秒
1476
+ * 本批次查询Limit 条记录。缺省值为20
899
1477
  */
900
- ConnectTime: number;
1478
+ Limit?: number;
901
1479
  /**
902
- * 数据发送耗时,单位毫秒
1480
+ * 格式如:2017-05-09 00:00:00 缺省为当天0点,最多拉取1天的数据
903
1481
  */
904
- SendTime: number;
1482
+ BeginTime?: string;
905
1483
  /**
906
- * 等待耗时,单位毫秒
1484
+ * 格式如:2017-05-10 00:00:00 缺省为当前时间
907
1485
  */
908
- WaitTime: number;
1486
+ EndTime?: string;
909
1487
  /**
910
- * 接收耗时,单位毫秒
1488
+ * 按时间升序或降序。默认降序。可选值: Desc, Asc
911
1489
  */
912
- ReceiveTime: number;
1490
+ SortType?: string;
913
1491
  }
914
1492
  /**
915
- * GetDailyAvailRatio返回参数结构体
1493
+ * GetAvailRatioHistory返回参数结构体
916
1494
  */
917
- export interface GetDailyAvailRatioResponse {
1495
+ export interface GetAvailRatioHistoryResponse {
918
1496
  /**
919
1497
  * 整体平均可用率
920
1498
  */
@@ -927,6 +1505,10 @@ export interface GetDailyAvailRatioResponse {
927
1505
  * 可用率最低的省份
928
1506
  */
929
1507
  LowestProvince?: string;
1508
+ /**
1509
+ * 可用率最低的运营商
1510
+ */
1511
+ LowestIsp?: string;
930
1512
  /**
931
1513
  * 分省份的可用率数据
932
1514
  */
@@ -951,6 +1533,10 @@ export interface GetDailyAvailRatioResponse {
951
1533
  * 国外可用率最低的区域
952
1534
  */
953
1535
  LowestProvince2?: string;
1536
+ /**
1537
+ * 国外可用率最低的运营商
1538
+ */
1539
+ LowestIsp2?: string;
954
1540
  /**
955
1541
  * 国外分区域的可用率数据
956
1542
  */
@@ -961,303 +1547,278 @@ export interface GetDailyAvailRatioResponse {
961
1547
  RequestId?: string;
962
1548
  }
963
1549
  /**
964
- * DeleteAgentGroup请求参数结构体
1550
+ * DescribeProbeTasks返回参数结构体
965
1551
  */
966
- export interface DeleteAgentGroupRequest {
1552
+ export interface DescribeProbeTasksResponse {
967
1553
  /**
968
- * 拨测分组id
1554
+ * 任务列表
1555
+ 注意:此字段可能返回 null,表示取不到有效值。
969
1556
  */
970
- GroupId: number;
971
- }
972
- /**
973
- * GetAvailRatioHistory请求参数结构体
974
- */
975
- export interface GetAvailRatioHistoryRequest {
1557
+ TaskSet: Array<ProbeTask>;
976
1558
  /**
977
- * 拨测任务Id
1559
+ * 任务总数
978
1560
  */
979
- TaskId: number;
1561
+ Total: number;
980
1562
  /**
981
- * 具体时间点
1563
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
982
1564
  */
983
- TimeStamp: string;
1565
+ RequestId?: string;
984
1566
  }
985
1567
  /**
986
- * DescribeAgentGroups请求参数结构体
987
- */
988
- export declare type DescribeAgentGroupsRequest = null;
989
- /**
990
- * DescribeAlarmsByTask返回参数结构体
1568
+ * DescribeAlarms返回参数结构体
991
1569
  */
992
- export interface DescribeAlarmsByTaskResponse {
993
- /**
994
- * 告警信息列表
995
- */
996
- AlarmInfos?: Array<AlarmInfo>;
1570
+ export interface DescribeAlarmsResponse {
997
1571
  /**
998
- * 故障率
1572
+ * 告警总条数
999
1573
  */
1000
- FaultRatio?: number;
1574
+ TotalCount?: number;
1001
1575
  /**
1002
- * 故障总时长
1576
+ * 本批告警信息列表
1003
1577
  */
1004
- FaultTimeSpec?: string;
1578
+ AlarmInfos?: Array<AlarmInfo>;
1005
1579
  /**
1006
1580
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1007
1581
  */
1008
1582
  RequestId?: string;
1009
1583
  }
1010
1584
  /**
1011
- * ModifyTaskEx请求参数结构体
1585
+ * DescribeTasksByType返回参数结构体
1012
1586
  */
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;
1587
+ export interface DescribeTasksByTypeResponse {
1054
1588
  /**
1055
- * POST 请求数据,空字符串表示非POST请求
1589
+ * 符合条件的总任务数
1056
1590
  */
1057
- PostData?: string;
1591
+ TotalCount?: number;
1058
1592
  /**
1059
- * 用户Agent信息
1593
+ * 任务列表
1060
1594
  */
1061
- UserAgent?: string;
1595
+ Tasks?: Array<TaskAlarm>;
1062
1596
  /**
1063
- * 要在结果中进行匹配的字符串
1597
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1064
1598
  */
1065
- CheckStr?: string;
1599
+ RequestId?: string;
1600
+ }
1601
+ /**
1602
+ * DescribeAlarmTopic请求参数结构体
1603
+ */
1604
+ export interface DescribeAlarmTopicRequest {
1066
1605
  /**
1067
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1606
+ * 如果不存在拨测相关的主题,是否自动创建一个。取值可为0, 1,默认为0
1068
1607
  */
1069
- CheckType?: number;
1608
+ NeedAdd?: number;
1609
+ }
1610
+ /**
1611
+ * DescribeAgentGroups返回参数结构体
1612
+ */
1613
+ export interface DescribeAgentGroupsResponse {
1070
1614
  /**
1071
- * 需要设置的Cookie信息
1615
+ * 用户所属的系统默认拨测分组
1072
1616
  */
1073
- Cookie?: string;
1617
+ SysDefaultGroup?: AgentGroup;
1074
1618
  /**
1075
- * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1619
+ * 用户创建的拨测分组列表
1076
1620
  */
1077
- UserName?: string;
1621
+ CustomGroups?: Array<AgentGroup>;
1078
1622
  /**
1079
- * 登录服务器的密码
1623
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1080
1624
  */
1081
- PassWord?: string;
1625
+ RequestId?: string;
1626
+ }
1627
+ /**
1628
+ * SuspendProbeTask请求参数结构体
1629
+ */
1630
+ export interface SuspendProbeTaskRequest {
1082
1631
  /**
1083
- * 缺省为0,0 表示请求为字符串类型, 1表示为二进制类型
1632
+ * 任务 ID
1084
1633
  */
1085
- ReqDataType?: number;
1634
+ TaskIds: Array<string>;
1635
+ }
1636
+ /**
1637
+ * GetRespTimeTrendEx请求参数结构体
1638
+ */
1639
+ export interface GetRespTimeTrendExRequest {
1086
1640
  /**
1087
- * 发起TCP, UDP请求的协议请求数据
1641
+ * 验证成功的拨测任务id
1088
1642
  */
1089
- ReqData?: string;
1643
+ TaskId: number;
1090
1644
  /**
1091
- * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1645
+ * 统计数据的发生日期。格式如:2017-05-09
1092
1646
  */
1093
- RespDataType?: string;
1647
+ Date: string;
1094
1648
  /**
1095
- * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1649
+ * 数据的采集周期,单位分钟。取值可为 1, 5, 15, 30
1096
1650
  */
1097
- RespData?: string;
1651
+ Period: number;
1098
1652
  /**
1099
- * 目的DNS服务器,可以为空字符串
1653
+ * 可为 Isp, Province
1100
1654
  */
1101
- DnsSvr?: string;
1655
+ Dimensions?: DimensionsDetail;
1102
1656
  /**
1103
- * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1657
+ * 可为 totalTime, parseTime, connectTime, sendTime, waitTime, receiveTime, availRatio。缺省值为 totalTime
1104
1658
  */
1105
- DnsCheckIp?: string;
1659
+ MetricName?: string;
1660
+ }
1661
+ /**
1662
+ * UpdateProbeTaskConfigurationList请求参数结构体
1663
+ */
1664
+ export interface UpdateProbeTaskConfigurationListRequest {
1106
1665
  /**
1107
- * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1666
+ * 任务 ID
1108
1667
  */
1109
- DnsQueryType?: string;
1668
+ TaskIds: Array<string>;
1110
1669
  /**
1111
- * 是否使用安全链接SSL, 0 不使用,1 使用
1670
+ * 拨测节点
1112
1671
  */
1113
- UseSecConn?: number;
1672
+ Nodes: Array<string>;
1114
1673
  /**
1115
- * FTP登录验证方式, 0 不验证 1 匿名登录 2 需要身份验证
1674
+ * 拨测间隔
1116
1675
  */
1117
- NeedAuth?: number;
1676
+ Interval: number;
1118
1677
  /**
1119
- * Type=0 默认 (站点监控) Type=2 可用率监控
1678
+ * 拨测参数
1120
1679
  */
1121
- Type?: number;
1680
+ Parameters: string;
1122
1681
  /**
1123
- * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1682
+ * 定时任务cron表达式
1124
1683
  */
1125
- RedirectFollowNum?: number;
1684
+ Cron?: string;
1126
1685
  }
1127
1686
  /**
1128
- * DescribeAlarmTopic请求参数结构体
1687
+ * CreateProbeTasks请求参数结构体
1129
1688
  */
1130
- export interface DescribeAlarmTopicRequest {
1689
+ export interface CreateProbeTasksRequest {
1131
1690
  /**
1132
- * 如果不存在拨测相关的主题,是否自动创建一个。取值可为0, 1,默认为0
1691
+ * 批量任务名-地址
1133
1692
  */
1134
- NeedAdd?: number;
1135
- }
1136
- /**
1137
- * CreateTaskEx请求参数结构体
1138
- */
1139
- export interface CreateTaskExRequest {
1693
+ BatchTasks: Array<ProbeTaskBasicConfiguration>;
1140
1694
  /**
1141
- * http, https, ping, tcp, ftp, smtp, udp, dns 之一
1695
+ * 任务类型
1142
1696
  */
1143
- CatTypeName: string;
1697
+ TaskType: number;
1144
1698
  /**
1145
- * 拨测的URL, 例如:www.qq.com (URL域名解析需要能解析出具体的IP)
1699
+ * 拨测节点
1146
1700
  */
1147
- Url: string;
1701
+ Nodes: Array<string>;
1148
1702
  /**
1149
- * 拨测周期。取值可为1,5,15,30之一, 单位:分钟。精度不能低于用户等级规定的最小精度
1703
+ * 拨测间隔
1150
1704
  */
1151
- Period: number;
1705
+ Interval: number;
1152
1706
  /**
1153
- * 拨测任务名称不能超过32个字符。同一个用户创建的任务名不可重复
1707
+ * 拨测参数
1154
1708
  */
1155
- TaskName: string;
1709
+ Parameters: string;
1156
1710
  /**
1157
- * 拨测分组ID,体现本拨测任务要采用哪些运营商作为拨测源。一般可直接填写本用户的默认拨测分组。参见:DescribeAgentGroups 接口,本参数使用返回结果里的GroupId的值。注意: Type为0时,AgentGroupId为必填
1711
+ * 任务分类
1712
+ <li>1 = PC</li>
1713
+ <li> 2 = Mobile </li>
1158
1714
  */
1159
- AgentGroupId?: number;
1715
+ TaskCategory: number;
1160
1716
  /**
1161
- * 指定域名(如需要)
1717
+ * 定时任务cron表达式
1162
1718
  */
1163
- Host?: string;
1719
+ Cron?: string;
1164
1720
  /**
1165
- * 是否为Header请求(非0 发起Header 请求。为0,且PostData 非空,发起POST请求。为0,PostData 为空,发起GET请求)
1721
+ * 资源标签值
1166
1722
  */
1167
- IsHeader?: number;
1723
+ Tag?: Array<Tag>;
1724
+ }
1725
+ /**
1726
+ * 拨测记录
1727
+ */
1728
+ export interface CatLog {
1168
1729
  /**
1169
- * URL中含有"https"时有用。缺省为SSLv23。需要为 TLSv1_2, TLSv1_1, TLSv1, SSLv2, SSLv23, SSLv3 之一
1730
+ * 拨测时间点
1170
1731
  */
1171
- SslVer?: string;
1732
+ Time: string;
1172
1733
  /**
1173
- * POST请求数据。空字符串表示非POST请求
1734
+ * 拨测类型
1174
1735
  */
1175
- PostData?: string;
1736
+ CatTypeName: string;
1176
1737
  /**
1177
- * 用户Agent信息
1738
+ * 任务ID
1178
1739
  */
1179
- UserAgent?: string;
1740
+ TaskId: number;
1180
1741
  /**
1181
- * 要在结果中进行匹配的字符串
1742
+ * 拨测点所在城市
1182
1743
  */
1183
- CheckStr?: string;
1744
+ City: string;
1184
1745
  /**
1185
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1746
+ * 拨测点所在运营商
1186
1747
  */
1187
- CheckType?: number;
1748
+ Isp: string;
1188
1749
  /**
1189
- * 需要设置的Cookie信息
1750
+ * 被拨测Server的IP
1190
1751
  */
1191
- Cookie?: string;
1752
+ ServerIp: string;
1192
1753
  /**
1193
- * 任务ID,用于验证且修改任务时传入原任务ID
1754
+ * 被拨测Server的域名
1194
1755
  */
1195
- TaskId?: number;
1756
+ DomainName: string;
1196
1757
  /**
1197
- * 登录服务器的账号。如果为空字符串,表示不用校验用户密码。只做简单连接服务器的拨测
1758
+ * 执行耗时,单位毫秒
1198
1759
  */
1199
- UserName?: string;
1760
+ TotalTime: number;
1200
1761
  /**
1201
- * 登录服务器的密码
1762
+ * 成功失败(1 失败,0 成功)
1202
1763
  */
1203
- PassWord?: string;
1764
+ ResultType: number;
1204
1765
  /**
1205
- * 缺省为0。0 表示请求为字符串类型。1表示为二进制类型
1766
+ * 失败错误码
1206
1767
  */
1207
- ReqDataType?: number;
1768
+ ResultCode: number;
1208
1769
  /**
1209
- * 发起TCP, UDP请求的协议请求数据
1770
+ * 请求包大小
1210
1771
  */
1211
- ReqData?: string;
1772
+ ReqPkgSize: number;
1212
1773
  /**
1213
- * 缺省为0。0 表示响应为字符串类型。1表示为二进制类型
1774
+ * 回应包大小
1214
1775
  */
1215
- RespDataType?: number;
1776
+ RspPkgSize: number;
1216
1777
  /**
1217
- * 预期的UDP请求的回应数据。字符串型,只需要返回的结果里包含本字符串算校验通过。二进制型,则需要严格等于才算通过
1778
+ * 拨测请求
1218
1779
  */
1219
- RespData?: string;
1780
+ ReqMsg: string;
1220
1781
  /**
1221
- * 目的DNS服务器 可以为空字符串
1782
+ * 拨测回应
1222
1783
  */
1223
- DnsSvr?: string;
1784
+ RespMsg: string;
1224
1785
  /**
1225
- * 需要检验是否在DNS IP列表的IP。可以为空字符串,表示不校验
1786
+ * 客户端IP
1226
1787
  */
1227
- DnsCheckIp?: string;
1788
+ ClientIp: string;
1228
1789
  /**
1229
- * 需要为下列值之一。缺省为A。A, MX, NS, CNAME, TXT, ANY
1790
+ * 拨测点所在城市名称
1230
1791
  */
1231
- DnsQueryType?: string;
1792
+ CityName: string;
1232
1793
  /**
1233
- * 是否使用安全链接SSL, 0 不使用,1 使用
1794
+ * 拨测点所在运营商名称
1234
1795
  */
1235
- UseSecConn?: number;
1796
+ IspName: string;
1236
1797
  /**
1237
- * FTP登录验证方式, 0 不验证 , 1 匿名登录, 2 需要身份验证
1798
+ * 解析耗时,单位毫秒
1238
1799
  */
1239
- NeedAuth?: number;
1800
+ ParseTime: number;
1240
1801
  /**
1241
- * 拨测目标的端口号
1802
+ * 连接耗时,单位毫秒
1242
1803
  */
1243
- Port?: number;
1804
+ ConnectTime: number;
1244
1805
  /**
1245
- * Type=0 默认 (站点监控)Type=2 可用率监控
1806
+ * 数据发送耗时,单位毫秒
1246
1807
  */
1247
- Type?: number;
1808
+ SendTime: number;
1248
1809
  /**
1249
- * IsVerify=0 非验证任务 IsVerify=1 验证任务,不传则默认为0
1810
+ * 等待耗时,单位毫秒
1250
1811
  */
1251
- IsVerify?: number;
1812
+ WaitTime: number;
1252
1813
  /**
1253
- * 跟随跳转次数,取值范围0-5,不传则表示不跟随
1814
+ * 接收耗时,单位毫秒
1254
1815
  */
1255
- RedirectFollowNum?: number;
1816
+ ReceiveTime: number;
1256
1817
  }
1257
1818
  /**
1258
- * GetTaskTotalNumber请求参数结构体
1819
+ * DescribeAgentGroups请求参数结构体
1259
1820
  */
1260
- export declare type GetTaskTotalNumberRequest = null;
1821
+ export declare type DescribeAgentGroupsRequest = null;
1261
1822
  /**
1262
1823
  * 可用性监控任务状态及告警信息
1263
1824
  */
@@ -1304,246 +1865,279 @@ export interface TaskAlarm {
1304
1865
  UpdateTime: string;
1305
1866
  }
1306
1867
  /**
1307
- * DescribeTasksByType请求参数结构体
1868
+ * DescribeCatLogs返回参数结构体
1308
1869
  */
1309
- export interface DescribeTasksByTypeRequest {
1310
- /**
1311
- * 从第Offset 条开始查询。缺省值为0
1312
- */
1313
- Offset?: number;
1870
+ export interface DescribeCatLogsResponse {
1314
1871
  /**
1315
- * 本批次查询Limit 条记录。缺省值为20
1872
+ * 符合条件的总记录数
1316
1873
  */
1317
- Limit?: number;
1874
+ TotalCount?: number;
1318
1875
  /**
1319
- * 拨测任务类型。0 站点监控,2 可用性监控。缺省值为2
1876
+ * 拨测记录列表
1320
1877
  */
1321
- Type?: number;
1322
- }
1323
- /**
1324
- * VerifyResult请求参数结构体
1325
- */
1326
- export interface VerifyResultRequest {
1878
+ CatLogs?: Array<CatLog>;
1327
1879
  /**
1328
- * 要查询的拨测任务的结果id
1880
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1329
1881
  */
1330
- ResultId: number;
1882
+ RequestId?: string;
1331
1883
  }
1332
1884
  /**
1333
- * VerifyResult返回参数结构体
1885
+ * 单条详细拨测数据
1334
1886
  */
1335
- export interface VerifyResultResponse {
1887
+ export interface DetailedSingleDataDefine {
1336
1888
  /**
1337
- * 错误的原因
1889
+ * 拨测时间戳
1338
1890
  */
1339
- ErrorReason?: string;
1891
+ ProbeTime: number;
1340
1892
  /**
1341
- * 错误号
1893
+ * 储存所有string类型字段
1342
1894
  */
1343
- ResultCode?: number;
1895
+ Labels: Array<Label>;
1344
1896
  /**
1345
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1897
+ * 储存所有float类型字段
1346
1898
  */
1347
- RequestId?: string;
1899
+ Fields: Array<Field>;
1348
1900
  }
1349
1901
  /**
1350
- * 任务信息和告警策略组
1902
+ * GetReturnCodeInfo返回参数结构体
1351
1903
  */
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;
1904
+ export interface GetReturnCodeInfoResponse {
1365
1905
  /**
1366
- * 拨测类型。http, https, ping, tcp 之一
1906
+ * 拨测失败详情列表
1367
1907
  */
1368
- CatTypeName: string;
1908
+ Details?: Array<CatReturnDetail>;
1369
1909
  /**
1370
- * 拨测任务的URL
1910
+ * 拨测失败汇总列表
1371
1911
  */
1372
- CgiUrl: string;
1912
+ Summary?: Array<CatReturnSummary>;
1373
1913
  /**
1374
- * 拨测分组ID
1914
+ * 开始时间
1375
1915
  */
1376
- AgentGroupId: number;
1916
+ BeginTime?: string;
1377
1917
  /**
1378
- * 告警策略组ID
1918
+ * 截至时间
1379
1919
  */
1380
- PolicyGroupId: number;
1920
+ EndTime?: string;
1381
1921
  /**
1382
- * 任务状态。1表示暂停,2表示运行中,0为初始态
1922
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1383
1923
  */
1384
- Status?: number;
1924
+ RequestId?: string;
1925
+ }
1926
+ /**
1927
+ * BindAlarmPolicy返回参数结构体
1928
+ */
1929
+ export interface BindAlarmPolicyResponse {
1385
1930
  /**
1386
- * 任务创建时间
1931
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1387
1932
  */
1388
- AddTime?: string;
1933
+ RequestId?: string;
1934
+ }
1935
+ /**
1936
+ * RunTask返回参数结构体
1937
+ */
1938
+ export interface RunTaskResponse {
1389
1939
  /**
1390
- * 任务类型。0 站点监控,2 可用性监控
1940
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1391
1941
  */
1392
- Type?: number;
1942
+ RequestId?: string;
1943
+ }
1944
+ /**
1945
+ * 储存float类型字段
1946
+ */
1947
+ export interface Field {
1393
1948
  /**
1394
- * 绑定的统一告警主题ID
1949
+ * 自定义字段编号
1395
1950
  */
1396
- TopicId?: string;
1951
+ ID: number;
1397
1952
  /**
1398
- * 告警状态。0 未启用,1, 启用
1953
+ * 自定义字段名称/说明
1399
1954
  */
1400
- AlarmStatus?: number;
1955
+ Name: string;
1401
1956
  /**
1402
- * 指定的域名
1957
+ * 字段值
1403
1958
  */
1404
- Host?: string;
1959
+ Value: number;
1960
+ }
1961
+ /**
1962
+ * type ProbeTaskBasicConfiguration struct {
1963
+ TaskID TaskID `json:"TaskId" gorm:"column:task_id"`
1964
+ Name string `json:"Name" binding:"required" gorm:"column:name"`
1965
+ TargetAddress string `json:"TargetAddress" binding:"required" gorm:"column:target_address"`
1966
+ }
1967
+ */
1968
+ export interface ProbeTaskBasicConfiguration {
1405
1969
  /**
1406
- * 拨测目标的端口号
1970
+ * 拨测任务名称
1407
1971
  */
1408
- Port?: number;
1972
+ Name: string;
1409
1973
  /**
1410
- * 要在结果中进行匹配的字符串
1974
+ * 拨测目标地址
1411
1975
  */
1412
- CheckStr?: string;
1976
+ TargetAddress: string;
1977
+ }
1978
+ /**
1979
+ * VerifyResult请求参数结构体
1980
+ */
1981
+ export interface VerifyResultRequest {
1413
1982
  /**
1414
- * 1 表示通过检查结果是否包含CheckStr 进行校验
1983
+ * 要查询的拨测任务的结果id
1415
1984
  */
1416
- CheckType?: number;
1985
+ ResultId: number;
1986
+ }
1987
+ /**
1988
+ * GetTaskTotalNumber请求参数结构体
1989
+ */
1990
+ export declare type GetTaskTotalNumberRequest = null;
1991
+ /**
1992
+ * ModifyAgentGroup返回参数结构体
1993
+ */
1994
+ export interface ModifyAgentGroupResponse {
1417
1995
  /**
1418
- * 用户Agent信息
1996
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1419
1997
  */
1420
- UserAgent?: string;
1998
+ RequestId?: string;
1999
+ }
2000
+ /**
2001
+ * DescribeTaskDetail请求参数结构体
2002
+ */
2003
+ export interface DescribeTaskDetailRequest {
1421
2004
  /**
1422
- * 设置的Cookie信息
2005
+ * 拨测任务id 数组
1423
2006
  */
1424
- Cookie?: string;
2007
+ TaskIds: Array<number>;
2008
+ }
2009
+ /**
2010
+ * GetResultSummary返回参数结构体
2011
+ */
2012
+ export interface GetResultSummaryResponse {
1425
2013
  /**
1426
- * POST 请求数据。空字符串表示非POST请求
2014
+ * 实时统计数据
1427
2015
  */
1428
- PostData?: string;
2016
+ RealData?: Array<ResultSummary>;
1429
2017
  /**
1430
- * SSL协议版本
2018
+ * 按天的统计数据
1431
2019
  */
1432
- SslVer?: string;
2020
+ DayData?: Array<ResultSummary>;
1433
2021
  /**
1434
- * 是否为Header请求。非0 Header 请求
2022
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1435
2023
  */
1436
- IsHeader?: number;
2024
+ RequestId?: string;
2025
+ }
2026
+ /**
2027
+ * VerifyResult返回参数结构体
2028
+ */
2029
+ export interface VerifyResultResponse {
1437
2030
  /**
1438
- * 目的DNS服务器
2031
+ * 错误的原因
1439
2032
  */
1440
- DnsSvr?: string;
2033
+ ErrorReason?: string;
1441
2034
  /**
1442
- * 需要检验是否在DNS IP列表的IP
2035
+ * 错误号
1443
2036
  */
1444
- DnsCheckIp?: string;
2037
+ ResultCode?: number;
1445
2038
  /**
1446
- * DNS查询类型
2039
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1447
2040
  */
1448
- DnsQueryType?: string;
2041
+ RequestId?: string;
2042
+ }
2043
+ /**
2044
+ * 告警主题
2045
+ */
2046
+ export interface AlarmTopic {
1449
2047
  /**
1450
- * 登录服务器的账号
2048
+ * 主题的ID
1451
2049
  */
1452
- UserName?: string;
2050
+ TopicId: string;
1453
2051
  /**
1454
- * 登录服务器的密码
2052
+ * 主题的名称
1455
2053
  */
1456
- PassWord?: string;
2054
+ TopicName: string;
2055
+ }
2056
+ /**
2057
+ * DeleteTasks请求参数结构体
2058
+ */
2059
+ export interface DeleteTasksRequest {
1457
2060
  /**
1458
- * 是否使用安全链接SSL, 0 不使用,1 使用
2061
+ * 拨测任务id
1459
2062
  */
1460
- UseSecConn?: number;
2063
+ TaskIds: Array<number>;
2064
+ }
2065
+ /**
2066
+ * DescribeProbeTasks请求参数结构体
2067
+ */
2068
+ export interface DescribeProbeTasksRequest {
1461
2069
  /**
1462
- * FTP登录验证方式 0 不验证 1 匿名登录 2 需要身份验证
2070
+ * 任务 ID 列表
1463
2071
  */
1464
- NeedAuth?: number;
2072
+ TaskIDs?: Array<string>;
1465
2073
  /**
1466
- * 请求数据类型。0 表示请求为字符串类型。1表示为二进制类型
2074
+ * 任务名
1467
2075
  */
1468
- ReqDataType?: number;
2076
+ TaskName?: string;
1469
2077
  /**
1470
- * 发起TCP, UDP请求的协议请求数据
2078
+ * 拨测目标
1471
2079
  */
1472
- ReqData?: string;
2080
+ TargetAddress?: string;
1473
2081
  /**
1474
- * 响应数据类型。0 表示响应为字符串类型。1表示为二进制类型
2082
+ * 任务状态列表
1475
2083
  */
1476
- RespDataType?: number;
2084
+ TaskStatus?: Array<number>;
1477
2085
  /**
1478
- * 预期的UDP请求的回应数据
2086
+ * 偏移量,默认为0
1479
2087
  */
1480
- RespData?: string;
2088
+ Offset?: number;
1481
2089
  /**
1482
- * 跟随跳转次数
2090
+ * 返回数量,默认为20,最大值为100
1483
2091
  */
1484
- RedirectFollowNum?: number;
1485
- }
1486
- /**
1487
- * GetReturnCodeHistory返回参数结构体
1488
- */
1489
- export interface GetReturnCodeHistoryResponse {
2092
+ Limit?: number;
1490
2093
  /**
1491
- * 拨测失败详情列表
2094
+ * 付费模式
2095
+ <li>1 = 试用版本</li>
2096
+ <li> 2 = 付费版本 </li>
1492
2097
  */
1493
- Details?: Array<CatReturnDetail>;
2098
+ PayMode?: number;
1494
2099
  /**
1495
- * 拨测失败汇总列表
2100
+ * 订单状态
2101
+ <li>1 = 正常</li>
2102
+ <li> 2 = 欠费 </li>
1496
2103
  */
1497
- Summary?: Array<CatReturnSummary>;
2104
+ OrderState?: number;
1498
2105
  /**
1499
- * 开始时间
2106
+ * 拨测类型
1500
2107
  */
1501
- BeginTime?: string;
2108
+ TaskType?: Array<number>;
1502
2109
  /**
1503
- * 截至时间
2110
+ * 节点类型
1504
2111
  */
1505
- EndTime?: string;
2112
+ TaskCategory?: Array<number>;
1506
2113
  /**
1507
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2114
+ * 排序的列
1508
2115
  */
1509
- RequestId?: string;
1510
- }
1511
- /**
1512
- * 时延等数据,数据点
1513
- */
1514
- export interface DataPoint {
2116
+ OrderBy?: string;
1515
2117
  /**
1516
- * 数据点的时间
2118
+ * 是否正序
1517
2119
  */
1518
- LogTime: string;
2120
+ Ascend?: boolean;
1519
2121
  /**
1520
- * 数据值
2122
+ * 资源标签值
1521
2123
  */
1522
- MetricValue: number;
2124
+ TagFilters?: Array<KeyValuePair>;
1523
2125
  }
1524
2126
  /**
1525
- * DescribeAlarmTopic返回参数结构体
2127
+ * PauseTask返回参数结构体
1526
2128
  */
1527
- export interface DescribeAlarmTopicResponse {
1528
- /**
1529
- * 主题个数
1530
- */
1531
- TotalCount?: number;
1532
- /**
1533
- * 主题列表
1534
- */
1535
- Topics?: Array<AlarmTopic>;
2129
+ export interface PauseTaskResponse {
1536
2130
  /**
1537
2131
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1538
2132
  */
1539
2133
  RequestId?: string;
1540
2134
  }
1541
2135
  /**
1542
- * GetRealAvailRatio返回参数结构体
2136
+ * GetDailyAvailRatio返回参数结构体
1543
2137
  */
1544
- export interface GetRealAvailRatioResponse {
2138
+ export interface GetDailyAvailRatioResponse {
1545
2139
  /**
1546
- * 国内平均可用率
2140
+ * 整体平均可用率
1547
2141
  */
1548
2142
  AvgAvailRatio?: number;
1549
2143
  /**
@@ -1554,10 +2148,6 @@ export interface GetRealAvailRatioResponse {
1554
2148
  * 可用率最低的省份
1555
2149
  */
1556
2150
  LowestProvince?: string;
1557
- /**
1558
- * 可用率最低的运营商
1559
- */
1560
- LowestIsp?: string;
1561
2151
  /**
1562
2152
  * 分省份的可用率数据
1563
2153
  */
@@ -1582,10 +2172,6 @@ export interface GetRealAvailRatioResponse {
1582
2172
  * 国外可用率最低的区域
1583
2173
  */
1584
2174
  LowestProvince2?: string;
1585
- /**
1586
- * 国外可用率最低的运营商
1587
- */
1588
- LowestIsp2?: string;
1589
2175
  /**
1590
2176
  * 国外分区域的可用率数据
1591
2177
  */
@@ -1596,85 +2182,108 @@ export interface GetRealAvailRatioResponse {
1596
2182
  RequestId?: string;
1597
2183
  }
1598
2184
  /**
1599
- * RunTask返回参数结构体
2185
+ * DeleteAgentGroup请求参数结构体
1600
2186
  */
1601
- export interface RunTaskResponse {
2187
+ export interface DeleteAgentGroupRequest {
1602
2188
  /**
1603
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2189
+ * 拨测分组id
1604
2190
  */
1605
- RequestId?: string;
2191
+ GroupId: number;
1606
2192
  }
1607
2193
  /**
1608
- * 拨测Agent 所在省份、运营商
2194
+ * GetRealAvailRatio请求参数结构体
1609
2195
  */
1610
- export interface CatAgent {
2196
+ export interface GetRealAvailRatioRequest {
1611
2197
  /**
1612
- * 拨测结点所在的省份(拼音缩写)
2198
+ * 拨测任务Id
1613
2199
  */
1614
- Province: string;
2200
+ TaskId: number;
2201
+ }
2202
+ /**
2203
+ * DeleteProbeTask返回参数结构体
2204
+ */
2205
+ export interface DeleteProbeTaskResponse {
1615
2206
  /**
1616
- * 拨测结点所在的运营商(英文缩写)
2207
+ * 任务总量
1617
2208
  */
1618
- Isp: string;
2209
+ Total: number;
1619
2210
  /**
1620
- * 拨测结点所在的省份(中文名称)
2211
+ * 任务成功量
1621
2212
  注意:此字段可能返回 null,表示取不到有效值。
1622
2213
  */
1623
- ProvinceName?: string;
2214
+ SuccessCount: number;
1624
2215
  /**
1625
- * 拨测结点所在的运营商(中文名称)
2216
+ * 任务执行结果
1626
2217
  注意:此字段可能返回 null,表示取不到有效值。
1627
2218
  */
1628
- IspName?: string;
2219
+ Results: Array<TaskResult>;
2220
+ /**
2221
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2222
+ */
2223
+ RequestId?: string;
1629
2224
  }
1630
2225
  /**
1631
- * DescribeCatLogs返回参数结构体
2226
+ * CreateProbeTasks返回参数结构体
1632
2227
  */
1633
- export interface DescribeCatLogsResponse {
1634
- /**
1635
- * 符合条件的总记录数
1636
- */
1637
- TotalCount?: number;
1638
- /**
1639
- * 拨测记录列表
1640
- */
1641
- CatLogs?: Array<CatLog>;
2228
+ export interface CreateProbeTasksResponse {
1642
2229
  /**
1643
2230
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1644
2231
  */
1645
2232
  RequestId?: string;
1646
2233
  }
1647
2234
  /**
1648
- * GetTaskTotalNumber返回参数结构体
2235
+ * DescribeProbeNodes请求参数结构体
1649
2236
  */
1650
- export interface GetTaskTotalNumberResponse {
2237
+ export interface DescribeProbeNodesRequest {
1651
2238
  /**
1652
- * 拨测任务总数
2239
+ * 节点类型
2240
+ <li> 1 = IDC </li>
2241
+ <li> 2 = LastMile </li>
2242
+ <li> 3 = Mobile </li>
1653
2243
  */
1654
- TotalCount?: number;
2244
+ NodeType?: number;
1655
2245
  /**
1656
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2246
+ * 节点区域
2247
+ <li> 1 = 中国大陆 </li>
2248
+ <li> 2 = 港澳台 </li>
2249
+ <li> 3 = 海外 </li>
1657
2250
  */
1658
- RequestId?: string;
2251
+ Location?: number;
2252
+ /**
2253
+ * 是否IPv6
2254
+ */
2255
+ IsIPv6?: boolean;
2256
+ /**
2257
+ * 名字模糊搜索
2258
+ */
2259
+ NodeName?: string;
2260
+ /**
2261
+ * 付费模式
2262
+ <li>1 = 试用版本</li>
2263
+ <li> 2 = 付费版本 </li>
2264
+ */
2265
+ PayMode?: number;
1659
2266
  }
1660
2267
  /**
1661
- * CreateTaskEx返回参数结构体
2268
+ * 拨测Agent 所在省份、运营商
1662
2269
  */
1663
- export interface CreateTaskExResponse {
2270
+ export interface CatAgent {
1664
2271
  /**
1665
- * 拨测结果查询ID。接下来可以使用查询拨测是否能够成功,验证能否通过。
2272
+ * 拨测结点所在的省份(拼音缩写)
1666
2273
  */
1667
- ResultId?: number;
2274
+ Province: string;
1668
2275
  /**
1669
- * 拨测任务ID。验证通过后,创建任务时使用,传递给CreateTask 接口。
2276
+ * 拨测结点所在的运营商(英文缩写)
1670
2277
  */
1671
- TaskId?: number;
2278
+ Isp: string;
1672
2279
  /**
1673
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2280
+ * 拨测结点所在的省份(中文名称)
2281
+ 注意:此字段可能返回 null,表示取不到有效值。
1674
2282
  */
1675
- RequestId?: string;
2283
+ ProvinceName?: string;
2284
+ /**
2285
+ * 拨测结点所在的运营商(中文名称)
2286
+ 注意:此字段可能返回 null,表示取不到有效值。
2287
+ */
2288
+ IspName?: string;
1676
2289
  }
1677
- /**
1678
- * DescribeUserLimit请求参数结构体
1679
- */
1680
- export declare type DescribeUserLimitRequest = null;