oci-monitoring 2.102.2 → 2.104.0
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.
- package/index.d.ts +2 -2
- package/index.js +2 -2
- package/lib/client.d.ts +62 -62
- package/lib/client.js +62 -62
- package/lib/model/aggregated-datapoint.d.ts +2 -2
- package/lib/model/aggregated-datapoint.js +2 -2
- package/lib/model/alarm-dimension-states-collection.d.ts +3 -3
- package/lib/model/alarm-dimension-states-collection.js +2 -2
- package/lib/model/alarm-dimension-states-entry.d.ts +4 -4
- package/lib/model/alarm-dimension-states-entry.js +2 -2
- package/lib/model/alarm-history-collection.d.ts +3 -3
- package/lib/model/alarm-history-collection.js +2 -2
- package/lib/model/alarm-history-entry.d.ts +4 -4
- package/lib/model/alarm-history-entry.js +2 -2
- package/lib/model/alarm-override.d.ts +7 -7
- package/lib/model/alarm-override.js +2 -2
- package/lib/model/alarm-status-summary.d.ts +9 -9
- package/lib/model/alarm-status-summary.js +2 -2
- package/lib/model/alarm-summary.d.ts +19 -19
- package/lib/model/alarm-summary.js +2 -2
- package/lib/model/alarm-suppression-alarm-target.d.ts +3 -3
- package/lib/model/alarm-suppression-alarm-target.js +2 -2
- package/lib/model/alarm-suppression-collection.d.ts +2 -2
- package/lib/model/alarm-suppression-collection.js +2 -2
- package/lib/model/alarm-suppression-compartment-target.d.ts +3 -3
- package/lib/model/alarm-suppression-compartment-target.js +2 -2
- package/lib/model/alarm-suppression-history-item-collection.d.ts +2 -2
- package/lib/model/alarm-suppression-history-item-collection.js +2 -2
- package/lib/model/alarm-suppression-history-item.d.ts +3 -3
- package/lib/model/alarm-suppression-history-item.js +2 -2
- package/lib/model/alarm-suppression-summary.d.ts +4 -4
- package/lib/model/alarm-suppression-summary.js +2 -2
- package/lib/model/alarm-suppression-target.d.ts +2 -2
- package/lib/model/alarm-suppression-target.js +2 -2
- package/lib/model/alarm-suppression.d.ts +4 -4
- package/lib/model/alarm-suppression.js +2 -2
- package/lib/model/alarm.d.ts +20 -20
- package/lib/model/alarm.js +2 -2
- package/lib/model/change-alarm-compartment-details.d.ts +3 -3
- package/lib/model/change-alarm-compartment-details.js +2 -2
- package/lib/model/create-alarm-details.d.ts +15 -15
- package/lib/model/create-alarm-details.js +2 -2
- package/lib/model/create-alarm-suppression-details.d.ts +2 -2
- package/lib/model/create-alarm-suppression-details.js +2 -2
- package/lib/model/datapoint.d.ts +2 -2
- package/lib/model/datapoint.js +2 -2
- package/lib/model/failed-metric-record.d.ts +2 -2
- package/lib/model/failed-metric-record.js +2 -2
- package/lib/model/index.d.ts +2 -2
- package/lib/model/index.js +2 -2
- package/lib/model/list-metrics-details.d.ts +2 -2
- package/lib/model/list-metrics-details.js +2 -2
- package/lib/model/metric-data-details.d.ts +3 -3
- package/lib/model/metric-data-details.js +2 -2
- package/lib/model/metric-data.d.ts +5 -5
- package/lib/model/metric-data.js +2 -2
- package/lib/model/metric.d.ts +4 -4
- package/lib/model/metric.js +2 -2
- package/lib/model/post-metric-data-details.d.ts +2 -2
- package/lib/model/post-metric-data-details.js +2 -2
- package/lib/model/post-metric-data-response-details.d.ts +2 -2
- package/lib/model/post-metric-data-response-details.js +2 -2
- package/lib/model/recurrence.d.ts +2 -2
- package/lib/model/recurrence.js +2 -2
- package/lib/model/retrieve-dimension-states-details.d.ts +2 -2
- package/lib/model/retrieve-dimension-states-details.js +2 -2
- package/lib/model/summarize-alarm-suppression-history-details.d.ts +2 -2
- package/lib/model/summarize-alarm-suppression-history-details.js +2 -2
- package/lib/model/summarize-metrics-data-details.d.ts +4 -4
- package/lib/model/summarize-metrics-data-details.js +2 -2
- package/lib/model/suppression-condition.d.ts +2 -2
- package/lib/model/suppression-condition.js +2 -2
- package/lib/model/suppression.d.ts +3 -3
- package/lib/model/suppression.js +2 -2
- package/lib/model/update-alarm-details.d.ts +15 -15
- package/lib/model/update-alarm-details.js +2 -2
- package/lib/monitoring-waiter.d.ts +2 -2
- package/lib/monitoring-waiter.js +2 -2
- package/lib/request/change-alarm-compartment-request.d.ts +2 -2
- package/lib/request/create-alarm-request.d.ts +1 -1
- package/lib/request/create-alarm-suppression-request.d.ts +1 -1
- package/lib/request/delete-alarm-request.d.ts +2 -2
- package/lib/request/delete-alarm-suppression-request.d.ts +2 -2
- package/lib/request/get-alarm-history-request.d.ts +4 -4
- package/lib/request/get-alarm-request.d.ts +2 -2
- package/lib/request/get-alarm-suppression-request.d.ts +2 -2
- package/lib/request/index.d.ts +2 -2
- package/lib/request/index.js +2 -2
- package/lib/request/list-alarm-suppressions-request.d.ts +5 -5
- package/lib/request/list-alarms-request.d.ts +4 -4
- package/lib/request/list-alarms-status-request.d.ts +6 -6
- package/lib/request/list-metrics-request.d.ts +4 -4
- package/lib/request/post-metric-data-request.d.ts +1 -1
- package/lib/request/remove-alarm-suppression-request.d.ts +2 -2
- package/lib/request/retrieve-dimension-states-request.d.ts +4 -4
- package/lib/request/summarize-alarm-suppression-history-request.d.ts +4 -4
- package/lib/request/summarize-metrics-data-request.d.ts +2 -2
- package/lib/request/update-alarm-request.d.ts +2 -2
- package/lib/response/get-alarm-history-response.d.ts +1 -1
- package/lib/response/index.d.ts +2 -2
- package/lib/response/index.js +2 -2
- package/lib/response/list-alarm-suppressions-response.d.ts +2 -2
- package/lib/response/list-alarms-response.d.ts +1 -1
- package/lib/response/list-alarms-status-response.d.ts +1 -1
- package/lib/response/list-metrics-response.d.ts +1 -1
- package/lib/response/retrieve-dimension-states-response.d.ts +1 -1
- package/lib/response/summarize-alarm-suppression-history-response.d.ts +2 -2
- package/package.json +3 -3
package/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Monitoring API
|
|
3
3
|
* Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
|
|
4
|
-
Endpoints vary by operation. For PostMetricData, use the
|
|
4
|
+
Endpoints vary by operation. For PostMetricData, use the {@code telemetry-ingestion} endpoints; for all other operations, use the {@code telemetry} endpoints.
|
|
5
5
|
For more information, see
|
|
6
|
-
[the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
|
|
6
|
+
[the Monitoring documentation](https://docs.oracle.com/iaas/Content/Monitoring/home.htm).
|
|
7
7
|
|
|
8
8
|
* OpenAPI spec version: 20180401
|
|
9
9
|
*
|
package/index.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Monitoring API
|
|
4
4
|
* Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
|
|
5
|
-
Endpoints vary by operation. For PostMetricData, use the
|
|
5
|
+
Endpoints vary by operation. For PostMetricData, use the {@code telemetry-ingestion} endpoints; for all other operations, use the {@code telemetry} endpoints.
|
|
6
6
|
For more information, see
|
|
7
|
-
[the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
|
|
7
|
+
[the Monitoring documentation](https://docs.oracle.com/iaas/Content/Monitoring/home.htm).
|
|
8
8
|
|
|
9
9
|
* OpenAPI spec version: 20180401
|
|
10
10
|
*
|
package/lib/client.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Monitoring API
|
|
3
3
|
* Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
|
|
4
|
-
Endpoints vary by operation. For PostMetricData, use the
|
|
4
|
+
Endpoints vary by operation. For PostMetricData, use the {@code telemetry-ingestion} endpoints; for all other operations, use the {@code telemetry} endpoints.
|
|
5
5
|
For more information, see
|
|
6
|
-
[the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
|
|
6
|
+
[the Monitoring documentation](https://docs.oracle.com/iaas/Content/Monitoring/home.htm).
|
|
7
7
|
|
|
8
8
|
* OpenAPI spec version: 20180401
|
|
9
9
|
*
|
|
@@ -102,21 +102,21 @@ export declare class MonitoringClient {
|
|
|
102
102
|
/**
|
|
103
103
|
* Moves an alarm into a different compartment within the same tenancy.
|
|
104
104
|
* For more information, see
|
|
105
|
-
* [Moving an Alarm](https://docs.
|
|
105
|
+
* [Moving an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/change-compartment-alarm.htm).
|
|
106
106
|
*
|
|
107
107
|
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
108
108
|
* @param ChangeAlarmCompartmentRequest
|
|
109
109
|
* @return ChangeAlarmCompartmentResponse
|
|
110
110
|
* @throws OciError when an error occurs
|
|
111
|
-
* @example Click {@link https://docs.
|
|
111
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API.
|
|
112
112
|
*/
|
|
113
113
|
changeAlarmCompartment(changeAlarmCompartmentRequest: requests.ChangeAlarmCompartmentRequest): Promise<responses.ChangeAlarmCompartmentResponse>;
|
|
114
114
|
/**
|
|
115
115
|
* Creates a new alarm in the specified compartment.
|
|
116
116
|
* For more information, see
|
|
117
|
-
* [Creating an Alarm](https://docs.
|
|
117
|
+
* [Creating an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm.htm).
|
|
118
118
|
* For important limits information, see
|
|
119
|
-
* [Limits on Monitoring](https://docs.
|
|
119
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
120
120
|
* <p>
|
|
121
121
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
122
122
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -126,17 +126,17 @@ export declare class MonitoringClient {
|
|
|
126
126
|
* @param CreateAlarmRequest
|
|
127
127
|
* @return CreateAlarmResponse
|
|
128
128
|
* @throws OciError when an error occurs
|
|
129
|
-
* @example Click {@link https://docs.
|
|
129
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API.
|
|
130
130
|
*/
|
|
131
131
|
createAlarm(createAlarmRequest: requests.CreateAlarmRequest): Promise<responses.CreateAlarmResponse>;
|
|
132
132
|
/**
|
|
133
133
|
* Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific).
|
|
134
134
|
* For more information, see
|
|
135
|
-
* [Adding an Alarm-wide Suppression](https://docs.
|
|
136
|
-
* [Adding a Dimension-Specific Alarm Suppression](https://docs.
|
|
135
|
+
* [Adding an Alarm-wide Suppression](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/add-alarm-suppression.htm) and
|
|
136
|
+
* [Adding a Dimension-Specific Alarm Suppression](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm).
|
|
137
137
|
* <p>
|
|
138
138
|
For important limits information, see
|
|
139
|
-
* [Limits on Monitoring](https://docs.
|
|
139
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
140
140
|
* <p>
|
|
141
141
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
142
142
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -146,15 +146,15 @@ export declare class MonitoringClient {
|
|
|
146
146
|
* @param CreateAlarmSuppressionRequest
|
|
147
147
|
* @return CreateAlarmSuppressionResponse
|
|
148
148
|
* @throws OciError when an error occurs
|
|
149
|
-
* @example Click {@link https://docs.
|
|
149
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/CreateAlarmSuppression.ts.html |here} to see how to use CreateAlarmSuppression API.
|
|
150
150
|
*/
|
|
151
151
|
createAlarmSuppression(createAlarmSuppressionRequest: requests.CreateAlarmSuppressionRequest): Promise<responses.CreateAlarmSuppressionResponse>;
|
|
152
152
|
/**
|
|
153
153
|
* Deletes the specified alarm.
|
|
154
154
|
* For more information, see
|
|
155
|
-
* [Deleting an Alarm](https://docs.
|
|
155
|
+
* [Deleting an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/delete-alarm.htm).
|
|
156
156
|
* For important limits information, see
|
|
157
|
-
* [Limits on Monitoring](https://docs.
|
|
157
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
158
158
|
* <p>
|
|
159
159
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
160
160
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -164,16 +164,16 @@ export declare class MonitoringClient {
|
|
|
164
164
|
* @param DeleteAlarmRequest
|
|
165
165
|
* @return DeleteAlarmResponse
|
|
166
166
|
* @throws OciError when an error occurs
|
|
167
|
-
* @example Click {@link https://docs.
|
|
167
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API.
|
|
168
168
|
*/
|
|
169
169
|
deleteAlarm(deleteAlarmRequest: requests.DeleteAlarmRequest): Promise<responses.DeleteAlarmResponse>;
|
|
170
170
|
/**
|
|
171
171
|
* Deletes the specified alarm suppression. For more information, see
|
|
172
|
-
* [Removing an Alarm-wide Suppression](https://docs.
|
|
173
|
-
* [Removing a Dimension-Specific Alarm Suppression](https://docs.
|
|
172
|
+
* [Removing an Alarm-wide Suppression](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/remove-alarm-suppression.htm) and
|
|
173
|
+
* [Removing a Dimension-Specific Alarm Suppression](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm).
|
|
174
174
|
* <p>
|
|
175
175
|
For important limits information, see
|
|
176
|
-
* [Limits on Monitoring](https://docs.
|
|
176
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
177
177
|
* <p>
|
|
178
178
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
179
179
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -183,15 +183,15 @@ export declare class MonitoringClient {
|
|
|
183
183
|
* @param DeleteAlarmSuppressionRequest
|
|
184
184
|
* @return DeleteAlarmSuppressionResponse
|
|
185
185
|
* @throws OciError when an error occurs
|
|
186
|
-
* @example Click {@link https://docs.
|
|
186
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/DeleteAlarmSuppression.ts.html |here} to see how to use DeleteAlarmSuppression API.
|
|
187
187
|
*/
|
|
188
188
|
deleteAlarmSuppression(deleteAlarmSuppressionRequest: requests.DeleteAlarmSuppressionRequest): Promise<responses.DeleteAlarmSuppressionResponse>;
|
|
189
189
|
/**
|
|
190
190
|
* Gets the specified alarm.
|
|
191
191
|
* For more information, see
|
|
192
|
-
* [Getting an Alarm](https://docs.
|
|
192
|
+
* [Getting an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm.htm).
|
|
193
193
|
* For important limits information, see
|
|
194
|
-
* [Limits on Monitoring](https://docs.
|
|
194
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
195
195
|
* <p>
|
|
196
196
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
197
197
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -201,15 +201,15 @@ export declare class MonitoringClient {
|
|
|
201
201
|
* @param GetAlarmRequest
|
|
202
202
|
* @return GetAlarmResponse
|
|
203
203
|
* @throws OciError when an error occurs
|
|
204
|
-
* @example Click {@link https://docs.
|
|
204
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API.
|
|
205
205
|
*/
|
|
206
206
|
getAlarm(getAlarmRequest: requests.GetAlarmRequest): Promise<responses.GetAlarmResponse>;
|
|
207
207
|
/**
|
|
208
208
|
* Get the history of the specified alarm.
|
|
209
209
|
* For more information, see
|
|
210
|
-
* [Getting History of an Alarm](https://docs.
|
|
210
|
+
* [Getting History of an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-history.htm).
|
|
211
211
|
* For important limits information, see
|
|
212
|
-
* [Limits on Monitoring](https://docs.
|
|
212
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
213
213
|
* <p>
|
|
214
214
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
215
215
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -219,15 +219,15 @@ export declare class MonitoringClient {
|
|
|
219
219
|
* @param GetAlarmHistoryRequest
|
|
220
220
|
* @return GetAlarmHistoryResponse
|
|
221
221
|
* @throws OciError when an error occurs
|
|
222
|
-
* @example Click {@link https://docs.
|
|
222
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API.
|
|
223
223
|
*/
|
|
224
224
|
getAlarmHistory(getAlarmHistoryRequest: requests.GetAlarmHistoryRequest): Promise<responses.GetAlarmHistoryResponse>;
|
|
225
225
|
/**
|
|
226
226
|
* Gets the specified alarm suppression. For more information, see
|
|
227
|
-
* [Getting an Alarm-wide Suppression](https://docs.
|
|
227
|
+
* [Getting an Alarm-wide Suppression](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm).
|
|
228
228
|
* <p>
|
|
229
229
|
For important limits information, see
|
|
230
|
-
* [Limits on Monitoring](https://docs.
|
|
230
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
231
231
|
* <p>
|
|
232
232
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
233
233
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -237,15 +237,15 @@ export declare class MonitoringClient {
|
|
|
237
237
|
* @param GetAlarmSuppressionRequest
|
|
238
238
|
* @return GetAlarmSuppressionResponse
|
|
239
239
|
* @throws OciError when an error occurs
|
|
240
|
-
* @example Click {@link https://docs.
|
|
240
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/GetAlarmSuppression.ts.html |here} to see how to use GetAlarmSuppression API.
|
|
241
241
|
*/
|
|
242
242
|
getAlarmSuppression(getAlarmSuppressionRequest: requests.GetAlarmSuppressionRequest): Promise<responses.GetAlarmSuppressionResponse>;
|
|
243
243
|
/**
|
|
244
244
|
* Lists alarm suppressions for the specified alarm. For more information, see
|
|
245
|
-
* [Listing Alarm Suppressions](https://docs.
|
|
245
|
+
* [Listing Alarm Suppressions](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-suppression.htm).
|
|
246
246
|
* <p>
|
|
247
247
|
For important limits information, see
|
|
248
|
-
* [Limits on Monitoring](https://docs.
|
|
248
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
249
249
|
* <p>
|
|
250
250
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
251
251
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -255,15 +255,15 @@ export declare class MonitoringClient {
|
|
|
255
255
|
* @param ListAlarmSuppressionsRequest
|
|
256
256
|
* @return ListAlarmSuppressionsResponse
|
|
257
257
|
* @throws OciError when an error occurs
|
|
258
|
-
* @example Click {@link https://docs.
|
|
258
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/ListAlarmSuppressions.ts.html |here} to see how to use ListAlarmSuppressions API.
|
|
259
259
|
*/
|
|
260
260
|
listAlarmSuppressions(listAlarmSuppressionsRequest: requests.ListAlarmSuppressionsRequest): Promise<responses.ListAlarmSuppressionsResponse>;
|
|
261
261
|
/**
|
|
262
262
|
* Lists the alarms for the specified compartment.
|
|
263
263
|
* For more information, see
|
|
264
|
-
* [Listing Alarms](https://docs.
|
|
264
|
+
* [Listing Alarms](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm.htm).
|
|
265
265
|
* For important limits information, see
|
|
266
|
-
* [Limits on Monitoring](https://docs.
|
|
266
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
267
267
|
* <p>
|
|
268
268
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
269
269
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -273,7 +273,7 @@ export declare class MonitoringClient {
|
|
|
273
273
|
* @param ListAlarmsRequest
|
|
274
274
|
* @return ListAlarmsResponse
|
|
275
275
|
* @throws OciError when an error occurs
|
|
276
|
-
* @example Click {@link https://docs.
|
|
276
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API.
|
|
277
277
|
*/
|
|
278
278
|
listAlarms(listAlarmsRequest: requests.ListAlarmsRequest): Promise<responses.ListAlarmsResponse>;
|
|
279
279
|
/**
|
|
@@ -315,9 +315,9 @@ export declare class MonitoringClient {
|
|
|
315
315
|
* Optionally filter by resource or status value.
|
|
316
316
|
* <p>
|
|
317
317
|
For more information, see
|
|
318
|
-
* [Listing Alarm Statuses](https://docs.
|
|
318
|
+
* [Listing Alarm Statuses](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).
|
|
319
319
|
* For important limits information, see
|
|
320
|
-
* [Limits on Monitoring](https://docs.
|
|
320
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
321
321
|
* <p>
|
|
322
322
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
323
323
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -327,7 +327,7 @@ export declare class MonitoringClient {
|
|
|
327
327
|
* @param ListAlarmsStatusRequest
|
|
328
328
|
* @return ListAlarmsStatusResponse
|
|
329
329
|
* @throws OciError when an error occurs
|
|
330
|
-
* @example Click {@link https://docs.
|
|
330
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API.
|
|
331
331
|
*/
|
|
332
332
|
listAlarmsStatus(listAlarmsStatusRequest: requests.ListAlarmsStatusRequest): Promise<responses.ListAlarmsStatusResponse>;
|
|
333
333
|
/**
|
|
@@ -365,11 +365,11 @@ export declare class MonitoringClient {
|
|
|
365
365
|
/**
|
|
366
366
|
* Returns metric definitions that match the criteria specified in the request. Compartment OCID required.
|
|
367
367
|
* For more information, see
|
|
368
|
-
* [Listing Metric Definitions](https://docs.
|
|
368
|
+
* [Listing Metric Definitions](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-metric.htm).
|
|
369
369
|
* For information about metrics, see
|
|
370
|
-
* [Metrics Overview](https://docs.
|
|
370
|
+
* [Metrics Overview](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).
|
|
371
371
|
* For important limits information, see
|
|
372
|
-
* [Limits on Monitoring](https://docs.
|
|
372
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
373
373
|
* <p>
|
|
374
374
|
Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
|
|
375
375
|
*
|
|
@@ -377,7 +377,7 @@ export declare class MonitoringClient {
|
|
|
377
377
|
* @param ListMetricsRequest
|
|
378
378
|
* @return ListMetricsResponse
|
|
379
379
|
* @throws OciError when an error occurs
|
|
380
|
-
* @example Click {@link https://docs.
|
|
380
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API.
|
|
381
381
|
*/
|
|
382
382
|
listMetrics(listMetricsRequest: requests.ListMetricsRequest): Promise<responses.ListMetricsResponse>;
|
|
383
383
|
/**
|
|
@@ -417,15 +417,15 @@ export declare class MonitoringClient {
|
|
|
417
417
|
* For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).
|
|
418
418
|
* <p>
|
|
419
419
|
For more information about publishing metrics, see
|
|
420
|
-
* [Publishing Custom Metrics](https://docs.
|
|
420
|
+
* [Publishing Custom Metrics](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm)
|
|
421
421
|
* and
|
|
422
|
-
* [Custom Metrics Walkthrough](https://docs.
|
|
422
|
+
* [Custom Metrics Walkthrough](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm).
|
|
423
423
|
* For information about developing a metric-posting client, see
|
|
424
|
-
* [Developer Guide](https://docs.
|
|
424
|
+
* [Developer Guide](https://docs.oracle.com/iaas/Content/API/Concepts/devtoolslanding.htm).
|
|
425
425
|
* For an example client, see
|
|
426
426
|
* [MonitoringMetricPostExample.java](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/MonitoringMetricPostExample.java).
|
|
427
427
|
* For important limits information, see
|
|
428
|
-
* [Limits on Monitoring](https://docs.
|
|
428
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
429
429
|
* <p>
|
|
430
430
|
Per-call limits information follows.
|
|
431
431
|
* <p>
|
|
@@ -437,7 +437,7 @@ export declare class MonitoringClient {
|
|
|
437
437
|
* A dimension is a qualifier provided in a metric definition.
|
|
438
438
|
* A metric stream is an individual set of aggregated data for a metric with zero or more dimension values.
|
|
439
439
|
* For more information about metric-related concepts, see
|
|
440
|
-
* [Monitoring Concepts](https://docs.
|
|
440
|
+
* [Monitoring Concepts](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
|
|
441
441
|
* <p>
|
|
442
442
|
**Note:** The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:
|
|
443
443
|
* <p>
|
|
@@ -447,15 +447,15 @@ export declare class MonitoringClient {
|
|
|
447
447
|
* @param PostMetricDataRequest
|
|
448
448
|
* @return PostMetricDataResponse
|
|
449
449
|
* @throws OciError when an error occurs
|
|
450
|
-
* @example Click {@link https://docs.
|
|
450
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API.
|
|
451
451
|
*/
|
|
452
452
|
postMetricData(postMetricDataRequest: requests.PostMetricDataRequest): Promise<responses.PostMetricDataResponse>;
|
|
453
453
|
/**
|
|
454
454
|
* Removes any existing suppression for the specified alarm.
|
|
455
455
|
* For more information, see
|
|
456
|
-
* [Removing Suppression from an Alarm](https://docs.
|
|
456
|
+
* [Removing Suppression from an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/remove-alarm-suppression.htm).
|
|
457
457
|
* For important limits information, see
|
|
458
|
-
* [Limits on Monitoring](https://docs.
|
|
458
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
459
459
|
* <p>
|
|
460
460
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
461
461
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -465,7 +465,7 @@ export declare class MonitoringClient {
|
|
|
465
465
|
* @param RemoveAlarmSuppressionRequest
|
|
466
466
|
* @return RemoveAlarmSuppressionResponse
|
|
467
467
|
* @throws OciError when an error occurs
|
|
468
|
-
* @example Click {@link https://docs.
|
|
468
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API.
|
|
469
469
|
*/
|
|
470
470
|
removeAlarmSuppression(removeAlarmSuppressionRequest: requests.RemoveAlarmSuppressionRequest): Promise<responses.RemoveAlarmSuppressionResponse>;
|
|
471
471
|
/**
|
|
@@ -473,10 +473,10 @@ export declare class MonitoringClient {
|
|
|
473
473
|
* Optionally filter by status value and one or more dimension key-value pairs.
|
|
474
474
|
* <p>
|
|
475
475
|
For more information, see
|
|
476
|
-
* [Listing Metric Stream Status in an Alarm](https://docs.
|
|
476
|
+
* [Listing Metric Stream Status in an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm).
|
|
477
477
|
* <p>
|
|
478
478
|
For important limits information, see
|
|
479
|
-
* [Limits on Monitoring](https://docs.
|
|
479
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
480
480
|
* <p>
|
|
481
481
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
482
482
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -486,15 +486,15 @@ export declare class MonitoringClient {
|
|
|
486
486
|
* @param RetrieveDimensionStatesRequest
|
|
487
487
|
* @return RetrieveDimensionStatesResponse
|
|
488
488
|
* @throws OciError when an error occurs
|
|
489
|
-
* @example Click {@link https://docs.
|
|
489
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API.
|
|
490
490
|
*/
|
|
491
491
|
retrieveDimensionStates(retrieveDimensionStatesRequest: requests.RetrieveDimensionStatesRequest): Promise<responses.RetrieveDimensionStatesResponse>;
|
|
492
492
|
/**
|
|
493
493
|
* Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see
|
|
494
|
-
* [Getting Suppression History for an Alarm](https://docs.
|
|
494
|
+
* [Getting Suppression History for an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/summarize-alarm-suppression-history.htm).
|
|
495
495
|
* <p>
|
|
496
496
|
For important limits information, see
|
|
497
|
-
* [Limits on Monitoring](https://docs.
|
|
497
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
498
498
|
* <p>
|
|
499
499
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
500
500
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -504,17 +504,17 @@ export declare class MonitoringClient {
|
|
|
504
504
|
* @param SummarizeAlarmSuppressionHistoryRequest
|
|
505
505
|
* @return SummarizeAlarmSuppressionHistoryResponse
|
|
506
506
|
* @throws OciError when an error occurs
|
|
507
|
-
* @example Click {@link https://docs.
|
|
507
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/SummarizeAlarmSuppressionHistory.ts.html |here} to see how to use SummarizeAlarmSuppressionHistory API.
|
|
508
508
|
*/
|
|
509
509
|
summarizeAlarmSuppressionHistory(summarizeAlarmSuppressionHistoryRequest: requests.SummarizeAlarmSuppressionHistoryRequest): Promise<responses.SummarizeAlarmSuppressionHistoryResponse>;
|
|
510
510
|
/**
|
|
511
511
|
* Returns aggregated data that match the criteria specified in the request. Compartment OCID required.
|
|
512
512
|
* For more information, see
|
|
513
|
-
* [Querying Metric Data](https://docs.
|
|
513
|
+
* [Querying Metric Data](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-landing.htm)
|
|
514
514
|
* and
|
|
515
|
-
* [Creating a Query](https://docs.
|
|
515
|
+
* [Creating a Query](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric.htm).
|
|
516
516
|
* For important limits information, see
|
|
517
|
-
* [Limits on Monitoring](https://docs.
|
|
517
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
518
518
|
* <p>
|
|
519
519
|
Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
|
|
520
520
|
*
|
|
@@ -522,15 +522,15 @@ export declare class MonitoringClient {
|
|
|
522
522
|
* @param SummarizeMetricsDataRequest
|
|
523
523
|
* @return SummarizeMetricsDataResponse
|
|
524
524
|
* @throws OciError when an error occurs
|
|
525
|
-
* @example Click {@link https://docs.
|
|
525
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API.
|
|
526
526
|
*/
|
|
527
527
|
summarizeMetricsData(summarizeMetricsDataRequest: requests.SummarizeMetricsDataRequest): Promise<responses.SummarizeMetricsDataResponse>;
|
|
528
528
|
/**
|
|
529
529
|
* Updates the specified alarm.
|
|
530
530
|
* For more information, see
|
|
531
|
-
* [Updating an Alarm](https://docs.
|
|
531
|
+
* [Updating an Alarm](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm.htm).
|
|
532
532
|
* For important limits information, see
|
|
533
|
-
* [Limits on Monitoring](https://docs.
|
|
533
|
+
* [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
|
|
534
534
|
* <p>
|
|
535
535
|
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
|
536
536
|
* Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
|
@@ -540,7 +540,7 @@ export declare class MonitoringClient {
|
|
|
540
540
|
* @param UpdateAlarmRequest
|
|
541
541
|
* @return UpdateAlarmResponse
|
|
542
542
|
* @throws OciError when an error occurs
|
|
543
|
-
* @example Click {@link https://docs.
|
|
543
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API.
|
|
544
544
|
*/
|
|
545
545
|
updateAlarm(updateAlarmRequest: requests.UpdateAlarmRequest): Promise<responses.UpdateAlarmResponse>;
|
|
546
546
|
}
|