@dynatrace-sdk/client-classic-environment-v2 0.6.7 → 0.6.11
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 +30 -0
- package/LICENSE +174 -0
- package/README.md +39 -0
- package/cjs/index.js +3976 -1164
- package/docs/DOCS.md +9780 -4761
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3977 -1164
- package/package.json +3 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +14 -10
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +3 -3
- 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 +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +6 -6
- 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/credential-vault-api.d.ts +12 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +24 -16
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +34 -23
- package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts +162 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +13 -12
- 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 +31 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +21 -21
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +59 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +14 -14
- 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 +85 -20
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +4 -0
- 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 +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-created.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-schema-details-dto.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/category-list.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/category.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/comment.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/comments-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/configuration-metadata.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint-violation-parameter-location.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-id.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-dto.d.ts +38 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts +43 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block-type.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts +36 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +16 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-values-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-icon.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-type.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-results.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-properties-list.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +13 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/execution-simple-results.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/exported-log-record-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-assets-dto.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-feature-sets.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-notes.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts +81 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts +33 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-source-auth-method.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-type.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-source-auth-method.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +9 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/filtered-counts-dto.d.ts +77 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/global-counts-dto.d.ts +72 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +60 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts +98 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-list.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview.d.ts +85 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/list-items-query-item-type.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +5 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-data.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +43 -43
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-cardinality.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-state-param.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-severity.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +50 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +29 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.d.ts +23 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone-fallback-mode.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +6 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/objects-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +16 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/models/registered-extension-result-dto.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item.d.ts +36 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/release-instance.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/models/releases.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary-reason.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-reason.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-reason.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary-reason.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-events-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-reason.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-reason.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +20 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +16 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +26 -21
- package/types/packages/client/classic-environment-v2/src/lib/models/sl-os.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +24 -24
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +36 -36
- package/types/packages/client/classic-environment-v2/src/lib/models/software-techs.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-execution-stage.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-processing-mode.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-custom-script.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +4 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/technology-details.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +15 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/upload-metadata-for-extension-body.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-detail.d.ts +0 -32
- package/types/packages/client/classic-environment-v2/src/lib/models/upload-extension-body.d.ts +0 -18
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
2
|
import { ErrorEnvelope } from '../models/error-envelope';
|
|
3
3
|
import { Extension } from '../models/extension';
|
|
4
|
+
import { ExtensionAssetsDto } from '../models/extension-assets-dto';
|
|
4
5
|
import { ExtensionEnvironmentConfigurationVersion } from '../models/extension-environment-configuration-version';
|
|
5
6
|
import { ExtensionEventsList } from '../models/extension-events-list';
|
|
6
7
|
import { ExtensionList } from '../models/extension-list';
|
|
@@ -17,7 +18,6 @@ import { MonitoringConfigurationUpdateDto } from '../models/monitoring-configura
|
|
|
17
18
|
import { SchemaDefinitionRestDto } from '../models/schema-definition-rest-dto';
|
|
18
19
|
import { SchemaFiles } from '../models/schema-files';
|
|
19
20
|
import { SchemasList } from '../models/schemas-list';
|
|
20
|
-
import { UploadExtensionBody } from '../models/upload-extension-body';
|
|
21
21
|
/**
|
|
22
22
|
* Manage Extensions 2.0 life cycle
|
|
23
23
|
*/
|
|
@@ -32,7 +32,7 @@ export declare class Extensions_2_0Client {
|
|
|
32
32
|
/**
|
|
33
33
|
* Gets the active environment configuration version of the specified extension 2.0
|
|
34
34
|
*
|
|
35
|
-
* **Required scope:** environment-api:extensions:read
|
|
35
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
36
36
|
* @returns Success
|
|
37
37
|
*/
|
|
38
38
|
getActiveEnvironmentConfiguration(config: {
|
|
@@ -42,7 +42,7 @@ export declare class Extensions_2_0Client {
|
|
|
42
42
|
/**
|
|
43
43
|
* Updates the active environment configuration version of the extension 2.0
|
|
44
44
|
*
|
|
45
|
-
* **Required scope:** environment-api:extensions:write
|
|
45
|
+
* **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
|
|
46
46
|
* @returns Success. Environment configuration updated.
|
|
47
47
|
*/
|
|
48
48
|
updateExtensionEnvironmentConfiguration(config: {
|
|
@@ -53,7 +53,7 @@ export declare class Extensions_2_0Client {
|
|
|
53
53
|
/**
|
|
54
54
|
* Activates the environment configuration from the specified version of the extension 2.0
|
|
55
55
|
*
|
|
56
|
-
* **Required scope:** environment-api:extensions:write
|
|
56
|
+
* **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
|
|
57
57
|
* @returns Success. Environment configuration created.
|
|
58
58
|
*/
|
|
59
59
|
activateExtensionEnvironmentConfiguration(config: {
|
|
@@ -64,7 +64,7 @@ export declare class Extensions_2_0Client {
|
|
|
64
64
|
/**
|
|
65
65
|
* Deactivates the environment configuration of the specified extension 2.0
|
|
66
66
|
*
|
|
67
|
-
* **Required scope:** environment-api:extensions:write
|
|
67
|
+
* **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
|
|
68
68
|
* @returns Success. Environment configuration deactivated.
|
|
69
69
|
*/
|
|
70
70
|
deleteEnvironmentConfiguration(config: {
|
|
@@ -74,7 +74,7 @@ export declare class Extensions_2_0Client {
|
|
|
74
74
|
/**
|
|
75
75
|
* Lists all the monitoring configurations of the specified extension 2.0
|
|
76
76
|
*
|
|
77
|
-
* **Required scope:** environment-api:extension-configurations:read
|
|
77
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
|
|
78
78
|
* @returns Success
|
|
79
79
|
*/
|
|
80
80
|
extensionMonitoringConfigurations(config: {
|
|
@@ -100,7 +100,7 @@ export declare class Extensions_2_0Client {
|
|
|
100
100
|
/**
|
|
101
101
|
* Creates new monitoring configuration for the specified extension 2.0
|
|
102
102
|
*
|
|
103
|
-
* **Required scope:** environment-api:extension-configurations:write
|
|
103
|
+
* **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
|
|
104
104
|
* @returns Success | Multi-Status, if not all requests resulted in the same status
|
|
105
105
|
*/
|
|
106
106
|
createMonitoringConfiguration(config: {
|
|
@@ -116,7 +116,7 @@ export declare class Extensions_2_0Client {
|
|
|
116
116
|
/**
|
|
117
117
|
* Gets the configuration schema of the specified version of the extension 2.0
|
|
118
118
|
*
|
|
119
|
-
* **Required scope:** environment-api:extension-configurations:read
|
|
119
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
|
|
120
120
|
* @returns Success
|
|
121
121
|
*/
|
|
122
122
|
extensionConfigurationSchema(config: {
|
|
@@ -127,7 +127,7 @@ export declare class Extensions_2_0Client {
|
|
|
127
127
|
/**
|
|
128
128
|
* Gets details of the specified version of the extension 2.0
|
|
129
129
|
*
|
|
130
|
-
* **Required scope:** environment-api:extensions:read
|
|
130
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
131
131
|
* @returns Success
|
|
132
132
|
*/
|
|
133
133
|
extensionDetails(config: {
|
|
@@ -139,7 +139,7 @@ export declare class Extensions_2_0Client {
|
|
|
139
139
|
/**
|
|
140
140
|
* Deletes the specified version of the extension 2.0
|
|
141
141
|
*
|
|
142
|
-
* **Required scope:** environment-api:extensions:write
|
|
142
|
+
* **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
|
|
143
143
|
* @returns Success. The extension 2.0 version has been deleted.
|
|
144
144
|
*/
|
|
145
145
|
removeExtension(config: {
|
|
@@ -147,10 +147,20 @@ export declare class Extensions_2_0Client {
|
|
|
147
147
|
/** The version of the requested extension 2.0 */ extensionVersion: string;
|
|
148
148
|
abortSignal?: AbortSignal;
|
|
149
149
|
}): Promise<Extension>;
|
|
150
|
+
/**
|
|
151
|
+
* Gets the information about assets in an active extension 2.0
|
|
152
|
+
*
|
|
153
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
154
|
+
* @returns Success
|
|
155
|
+
*/
|
|
156
|
+
getEnvironmentConfigurationAssetsInfo(config: {
|
|
157
|
+
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
158
|
+
abortSignal?: AbortSignal;
|
|
159
|
+
}): Promise<ExtensionAssetsDto>;
|
|
150
160
|
/**
|
|
151
161
|
* List of the latest extension environment configuration events
|
|
152
162
|
*
|
|
153
|
-
* **Required scope:** environment-api:extensions:read
|
|
163
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
154
164
|
* @returns List of the latest extension environment configuration events
|
|
155
165
|
*/
|
|
156
166
|
getEnvironmentConfigurationEvents(config: {
|
|
@@ -198,7 +208,7 @@ export declare class Extensions_2_0Client {
|
|
|
198
208
|
/**
|
|
199
209
|
* Gets the list of the events linked to specific monitoring configuration
|
|
200
210
|
*
|
|
201
|
-
* **Required scope:** environment-api:extension-configurations:read
|
|
211
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
|
|
202
212
|
* @returns Success
|
|
203
213
|
*/
|
|
204
214
|
getExtensionMonitoringConfigurationEvents(config: {
|
|
@@ -262,7 +272,7 @@ export declare class Extensions_2_0Client {
|
|
|
262
272
|
/**
|
|
263
273
|
* Gets the most recent status of the execution of given monitoring configuration
|
|
264
274
|
*
|
|
265
|
-
* **Required scope:** environment-api:extension-configurations:read
|
|
275
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
|
|
266
276
|
* @returns Success
|
|
267
277
|
*/
|
|
268
278
|
getExtensionMonitoringConfigurationStatus(config: {
|
|
@@ -273,7 +283,7 @@ export declare class Extensions_2_0Client {
|
|
|
273
283
|
/**
|
|
274
284
|
* Gets the extension 2.0 schema file in the specified version
|
|
275
285
|
*
|
|
276
|
-
* **Required scope:** environment-api:extensions:read
|
|
286
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
277
287
|
* @returns Success
|
|
278
288
|
*/
|
|
279
289
|
getSchemaFile(config: {
|
|
@@ -284,7 +294,7 @@ export declare class Extensions_2_0Client {
|
|
|
284
294
|
/**
|
|
285
295
|
* Lists all versions of the extension 2.0
|
|
286
296
|
*
|
|
287
|
-
* **Required scope:** environment-api:extensions:read
|
|
297
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
288
298
|
* @returns Success
|
|
289
299
|
*/
|
|
290
300
|
listExtensionVersions(config: {
|
|
@@ -308,7 +318,7 @@ export declare class Extensions_2_0Client {
|
|
|
308
318
|
/**
|
|
309
319
|
* Lists all the extensions 2.0 available in your environment
|
|
310
320
|
*
|
|
311
|
-
* **Required scope:** environment-api:extensions:read
|
|
321
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
312
322
|
* @returns Success
|
|
313
323
|
*/
|
|
314
324
|
listExtensions(config: {
|
|
@@ -332,18 +342,19 @@ export declare class Extensions_2_0Client {
|
|
|
332
342
|
/**
|
|
333
343
|
* Uploads or verifies a new extension 2.0
|
|
334
344
|
*
|
|
335
|
-
* **Required scope:** environment-api:extensions:write
|
|
345
|
+
* **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
|
|
336
346
|
* @returns The extension is valid | Success. The extension 2.0 has been uploaded.
|
|
337
347
|
*/
|
|
338
348
|
uploadExtension(config: {
|
|
339
|
-
body:
|
|
349
|
+
body: Blob;
|
|
350
|
+
type: 'application/octet-stream' | 'multipart/form-data';
|
|
340
351
|
/** Only run validation but do not persist the extension even if validation was successful. */ validateOnly?: boolean;
|
|
341
352
|
abortSignal?: AbortSignal;
|
|
342
353
|
}): Promise<ExtensionUploadResponseDto>;
|
|
343
354
|
/**
|
|
344
355
|
* Lists all the files available for the specified extension 2.0 schema version
|
|
345
356
|
*
|
|
346
|
-
* **Required scope:** environment-api:extensions:read
|
|
357
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
347
358
|
* @returns Success
|
|
348
359
|
*/
|
|
349
360
|
listSchemaFiles(config: {
|
|
@@ -354,14 +365,14 @@ export declare class Extensions_2_0Client {
|
|
|
354
365
|
/**
|
|
355
366
|
* Lists all the extension 2.0 schemas versions available in your environment
|
|
356
367
|
*
|
|
357
|
-
* **Required scope:** environment-api:extensions:read
|
|
368
|
+
* **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
|
|
358
369
|
* @returns Success
|
|
359
370
|
*/
|
|
360
371
|
listSchemas(abortSignal?: AbortSignal): Promise<SchemasList>;
|
|
361
372
|
/**
|
|
362
373
|
* Gets the details of the specified monitoring configuration
|
|
363
374
|
*
|
|
364
|
-
* **Required scope:** environment-api:extension-configurations:read
|
|
375
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
|
|
365
376
|
* @returns Success
|
|
366
377
|
*/
|
|
367
378
|
monitoringConfigurationDetails(config: {
|
|
@@ -372,7 +383,7 @@ export declare class Extensions_2_0Client {
|
|
|
372
383
|
/**
|
|
373
384
|
* Updates the specified monitoring configuration
|
|
374
385
|
*
|
|
375
|
-
* **Required scope:** environment-api:extension-configurations:write
|
|
386
|
+
* **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
|
|
376
387
|
* @returns Success
|
|
377
388
|
*/
|
|
378
389
|
updateMonitoringConfiguration(config: {
|
|
@@ -384,7 +395,7 @@ export declare class Extensions_2_0Client {
|
|
|
384
395
|
/**
|
|
385
396
|
* Deletes the specified monitoring configuration
|
|
386
397
|
*
|
|
387
|
-
* **Required scope:** environment-api:extension-configurations:write
|
|
398
|
+
* **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
|
|
388
399
|
*/
|
|
389
400
|
removeMonitoringConfiguration(config: {
|
|
390
401
|
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
|
+
import { CategoryList } from '../models/category-list';
|
|
3
|
+
import { ExtensionReleaseNotes } from '../models/extension-release-notes';
|
|
4
|
+
import { ItemDetails } from '../models/item-details';
|
|
5
|
+
import { ItemList } from '../models/item-list';
|
|
6
|
+
import { ListItemsQueryItemType } from '../models/list-items-query-item-type';
|
|
7
|
+
import { RegisteredExtensionResultDto } from '../models/registered-extension-result-dto';
|
|
8
|
+
import { UploadMetadataForExtensionBody } from '../models/upload-metadata-for-extension-body';
|
|
9
|
+
/**
|
|
10
|
+
* Install, update and manage metadata of Hub items
|
|
11
|
+
*/
|
|
12
|
+
export declare class HubItemsClient {
|
|
13
|
+
private httpClient;
|
|
14
|
+
/**
|
|
15
|
+
* @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a HubItemsClient. Custom http client should implement {HttpClient} interface.
|
|
16
|
+
* @example
|
|
17
|
+
* const queryClientNodeJs = new QueryClient(yourCustomImplementation);
|
|
18
|
+
*/
|
|
19
|
+
constructor(httpClientImplementation: HttpClient);
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves the image associated with the given url.
|
|
22
|
+
* Can only obtain images used in hub items.
|
|
23
|
+
*
|
|
24
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
25
|
+
*/
|
|
26
|
+
getImage(config: {
|
|
27
|
+
encodedUrl: string;
|
|
28
|
+
abortSignal?: AbortSignal;
|
|
29
|
+
}): Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* Lists all the available category groupings of items
|
|
32
|
+
*
|
|
33
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
34
|
+
* @returns OK
|
|
35
|
+
*/
|
|
36
|
+
listCategories(abortSignal?: AbortSignal): Promise<CategoryList>;
|
|
37
|
+
/**
|
|
38
|
+
* Registers the given extension version in the environment (using the recommended version if no other release is registered)
|
|
39
|
+
*
|
|
40
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
41
|
+
* @returns OK
|
|
42
|
+
*/
|
|
43
|
+
addToEnvironment(config: {
|
|
44
|
+
/** Fully qualified name of the extension */ extensionName: string;
|
|
45
|
+
/** Version of the extension. Fallback to the evaluated recommended version when the version is not provided */ extensionVersion?: string;
|
|
46
|
+
abortSignal?: AbortSignal;
|
|
47
|
+
}): Promise<RegisteredExtensionResultDto>;
|
|
48
|
+
/**
|
|
49
|
+
* The details of the given extension
|
|
50
|
+
*
|
|
51
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
52
|
+
* @returns OK
|
|
53
|
+
*/
|
|
54
|
+
getExtensionDetails(config: {
|
|
55
|
+
/** Fully qualified name of the extension */ extensionName: string;
|
|
56
|
+
abortSignal?: AbortSignal;
|
|
57
|
+
}): Promise<ItemDetails>;
|
|
58
|
+
/**
|
|
59
|
+
* Updates the given extension to the latest compatible published version
|
|
60
|
+
*
|
|
61
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
62
|
+
* @returns OK
|
|
63
|
+
*/
|
|
64
|
+
update(config: {
|
|
65
|
+
/** Fully qualified name of the extension */ extensionName: string;
|
|
66
|
+
/** Version of the extension. Fallback to the evaluated recommended version when the version is not provided */ extensionVersion?: string;
|
|
67
|
+
abortSignal?: AbortSignal;
|
|
68
|
+
}): Promise<RegisteredExtensionResultDto>;
|
|
69
|
+
/**
|
|
70
|
+
* Sets or updates the release notes of the specified extension release
|
|
71
|
+
*
|
|
72
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
73
|
+
*/
|
|
74
|
+
updateReleaseNotes(config: {
|
|
75
|
+
body: ExtensionReleaseNotes;
|
|
76
|
+
/** Fully qualified name of the extension */ extensionName: string;
|
|
77
|
+
/** Version of the extension release */ version: string;
|
|
78
|
+
abortSignal?: AbortSignal;
|
|
79
|
+
}): Promise<void>;
|
|
80
|
+
/**
|
|
81
|
+
* Create/Replace metadata for an extension that does not have Dynatrace distributed metadata.
|
|
82
|
+
*
|
|
83
|
+
* **Required scope:** environment-api:hub:write<br/>**Required permission:** environment:roles:manage-settings
|
|
84
|
+
*/
|
|
85
|
+
uploadMetadataForExtension(config: {
|
|
86
|
+
body: UploadMetadataForExtensionBody;
|
|
87
|
+
/** Fully qualified name of the extension */ extensionName: string;
|
|
88
|
+
abortSignal?: AbortSignal;
|
|
89
|
+
}): Promise<void>;
|
|
90
|
+
/**
|
|
91
|
+
* Artifact of the given version of an item
|
|
92
|
+
*
|
|
93
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
94
|
+
* @returns Ok - download file
|
|
95
|
+
*/
|
|
96
|
+
getArtifact(config: {
|
|
97
|
+
/** Fully qualified name of the extension1/plugin */ extension1Fqn: string;
|
|
98
|
+
/** Version of the release of the extension1/plugin */ version: string;
|
|
99
|
+
abortSignal?: AbortSignal;
|
|
100
|
+
}): Promise<void>;
|
|
101
|
+
/**
|
|
102
|
+
* The details of the given extension version 1
|
|
103
|
+
*
|
|
104
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
105
|
+
* @returns OK
|
|
106
|
+
*/
|
|
107
|
+
getDetails(config: {
|
|
108
|
+
/** Fully qualified name of the extension1/plugin */ extension1Fqn: string;
|
|
109
|
+
abortSignal?: AbortSignal;
|
|
110
|
+
}): Promise<ItemDetails>;
|
|
111
|
+
/**
|
|
112
|
+
* The details of the given technology
|
|
113
|
+
*
|
|
114
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
115
|
+
* @returns OK
|
|
116
|
+
*/
|
|
117
|
+
getTechnologyDetails(config: {
|
|
118
|
+
/** Slug of the technology to be fetched */ slug: string;
|
|
119
|
+
abortSignal?: AbortSignal;
|
|
120
|
+
}): Promise<ItemDetails>;
|
|
121
|
+
/**
|
|
122
|
+
* Lists all the available items in your environment
|
|
123
|
+
*
|
|
124
|
+
* **Required scope:** environment-api:hub:read<br/>**Required permission:** environment:roles:viewer
|
|
125
|
+
* @returns OK
|
|
126
|
+
*/
|
|
127
|
+
listItems(config: {
|
|
128
|
+
/**
|
|
129
|
+
* The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
|
|
130
|
+
*
|
|
131
|
+
* The first page is always returned if you don't specify the **nextPageKey** query parameter.
|
|
132
|
+
*
|
|
133
|
+
* When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
|
|
134
|
+
*/ nextPageKey?: string;
|
|
135
|
+
/**
|
|
136
|
+
* The amount of hub items in a single response payload.
|
|
137
|
+
*
|
|
138
|
+
* The maximal allowed page size is 100.
|
|
139
|
+
*
|
|
140
|
+
* If not set, 20 is used.
|
|
141
|
+
*/ pageSize?: number;
|
|
142
|
+
/** If provided, will filter out results based on the given item type. */ itemType?: ListItemsQueryItemType;
|
|
143
|
+
/**
|
|
144
|
+
* Filter the results for items matching the query string within id, name, author, description or any tag.
|
|
145
|
+
* - Case insensitive
|
|
146
|
+
* - Spaces in the query string will lead to an intersection of the results of each term
|
|
147
|
+
*/ query?: string;
|
|
148
|
+
/**
|
|
149
|
+
* If provided, will restrict the result to Extensions 2.0 that have the respective installed state.
|
|
150
|
+
* - Only applies if itemType filter is not set or EXTENSION2
|
|
151
|
+
*/ installed?: boolean;
|
|
152
|
+
/**
|
|
153
|
+
* If provided, will filter items that belong to the given category.
|
|
154
|
+
* - This overrides the itemType or installed filters
|
|
155
|
+
* - For a list of category ids refer to /categories
|
|
156
|
+
* - Will return the items in the order of the category
|
|
157
|
+
*/ categoryId?: string;
|
|
158
|
+
/** If provided, will skip the desired number of results, allowing for pagination in combination with page size */ offset?: string;
|
|
159
|
+
abortSignal?: AbortSignal;
|
|
160
|
+
}): Promise<ItemList>;
|
|
161
|
+
}
|
|
162
|
+
export declare const hubItemsClient: HubItemsClient;
|
|
@@ -9,11 +9,13 @@ export * from './credential-vault-api';
|
|
|
9
9
|
export * from './davis-security-advisor-api';
|
|
10
10
|
export * from './events-api';
|
|
11
11
|
export * from './extensions-2-0-api';
|
|
12
|
+
export * from './hub-items-api';
|
|
12
13
|
export * from './logs-api';
|
|
13
14
|
export * from './metrics-api';
|
|
14
15
|
export * from './metrics-units-api';
|
|
15
16
|
export * from './monitored-entities-api';
|
|
16
17
|
export * from './monitored-entities-custom-tags-api';
|
|
18
|
+
export * from './monitored-entities-monitoring-state-api';
|
|
17
19
|
export * from './network-zones-api';
|
|
18
20
|
export * from './problems-api';
|
|
19
21
|
export * from './releases-api';
|
|
@@ -19,23 +19,23 @@ export declare class LogsClient {
|
|
|
19
19
|
/**
|
|
20
20
|
* Pushes log records to Dynatrace | maturity=EARLY_ADOPTER
|
|
21
21
|
*
|
|
22
|
-
* **Required scope:** storage:logs:write<br/><br/>Ingested logs are stored in the indexed log storage.
|
|
22
|
+
* **Required scope:** storage:logs:write<br/>**Required permission:** storage:logs:write<br/><br/>Ingested logs are stored in the indexed log storage.
|
|
23
23
|
*
|
|
24
24
|
* This endpoint requires an ActiveGate with the **Log Analytics Collector** module enabled.
|
|
25
25
|
*
|
|
26
26
|
* The maximum payload size of a single request is **5 MB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
|
|
27
27
|
*
|
|
28
|
-
* If the ingested payload is a JSON array, the maximum array size is **
|
|
28
|
+
* 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.
|
|
29
29
|
*
|
|
30
30
|
* <br />**Log events per minute (SaaS)**:
|
|
31
31
|
*
|
|
32
|
-
*
|
|
32
|
+
* Grail tenants: no limit, other tenants: 1M per minute by default.
|
|
33
33
|
*
|
|
34
34
|
* If your log data stream within your cluster exceeds the limit, all log events above the limit are ignored.
|
|
35
35
|
*
|
|
36
36
|
* <br />**Log events per minute (Managed)**:
|
|
37
37
|
*
|
|
38
|
-
*
|
|
38
|
+
* 1k/minute per cluster by default.
|
|
39
39
|
*
|
|
40
40
|
* If your log data stream within your cluster exceeds the limit, all log events above the limit are ignored.
|
|
41
41
|
*
|
|
@@ -54,7 +54,7 @@ export declare class LogsClient {
|
|
|
54
54
|
* **High-cardinality attributes:**
|
|
55
55
|
*
|
|
56
56
|
* 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.
|
|
57
|
-
* @returns Only a part of input events were ingested due to event
|
|
57
|
+
* @returns Only a part of input events were ingested due to event invalidity. For details, check the response body.
|
|
58
58
|
*/
|
|
59
59
|
storeLog(config: ({
|
|
60
60
|
body: LogMessageJson;
|
|
@@ -68,7 +68,7 @@ export declare class LogsClient {
|
|
|
68
68
|
/**
|
|
69
69
|
* Exports log records | maturity=EARLY_ADOPTER
|
|
70
70
|
*
|
|
71
|
-
* **Required scope:** environment-api<br/><br/>Returns the first *X* records (specified in the **pageSize** query parameter).
|
|
71
|
+
* **Required scope:** environment-api<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the first *X* records (specified in the **pageSize** query parameter).
|
|
72
72
|
*
|
|
73
73
|
* Unlike the **search** API, this API does not split the result into slices and has no limit for the total number of records. Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
74
74
|
*
|
|
@@ -139,7 +139,7 @@ export declare class LogsClient {
|
|
|
139
139
|
/**
|
|
140
140
|
* Gets aggregated log records | maturity=EARLY_ADOPTER
|
|
141
141
|
*
|
|
142
|
-
* **Required scope:** storage:logs:read<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
|
|
142
|
+
* **Required scope:** storage:logs:read<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
|
|
143
143
|
*
|
|
144
144
|
* It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
|
|
145
145
|
* @returns Success
|
|
@@ -216,7 +216,7 @@ export declare class LogsClient {
|
|
|
216
216
|
/**
|
|
217
217
|
* Reads log records | maturity=EARLY_ADOPTER
|
|
218
218
|
*
|
|
219
|
-
* **Required scope:** storage:logs:read<br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
219
|
+
* **Required scope:** storage:logs:read<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
220
220
|
*
|
|
221
221
|
* If the query is too large to be processed in a single request, it is divided into slices. In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
|
|
222
222
|
*
|
|
@@ -17,7 +17,7 @@ export declare class MetricsClient {
|
|
|
17
17
|
/**
|
|
18
18
|
* Gets the descriptor of the specified metric
|
|
19
19
|
*
|
|
20
|
-
* **Required scope:** environment-api:metrics:read
|
|
20
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
|
|
21
21
|
* @returns Success
|
|
22
22
|
*/
|
|
23
23
|
metric(config: {
|
|
@@ -32,7 +32,7 @@ export declare class MetricsClient {
|
|
|
32
32
|
/**
|
|
33
33
|
* Deletes the specified metric
|
|
34
34
|
*
|
|
35
|
-
* **Required scope:** environment-api:metrics:write<br/><br/>Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
|
|
35
|
+
* **Required scope:** environment-api:metrics:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
|
|
36
36
|
*/
|
|
37
37
|
delete(config: {
|
|
38
38
|
/** The key of the required metric. */ metricKey: string;
|
|
@@ -41,7 +41,7 @@ export declare class MetricsClient {
|
|
|
41
41
|
/**
|
|
42
42
|
* Lists all available metrics
|
|
43
43
|
*
|
|
44
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>You can narrow down the output by selecting metrics in the **metricSelector** field.
|
|
44
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can narrow down the output by selecting metrics in the **metricSelector** field.
|
|
45
45
|
*
|
|
46
46
|
* You can additionally limit the output by using pagination:
|
|
47
47
|
*
|
|
@@ -152,8 +152,9 @@ export declare class MetricsClient {
|
|
|
152
152
|
* * `unit("unit-1","unit-2")`
|
|
153
153
|
* * `tags("tag-1","tag-2")`
|
|
154
154
|
* * `dimensionKey("dimkey-1","dimkey-2")`. The filtering applies only to dimensions that were written within the last 14 days.
|
|
155
|
+
* * `custom("true")`. "true" to include only user-defined metrics metrics (without namespace or with `ext:`, `calc:`, `func:`, `appmon:`), "false" to filter them out.
|
|
155
156
|
*
|
|
156
|
-
* To set several criteria, separate them with a comma (`,`). For example, `tags("feature","cloud"),unit("Percent"),dimensionKey("location")`. Only results matching **all** criteria are included in response.
|
|
157
|
+
* To set several criteria, separate them with a comma (`,`). For example, `tags("feature","cloud"),unit("Percent"),dimensionKey("location"),custom("true")`. Only results matching **all** criteria are included in response.
|
|
157
158
|
*
|
|
158
159
|
* For example, to list metrics that have the tags **feature** AND **cloud** with a unit of **Percent** OR **MegaByte** AND a dimension with a dimension key **location**, use this **metadataSelector**: `tags("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location")`.
|
|
159
160
|
*/ metadataSelector?: string;
|
|
@@ -163,7 +164,7 @@ export declare class MetricsClient {
|
|
|
163
164
|
/**
|
|
164
165
|
* Gets data points of the specified metrics
|
|
165
166
|
*
|
|
166
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>The following limits apply:
|
|
167
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The following limits apply:
|
|
167
168
|
* * The amount of aggregated data points in the response is limited to 1,000
|
|
168
169
|
* * The amount of series in the response is limited to 1,000
|
|
169
170
|
* * The amount of data points per series is limited to 10,080 (minutes of one week)
|
|
@@ -259,16 +260,16 @@ export declare class MetricsClient {
|
|
|
259
260
|
* * Entity type: `type("TYPE")`
|
|
260
261
|
* * Dynatrace entity ID: `entityId("id")`. You can specify several IDs, separated by a comma (`entityId("id-1","id-2")`). All requested entities must be of the same type.
|
|
261
262
|
*
|
|
262
|
-
* You can add one or
|
|
263
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
263
264
|
*
|
|
264
|
-
* * Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. Any colons (`:`) that are part of the key or value must be escaped with a backslash(`\`)
|
|
265
|
+
* * Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. Any colons (`:`) that are part of the key or value must be escaped with a backslash(`\`). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.
|
|
265
266
|
* * Management zone ID: `mzId(123)`
|
|
266
267
|
* * Management zone name: `mzName("value")`
|
|
267
268
|
* * Entity name:
|
|
268
269
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
269
270
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
270
271
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
271
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
272
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
272
273
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
273
274
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
274
275
|
* The following operators are available:
|
|
@@ -277,14 +278,14 @@ export declare class MetricsClient {
|
|
|
277
278
|
* * `gte`: later than or at the specified time
|
|
278
279
|
* * `gt`: later than the specified time
|
|
279
280
|
* * Entity attribute: `<attribute>("value1","value2")` and `<attribute>.exists()`. To fetch the list of available attributes, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **properties** field of the response.
|
|
280
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
281
|
+
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **fromRelationships** and **toRelationships** fields.
|
|
281
282
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
282
283
|
*
|
|
283
284
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
284
285
|
*
|
|
285
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
286
|
+
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in the response.
|
|
286
287
|
*
|
|
287
|
-
*
|
|
288
|
+
* The maximum string length is 2,000 characters.
|
|
288
289
|
*
|
|
289
290
|
* Use the [`GET /metrics/{metricId}`](https://dt-url.net/6z23ifk) call to fetch the list of possible entity types for your metric.
|
|
290
291
|
*
|
|
@@ -305,7 +306,7 @@ export declare class MetricsClient {
|
|
|
305
306
|
/**
|
|
306
307
|
* Pushes metric data points to Dynatrace
|
|
307
308
|
*
|
|
308
|
-
* **Required scope:** storage:metrics:write
|
|
309
|
+
* **Required scope:** storage:metrics:write<br/>**Required permission:** storage:metrics:write
|
|
309
310
|
* @returns The provided metric data points are accepted and will be processed in the background.
|
|
310
311
|
*/
|
|
311
312
|
ingest(config: {
|
|
@@ -16,7 +16,7 @@ export declare class MetricsUnitsClient {
|
|
|
16
16
|
/**
|
|
17
17
|
* Converts a value from a source unit into a target unit
|
|
18
18
|
*
|
|
19
|
-
* **Required scope:** environment-api:metrics:read<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).
|
|
19
|
+
* **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).
|
|
20
20
|
* @returns Success
|
|
21
21
|
*/
|
|
22
22
|
convert(config: {
|
|
@@ -40,7 +40,7 @@ export declare class MetricsUnitsClient {
|
|
|
40
40
|
/**
|
|
41
41
|
* Gets the properties of the specified unit
|
|
42
42
|
*
|
|
43
|
-
* **Required scope:** environment-api:metrics:read
|
|
43
|
+
* **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
|
|
44
44
|
* @returns Success
|
|
45
45
|
*/
|
|
46
46
|
unit(config: {
|
|
@@ -50,7 +50,7 @@ export declare class MetricsUnitsClient {
|
|
|
50
50
|
/**
|
|
51
51
|
* Lists all available units
|
|
52
52
|
*
|
|
53
|
-
* **Required scope:** environment-api:metrics:read<br/><br/>You can narrow down the output by providing filter criteria in the **unitSelector** field.
|
|
53
|
+
* **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.
|
|
54
54
|
* @returns Success
|
|
55
55
|
*/
|
|
56
56
|
allUnits(config: {
|