@dynatrace-sdk/client-classic-environment-v2 3.2.0 → 3.3.2
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/CHANGELOG.md +24 -2
- package/README.md +3038 -500
- package/cjs/index.js +6456 -4872
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +6456 -4872
- package/package.json +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +8 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +12 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-active-gate-groups-api.d.ts +4 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +31 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +11 -8
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +28 -26
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +11 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +39 -18
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +12 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +18 -9
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +33 -16
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/any-value.d.ts +2 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/any-value.transformation.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-type.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-type.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.transformation.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/utils/encoding.d.ts +1 -1
- package/types/packages/shared-errors/src/api-client-error.d.ts +13 -1
- package/types/packages/shared-errors/src/api-gateway-error.d.ts +19 -0
- package/types/packages/shared-errors/src/client-request-error.d.ts +29 -0
- package/types/packages/shared-errors/src/index.d.ts +0 -1
- package/types/packages/shared-errors/src/invalid-response-error.d.ts +18 -1
- package/types/packages/shared-errors/src/types.d.ts +62 -5
- package/types/packages/shared-errors/src/sdk-error.d.ts +0 -5
|
@@ -41,7 +41,7 @@ export declare class Extensions_2_0Client {
|
|
|
41
41
|
* + environment:roles:manage-settings
|
|
42
42
|
* + extensions:definitions:read
|
|
43
43
|
*
|
|
44
|
-
* @returns Success
|
|
44
|
+
* @returns {Promise<ExtensionList>} Success
|
|
45
45
|
*
|
|
46
46
|
* @example <caption>Code example</caption>
|
|
47
47
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -78,7 +78,7 @@ export declare class Extensions_2_0Client {
|
|
|
78
78
|
* + environment:roles:manage-settings
|
|
79
79
|
* + extensions:definitions:write
|
|
80
80
|
*
|
|
81
|
-
* @returns The extension is valid | Success. The extension 2.0 has been uploaded.
|
|
81
|
+
* @returns {Promise<ExtensionUploadResponseDto>} The extension is valid | Success. The extension 2.0 has been uploaded.
|
|
82
82
|
*
|
|
83
83
|
* @example <caption>Code example</caption>
|
|
84
84
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -104,7 +104,7 @@ export declare class Extensions_2_0Client {
|
|
|
104
104
|
* + environment:roles:manage-settings
|
|
105
105
|
* + extensions:definitions:read
|
|
106
106
|
*
|
|
107
|
-
* @returns Success
|
|
107
|
+
* @returns {Promise<ExtensionInfoList>} Success
|
|
108
108
|
*
|
|
109
109
|
* @example <caption>Code example</caption>
|
|
110
110
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -142,7 +142,7 @@ export declare class Extensions_2_0Client {
|
|
|
142
142
|
* + environment:roles:manage-settings
|
|
143
143
|
* + extensions:definitions:read
|
|
144
144
|
*
|
|
145
|
-
* @returns Success
|
|
145
|
+
* @returns {Promise<SchemasList>} Success
|
|
146
146
|
*
|
|
147
147
|
* @example <caption>Code example</caption>
|
|
148
148
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -154,7 +154,9 @@ export declare class Extensions_2_0Client {
|
|
|
154
154
|
* @throws {ApiClientError}
|
|
155
155
|
* @throws {ClientRequestError}
|
|
156
156
|
*/
|
|
157
|
-
listSchemas(
|
|
157
|
+
listSchemas(config?: {
|
|
158
|
+
abortSignal?: AbortSignal;
|
|
159
|
+
} | AbortSignal): Promise<SchemasList>;
|
|
158
160
|
/**
|
|
159
161
|
* Lists all the files available for the specified extension 2.0 schema version
|
|
160
162
|
*
|
|
@@ -162,7 +164,7 @@ export declare class Extensions_2_0Client {
|
|
|
162
164
|
* + environment:roles:manage-settings
|
|
163
165
|
* + extensions:definitions:read
|
|
164
166
|
*
|
|
165
|
-
* @returns Success
|
|
167
|
+
* @returns {Promise<SchemaFiles | Binary>} Success
|
|
166
168
|
*
|
|
167
169
|
* @example <caption>Code example</caption>
|
|
168
170
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -194,7 +196,7 @@ export declare class Extensions_2_0Client {
|
|
|
194
196
|
* + environment:roles:manage-settings
|
|
195
197
|
* + extensions:definitions:read
|
|
196
198
|
*
|
|
197
|
-
* @returns Success
|
|
199
|
+
* @returns {Promise<JsonNode>} Success
|
|
198
200
|
*
|
|
199
201
|
* @example <caption>Code example</caption>
|
|
200
202
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -221,7 +223,7 @@ export declare class Extensions_2_0Client {
|
|
|
221
223
|
* + environment:roles:manage-settings
|
|
222
224
|
* + extensions:definitions:read
|
|
223
225
|
*
|
|
224
|
-
* @returns Success
|
|
226
|
+
* @returns {Promise<ExtensionList>} Success
|
|
225
227
|
*
|
|
226
228
|
* @example <caption>Code example</caption>
|
|
227
229
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -261,7 +263,7 @@ export declare class Extensions_2_0Client {
|
|
|
261
263
|
* + environment:roles:manage-settings
|
|
262
264
|
* + extensions:definitions:write
|
|
263
265
|
*
|
|
264
|
-
* @returns Success. The extension 2.0 has been uploaded.
|
|
266
|
+
* @returns {Promise<RegisteredExtensionResultDto>} Success. The extension 2.0 has been uploaded.
|
|
265
267
|
*
|
|
266
268
|
* @example <caption>Code example</caption>
|
|
267
269
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -287,7 +289,7 @@ export declare class Extensions_2_0Client {
|
|
|
287
289
|
* + environment:roles:manage-settings
|
|
288
290
|
* + extensions:definitions:read
|
|
289
291
|
*
|
|
290
|
-
* @returns Success
|
|
292
|
+
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success
|
|
291
293
|
*
|
|
292
294
|
* @example <caption>Code example</caption>
|
|
293
295
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -313,7 +315,7 @@ export declare class Extensions_2_0Client {
|
|
|
313
315
|
* + environment:roles:manage-settings
|
|
314
316
|
* + extensions:definitions:write
|
|
315
317
|
*
|
|
316
|
-
* @returns Success. Environment configuration updated.
|
|
318
|
+
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success. Environment configuration updated.
|
|
317
319
|
*
|
|
318
320
|
* @example <caption>Code example</caption>
|
|
319
321
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -340,7 +342,7 @@ export declare class Extensions_2_0Client {
|
|
|
340
342
|
* + environment:roles:manage-settings
|
|
341
343
|
* + extensions:definitions:write
|
|
342
344
|
*
|
|
343
|
-
* @returns Success. Environment configuration created.
|
|
345
|
+
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success. Environment configuration created.
|
|
344
346
|
*
|
|
345
347
|
* @example <caption>Code example</caption>
|
|
346
348
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -367,7 +369,7 @@ export declare class Extensions_2_0Client {
|
|
|
367
369
|
* + environment:roles:manage-settings
|
|
368
370
|
* + extensions:definitions:write
|
|
369
371
|
*
|
|
370
|
-
* @returns Success. Environment configuration deactivated.
|
|
372
|
+
* @returns {Promise<ExtensionEnvironmentConfigurationVersion>} Success. Environment configuration deactivated.
|
|
371
373
|
*
|
|
372
374
|
* @example <caption>Code example</caption>
|
|
373
375
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -393,7 +395,7 @@ export declare class Extensions_2_0Client {
|
|
|
393
395
|
* + environment:roles:manage-settings
|
|
394
396
|
* + extensions:definitions:read
|
|
395
397
|
*
|
|
396
|
-
* @returns Success
|
|
398
|
+
* @returns {Promise<ExtensionAssetsDto>} Success
|
|
397
399
|
*
|
|
398
400
|
* @example <caption>Code example</caption>
|
|
399
401
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -423,7 +425,7 @@ export declare class Extensions_2_0Client {
|
|
|
423
425
|
*
|
|
424
426
|
* @deprecated
|
|
425
427
|
*
|
|
426
|
-
* @returns List of the latest extension environment configuration events
|
|
428
|
+
* @returns {Promise<ExtensionEventsList>} List of the latest extension environment configuration events
|
|
427
429
|
*
|
|
428
430
|
* @example <caption>Code example</caption>
|
|
429
431
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -487,7 +489,7 @@ export declare class Extensions_2_0Client {
|
|
|
487
489
|
* + environment:roles:manage-settings
|
|
488
490
|
* + extensions:configurations:read
|
|
489
491
|
*
|
|
490
|
-
* @returns Success
|
|
492
|
+
* @returns {Promise<ExtensionMonitoringConfigurationsList>} Success
|
|
491
493
|
*
|
|
492
494
|
* @example <caption>Code example</caption>
|
|
493
495
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -529,7 +531,7 @@ export declare class Extensions_2_0Client {
|
|
|
529
531
|
* + environment:roles:manage-settings
|
|
530
532
|
* + extensions:configurations:write
|
|
531
533
|
*
|
|
532
|
-
* @returns Success | Multi-Status, if not all requests resulted in the same status
|
|
534
|
+
* @returns {Promise<MonitoringConfigurationResponse[] | (MonitoringConfigurationResponse | ErrorEnvelope)[]>} Success | Multi-Status, if not all requests resulted in the same status
|
|
533
535
|
*
|
|
534
536
|
* @example <caption>Code example</caption>
|
|
535
537
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -562,7 +564,7 @@ export declare class Extensions_2_0Client {
|
|
|
562
564
|
* + environment:roles:manage-settings
|
|
563
565
|
* + extensions:configurations:read
|
|
564
566
|
*
|
|
565
|
-
* @returns Success
|
|
567
|
+
* @returns {Promise<ExtensionMonitoringConfiguration>} Success
|
|
566
568
|
*
|
|
567
569
|
* @example <caption>Code example</caption>
|
|
568
570
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -589,7 +591,7 @@ export declare class Extensions_2_0Client {
|
|
|
589
591
|
* + environment:roles:manage-settings
|
|
590
592
|
* + extensions:configurations:write
|
|
591
593
|
*
|
|
592
|
-
* @returns Success
|
|
594
|
+
* @returns {Promise<MonitoringConfigurationResponse>} Success
|
|
593
595
|
*
|
|
594
596
|
* @example <caption>Code example</caption>
|
|
595
597
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -645,7 +647,7 @@ export declare class Extensions_2_0Client {
|
|
|
645
647
|
* + environment:roles:manage-settings
|
|
646
648
|
* + extensions:configuration.actions:write
|
|
647
649
|
*
|
|
648
|
-
* @returns Accepted. Response doesn't have a body.
|
|
650
|
+
* @returns {Promise<ExecuteActionsResponse>} Accepted. Response doesn't have a body.
|
|
649
651
|
*
|
|
650
652
|
* @example <caption>Code example</caption>
|
|
651
653
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -681,7 +683,7 @@ export declare class Extensions_2_0Client {
|
|
|
681
683
|
*
|
|
682
684
|
* @deprecated
|
|
683
685
|
*
|
|
684
|
-
* @returns Success
|
|
686
|
+
* @returns {Promise<ExtensionEventsList>} Success
|
|
685
687
|
*
|
|
686
688
|
* @example <caption>Code example</caption>
|
|
687
689
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -761,7 +763,7 @@ export declare class Extensions_2_0Client {
|
|
|
761
763
|
* + environment:roles:manage-settings
|
|
762
764
|
* + extensions:configurations:read
|
|
763
765
|
*
|
|
764
|
-
* @returns Success
|
|
766
|
+
* @returns {Promise<ExtensionStatusDto>} Success
|
|
765
767
|
*
|
|
766
768
|
* @example <caption>Code example</caption>
|
|
767
769
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -788,7 +790,7 @@ export declare class Extensions_2_0Client {
|
|
|
788
790
|
* + environment:roles:manage-settings
|
|
789
791
|
* + extensions:definitions:read
|
|
790
792
|
*
|
|
791
|
-
* @returns Success
|
|
793
|
+
* @returns {Promise<Extension | Binary>} Success
|
|
792
794
|
*
|
|
793
795
|
* @example <caption>Code example</caption>
|
|
794
796
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -823,7 +825,7 @@ export declare class Extensions_2_0Client {
|
|
|
823
825
|
* + environment:roles:manage-settings
|
|
824
826
|
* + extensions:definitions:write
|
|
825
827
|
*
|
|
826
|
-
* @returns Success. The extension 2.0 version has been deleted.
|
|
828
|
+
* @returns {Promise<Extension>} Success. The extension 2.0 version has been deleted.
|
|
827
829
|
*
|
|
828
830
|
* @example <caption>Code example</caption>
|
|
829
831
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -850,7 +852,7 @@ export declare class Extensions_2_0Client {
|
|
|
850
852
|
* + environment:roles:manage-settings
|
|
851
853
|
* + extensions:configurations:write
|
|
852
854
|
*
|
|
853
|
-
* @returns Success
|
|
855
|
+
* @returns {Promise<ActiveGateGroupsInfoDto>} Success
|
|
854
856
|
*
|
|
855
857
|
* @example <caption>Code example</caption>
|
|
856
858
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -878,7 +880,7 @@ export declare class Extensions_2_0Client {
|
|
|
878
880
|
* + environment:roles:manage-settings
|
|
879
881
|
* + extensions:definitions:read
|
|
880
882
|
*
|
|
881
|
-
* @returns Success
|
|
883
|
+
* @returns {Promise<SchemaDefinitionRestDto>} Success
|
|
882
884
|
*
|
|
883
885
|
* @example <caption>Code example</caption>
|
|
884
886
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -31,7 +31,7 @@ export declare class LogsClient {
|
|
|
31
31
|
*
|
|
32
32
|
* Please note that *Dynatrace API explorer* does not currently support OAuth authentication.
|
|
33
33
|
*
|
|
34
|
-
* @returns Success
|
|
34
|
+
* @returns {Promise<AggregatedLog>} Success
|
|
35
35
|
*
|
|
36
36
|
* @example <caption>Code example</caption>
|
|
37
37
|
* import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -127,7 +127,7 @@ export declare class LogsClient {
|
|
|
127
127
|
*
|
|
128
128
|
* Disabled on *Log Management and Analytics, powered by Grail*.
|
|
129
129
|
*
|
|
130
|
-
* @returns Success
|
|
130
|
+
* @returns {Promise<ExportedLogRecordList>} Success
|
|
131
131
|
*
|
|
132
132
|
* @example <caption>Code example</caption>
|
|
133
133
|
* import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -207,7 +207,7 @@ export declare class LogsClient {
|
|
|
207
207
|
*
|
|
208
208
|
* This endpoint requires an ActiveGate with the **Log Analytics Collector** module enabled.
|
|
209
209
|
*
|
|
210
|
-
* The maximum payload size of a single request is **
|
|
210
|
+
* The maximum payload size of a single request is **10 MB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
|
|
211
211
|
*
|
|
212
212
|
* If the ingested payload is a JSON array, the maximum array size is **50000**. Requests with a greater payload are rejected, and the API returns a 413 response code.
|
|
213
213
|
*
|
|
@@ -239,7 +239,7 @@ export declare class LogsClient {
|
|
|
239
239
|
*
|
|
240
240
|
* Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
|
|
241
241
|
*
|
|
242
|
-
* @returns Only a part of input events were ingested due to event invalidity. For details, check the response body.
|
|
242
|
+
* @returns {Promise<SuccessEnvelope | void>} Only a part of input events were ingested due to event invalidity. For details, check the response body.
|
|
243
243
|
*
|
|
244
244
|
* @example <caption>Code example</caption>
|
|
245
245
|
* import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -304,7 +304,7 @@ export declare class LogsClient {
|
|
|
304
304
|
*
|
|
305
305
|
* Please note that *Dynatrace API explorer* does not currently support OAuth authentication.
|
|
306
306
|
*
|
|
307
|
-
* @returns Success
|
|
307
|
+
* @returns {Promise<LogRecordsList>} Success
|
|
308
308
|
*
|
|
309
309
|
* @example <caption>Code example</caption>
|
|
310
310
|
* import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -25,7 +25,7 @@ export declare class MetricsClient {
|
|
|
25
25
|
*
|
|
26
26
|
* 2. Then use the cursor from the **nextPageKey** field of the response in the **nextPageKey** query parameter to obtain subsequent pages. All other query parameters must be omitted.
|
|
27
27
|
*
|
|
28
|
-
* @returns Success
|
|
28
|
+
* @returns {Promise<MetricDescriptorCollection>} Success
|
|
29
29
|
*
|
|
30
30
|
* @example <caption>Code example</caption>
|
|
31
31
|
* import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -158,7 +158,7 @@ export declare class MetricsClient {
|
|
|
158
158
|
*
|
|
159
159
|
* **Required scope:** storage:metrics:write<br/>**Required permission:** storage:metrics:write
|
|
160
160
|
*
|
|
161
|
-
* @returns The provided metric data points are accepted and will be processed in the background.
|
|
161
|
+
* @returns {Promise<ValidationResponse>} The provided metric data points are accepted and will be processed in the background.
|
|
162
162
|
*
|
|
163
163
|
* @example <caption>Code example</caption>
|
|
164
164
|
* import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -189,7 +189,7 @@ export declare class MetricsClient {
|
|
|
189
189
|
* The **dataPointCountRatio** specifies the ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query.
|
|
190
190
|
* The **dimensionCountRatio** specifies the ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
|
|
191
191
|
*
|
|
192
|
-
* @returns Success
|
|
192
|
+
* @returns {Promise<MetricData>} Success
|
|
193
193
|
*
|
|
194
194
|
* @example <caption>Code example</caption>
|
|
195
195
|
* import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -337,7 +337,7 @@ export declare class MetricsClient {
|
|
|
337
337
|
*
|
|
338
338
|
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
|
|
339
339
|
*
|
|
340
|
-
* @returns Success
|
|
340
|
+
* @returns {Promise<MetricDescriptor>} Success
|
|
341
341
|
*
|
|
342
342
|
* @example <caption>Code example</caption>
|
|
343
343
|
* import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -18,7 +18,7 @@ export declare class MetricsUnitsClient {
|
|
|
18
18
|
*
|
|
19
19
|
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can narrow down the output by providing filter criteria in the **unitSelector** field.
|
|
20
20
|
*
|
|
21
|
-
* @returns Success
|
|
21
|
+
* @returns {Promise<UnitList>} Success
|
|
22
22
|
*
|
|
23
23
|
* @example <caption>Code example</caption>
|
|
24
24
|
* import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -57,7 +57,7 @@ export declare class MetricsUnitsClient {
|
|
|
57
57
|
*
|
|
58
58
|
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
|
|
59
59
|
*
|
|
60
|
-
* @returns Success
|
|
60
|
+
* @returns {Promise<Unit>} Success
|
|
61
61
|
*
|
|
62
62
|
* @example <caption>Code example</caption>
|
|
63
63
|
* import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -80,7 +80,7 @@ export declare class MetricsUnitsClient {
|
|
|
80
80
|
*
|
|
81
81
|
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
|
|
82
82
|
*
|
|
83
|
-
* @returns Success
|
|
83
|
+
* @returns {Promise<UnitConversionResult>} Success
|
|
84
84
|
*
|
|
85
85
|
* @example <caption>Code example</caption>
|
|
86
86
|
* import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts
CHANGED
|
@@ -33,7 +33,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
33
33
|
* 1. Specify the number of results per page in the **pageSize** query parameter.
|
|
34
34
|
* 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
|
|
35
35
|
*
|
|
36
|
-
* @returns Success
|
|
36
|
+
* @returns {Promise<EntitiesList>} Success
|
|
37
37
|
*
|
|
38
38
|
* @example <caption>Code example</caption>
|
|
39
39
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -154,7 +154,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
154
154
|
*
|
|
155
155
|
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
|
|
156
156
|
*
|
|
157
|
-
* @returns Success
|
|
157
|
+
* @returns {Promise<CustomDeviceCreationResult | void>} Success
|
|
158
158
|
*
|
|
159
159
|
* @example <caption>Code example</caption>
|
|
160
160
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -184,7 +184,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
184
184
|
* This endpoint does not create a new management zone, if there is no management zone with the provided name.
|
|
185
185
|
* Automatic management zone rules will not apply to entities with a set security context. It will need to be removed, to have them apply again.
|
|
186
186
|
*
|
|
187
|
-
* @returns Success
|
|
187
|
+
* @returns {Promise<SecurityContextResultDto>} Success
|
|
188
188
|
*
|
|
189
189
|
* @example <caption>Code example</caption>
|
|
190
190
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -284,7 +284,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
284
284
|
*
|
|
285
285
|
* <br/><br/>Automatic management zone rules will apply again to entities without a security context.
|
|
286
286
|
*
|
|
287
|
-
* @returns Success
|
|
287
|
+
* @returns {Promise<SecurityContextResultDto>} Success
|
|
288
288
|
*
|
|
289
289
|
* @example <caption>Code example</caption>
|
|
290
290
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -378,7 +378,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
378
378
|
*
|
|
379
379
|
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer
|
|
380
380
|
*
|
|
381
|
-
* @returns Success
|
|
381
|
+
* @returns {Promise<Entity>} Success
|
|
382
382
|
*
|
|
383
383
|
* @example <caption>Code example</caption>
|
|
384
384
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -448,7 +448,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
448
448
|
* 1. Specify the number of results per page in the **pageSize** query parameter.
|
|
449
449
|
* 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
|
|
450
450
|
*
|
|
451
|
-
* @returns Success
|
|
451
|
+
* @returns {Promise<EntityTypeList>} Success
|
|
452
452
|
*
|
|
453
453
|
* @example <caption>Code example</caption>
|
|
454
454
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -482,7 +482,7 @@ export declare class MonitoredEntitiesClient {
|
|
|
482
482
|
*
|
|
483
483
|
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer
|
|
484
484
|
*
|
|
485
|
-
* @returns Success
|
|
485
|
+
* @returns {Promise<EntityType>} Success
|
|
486
486
|
*
|
|
487
487
|
* @example <caption>Code example</caption>
|
|
488
488
|
* import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -19,7 +19,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
19
19
|
*
|
|
20
20
|
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Automatically applied tags and imported tags are not included.
|
|
21
21
|
*
|
|
22
|
-
* @returns Success
|
|
22
|
+
* @returns {Promise<CustomEntityTags>} Success
|
|
23
23
|
*
|
|
24
24
|
* @example <caption>Code example</caption>
|
|
25
25
|
* import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -113,7 +113,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
113
113
|
*
|
|
114
114
|
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>All existing tags remain unaffected.
|
|
115
115
|
*
|
|
116
|
-
* @returns Success
|
|
116
|
+
* @returns {Promise<AddedEntityTags>} Success
|
|
117
117
|
*
|
|
118
118
|
* @example <caption>Code example</caption>
|
|
119
119
|
* import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -209,7 +209,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
209
209
|
*
|
|
210
210
|
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
|
|
211
211
|
*
|
|
212
|
-
* @returns Success
|
|
212
|
+
* @returns {Promise<DeletedEntityTags>} Success
|
|
213
213
|
*
|
|
214
214
|
* @example <caption>Code example</caption>
|
|
215
215
|
* import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -16,7 +16,7 @@ export declare class MonitoredEntitiesMonitoringStateClient {
|
|
|
16
16
|
*
|
|
17
17
|
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Only process group instances are supported.
|
|
18
18
|
*
|
|
19
|
-
* @returns Success
|
|
19
|
+
* @returns {Promise<MonitoredStates>} Success
|
|
20
20
|
*
|
|
21
21
|
* @example <caption>Code example</caption>
|
|
22
22
|
* import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -21,7 +21,7 @@ export declare class NetworkZonesClient {
|
|
|
21
21
|
*
|
|
22
22
|
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
23
23
|
*
|
|
24
|
-
* @returns Success
|
|
24
|
+
* @returns {Promise<NetworkZoneSettings>} Success
|
|
25
25
|
*
|
|
26
26
|
* @example <caption>Code example</caption>
|
|
27
27
|
* import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -34,7 +34,9 @@ export declare class NetworkZonesClient {
|
|
|
34
34
|
* @throws {ApiClientError}
|
|
35
35
|
* @throws {ClientRequestError}
|
|
36
36
|
*/
|
|
37
|
-
getNetworkZoneSettings(
|
|
37
|
+
getNetworkZoneSettings(config?: {
|
|
38
|
+
abortSignal?: AbortSignal;
|
|
39
|
+
} | AbortSignal): Promise<NetworkZoneSettings>;
|
|
38
40
|
/**
|
|
39
41
|
* Updates the global configuration of network zones
|
|
40
42
|
*
|
|
@@ -62,7 +64,7 @@ export declare class NetworkZonesClient {
|
|
|
62
64
|
*
|
|
63
65
|
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
64
66
|
*
|
|
65
|
-
* @returns Success
|
|
67
|
+
* @returns {Promise<NetworkZoneList>} Success
|
|
66
68
|
*
|
|
67
69
|
* @example <caption>Code example</caption>
|
|
68
70
|
* import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -74,13 +76,15 @@ export declare class NetworkZonesClient {
|
|
|
74
76
|
* @throws {ApiClientError}
|
|
75
77
|
* @throws {ClientRequestError}
|
|
76
78
|
*/
|
|
77
|
-
getAllNetworkZones(
|
|
79
|
+
getAllNetworkZones(config?: {
|
|
80
|
+
abortSignal?: AbortSignal;
|
|
81
|
+
} | AbortSignal): Promise<NetworkZoneList>;
|
|
78
82
|
/**
|
|
79
83
|
* Gets parameters of the specified network zone
|
|
80
84
|
*
|
|
81
85
|
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
82
86
|
*
|
|
83
|
-
* @returns Success
|
|
87
|
+
* @returns {Promise<NetworkZone>} Success
|
|
84
88
|
*
|
|
85
89
|
* @example <caption>Code example</caption>
|
|
86
90
|
* import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -105,7 +109,7 @@ export declare class NetworkZonesClient {
|
|
|
105
109
|
*
|
|
106
110
|
* The ID is not case sensitive. Dynatrace stores the ID in lowercase.
|
|
107
111
|
*
|
|
108
|
-
* @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
|
|
112
|
+
* @returns {Promise<EntityShortRepresentation | void>} Success. The new network zone has been created. The response body contains the ID of the new network zone.
|
|
109
113
|
*
|
|
110
114
|
* @example <caption>Code example</caption>
|
|
111
115
|
* import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -160,7 +164,7 @@ export declare class NetworkZonesClient {
|
|
|
160
164
|
*
|
|
161
165
|
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:manage-settings
|
|
162
166
|
*
|
|
163
|
-
* @returns Success
|
|
167
|
+
* @returns {Promise<NetworkZoneConnectionStatistics>} Success
|
|
164
168
|
*
|
|
165
169
|
* @example <caption>Code example</caption>
|
|
166
170
|
* import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -22,7 +22,7 @@ export declare class ProblemsClient {
|
|
|
22
22
|
*
|
|
23
23
|
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
24
24
|
*
|
|
25
|
-
* @returns Success
|
|
25
|
+
* @returns {Promise<Problems>} Success
|
|
26
26
|
*
|
|
27
27
|
* @example <caption>Code example</caption>
|
|
28
28
|
* import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -177,7 +177,7 @@ export declare class ProblemsClient {
|
|
|
177
177
|
*
|
|
178
178
|
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
179
179
|
*
|
|
180
|
-
* @returns Success
|
|
180
|
+
* @returns {Promise<Problem>} Success
|
|
181
181
|
*
|
|
182
182
|
* @example <caption>Code example</caption>
|
|
183
183
|
* import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -211,7 +211,7 @@ export declare class ProblemsClient {
|
|
|
211
211
|
*
|
|
212
212
|
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
213
213
|
*
|
|
214
|
-
* @returns Success
|
|
214
|
+
* @returns {Promise<ProblemCloseResult | void>} Success
|
|
215
215
|
*
|
|
216
216
|
* @example <caption>Code example</caption>
|
|
217
217
|
* import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -236,7 +236,7 @@ export declare class ProblemsClient {
|
|
|
236
236
|
*
|
|
237
237
|
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
238
238
|
*
|
|
239
|
-
* @returns Success
|
|
239
|
+
* @returns {Promise<CommentsList>} Success
|
|
240
240
|
*
|
|
241
241
|
* @example <caption>Code example</caption>
|
|
242
242
|
* import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -296,7 +296,7 @@ export declare class ProblemsClient {
|
|
|
296
296
|
*
|
|
297
297
|
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
298
298
|
*
|
|
299
|
-
* @returns Success
|
|
299
|
+
* @returns {Promise<Comment>} Success
|
|
300
300
|
*
|
|
301
301
|
* @example <caption>Code example</caption>
|
|
302
302
|
* import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -16,7 +16,7 @@ export declare class ReleasesClient {
|
|
|
16
16
|
*
|
|
17
17
|
* **Required scope:** environment-api:releases:read<br/>**Required permission:** environment:roles:viewer
|
|
18
18
|
*
|
|
19
|
-
* @returns Success
|
|
19
|
+
* @returns {Promise<Releases>} Success
|
|
20
20
|
*
|
|
21
21
|
* @example <caption>Code example</caption>
|
|
22
22
|
* import { releasesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|