@dynatrace-sdk/client-classic-environment-v2 0.6.4 → 0.6.8
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 +27 -0
- package/README.md +39 -0
- package/cjs/index.js +3626 -814
- package/docs/DOCS.md +9170 -4780
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3626 -814
- package/package.json +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +5 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +8 -7
- 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 +14 -10
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +17 -0
- 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 +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +8 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +25 -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/problems-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +77 -12
- 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/error-envelopes/index.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +3 -3
- 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 +5 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-created.d.ts +5 -5
- 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 +5 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +13 -13
- 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/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/constraint-violation-parameter-location.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +13 -13
- 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 +22 -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 +24 -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/datasource-definition.d.ts +2 -2
- 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 +20 -15
- 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 +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/error.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +2 -2
- 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-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +23 -23
- 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 +69 -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 +28 -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 +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +2 -2
- 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 +57 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/invocation.d.ts +5 -5
- 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 +82 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +12 -12
- 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 +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +4 -4
- 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 +45 -45
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-ingest-error.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +5 -5
- 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 +48 -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.d.ts +6 -6
- 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 +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +23 -23
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +18 -18
- 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 +33 -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 +15 -15
- 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/rollup.d.ts +2 -2
- 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/schema-type.d.ts +2 -2
- 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 +24 -17
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +27 -22
- 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 +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +47 -47
- 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/success.d.ts +5 -5
- 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.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +3 -0
- 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-customization.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-expandable-section-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-tab-group-customization.d.ts +5 -5
- 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/platform/error-handlers/src/lib/add-global-error-serializer.d.ts +0 -1
- package/types/packages/platform/error-handlers/src/lib/types/index.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-detail.d.ts +0 -32
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dynatrace-sdk/client-classic-environment-v2",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.8",
|
|
4
4
|
"dependencies": {
|
|
5
|
-
"@dynatrace-sdk/http-client": "^0.4.
|
|
5
|
+
"@dynatrace-sdk/http-client": "^0.4.9"
|
|
6
6
|
},
|
|
7
7
|
"main": "./cjs/index.js",
|
|
8
8
|
"module": "./esm/index.js",
|
|
@@ -42,7 +42,11 @@ export declare class AccessTokensActiveGateTokensClient {
|
|
|
42
42
|
/**
|
|
43
43
|
* Creates a new ActiveGate token | maturity=EARLY_ADOPTER
|
|
44
44
|
*
|
|
45
|
-
* **
|
|
45
|
+
* **One of the following scopes is required:**
|
|
46
|
+
* + environment-api:activegate-tokens:create
|
|
47
|
+
* + environment-api:activegate-tokens:write
|
|
48
|
+
*
|
|
49
|
+
* <br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
|
|
46
50
|
* @returns Success. The token has been created. The body of the response contains the token secret.
|
|
47
51
|
*/
|
|
48
52
|
createToken(config: {
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
2
|
import { AbstractCredentialsResponseElement } from '../models/abstract-credentials-response-element';
|
|
3
3
|
import { Credentials } from '../models/credentials';
|
|
4
|
+
import { CredentialsId } from '../models/credentials-id';
|
|
4
5
|
import { CredentialsList } from '../models/credentials-list';
|
|
5
6
|
import { CredentialsResponseElement } from '../models/credentials-response-element';
|
|
6
7
|
import { ListCredentialsQueryType } from '../models/list-credentials-query-type';
|
|
@@ -16,7 +17,7 @@ export declare class CredentialVaultClient {
|
|
|
16
17
|
*/
|
|
17
18
|
constructor(httpClientImplementation: HttpClient);
|
|
18
19
|
/**
|
|
19
|
-
* Lists all sets of credentials for synthetic monitors stored in your environment
|
|
20
|
+
* Lists all sets of credentials for synthetic monitors stored in your environment.
|
|
20
21
|
*
|
|
21
22
|
* **Required scope:** environment-api:credentials:read<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
|
|
22
23
|
* @returns Success
|
|
@@ -43,7 +44,7 @@ export declare class CredentialVaultClient {
|
|
|
43
44
|
abortSignal?: AbortSignal;
|
|
44
45
|
}): Promise<CredentialsList>;
|
|
45
46
|
/**
|
|
46
|
-
* Creates a new credentials set
|
|
47
|
+
* Creates a new credentials set.
|
|
47
48
|
*
|
|
48
49
|
* **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
|
|
49
50
|
* @returns Success. The new credentials set has been created. The response contains the ID of the set.
|
|
@@ -51,9 +52,9 @@ export declare class CredentialVaultClient {
|
|
|
51
52
|
createCredentials(config: {
|
|
52
53
|
body: Credentials;
|
|
53
54
|
abortSignal?: AbortSignal;
|
|
54
|
-
}): Promise<
|
|
55
|
+
}): Promise<CredentialsId>;
|
|
55
56
|
/**
|
|
56
|
-
* Gets the metadata of the specified credentials set
|
|
57
|
+
* Gets the metadata of the specified credentials set.
|
|
57
58
|
*
|
|
58
59
|
* **Required scope:** environment-api:credentials:read<br/><br/>The credentials set itself (e.g. username/certificate and password) is not included in the response.
|
|
59
60
|
* @returns Success. The response contains the metadata of the credentials set.
|
|
@@ -63,16 +64,16 @@ export declare class CredentialVaultClient {
|
|
|
63
64
|
abortSignal?: AbortSignal;
|
|
64
65
|
}): Promise<CredentialsResponseElement>;
|
|
65
66
|
/**
|
|
66
|
-
* Updates the specified credentials set
|
|
67
|
+
* Updates the specified credentials set.
|
|
67
68
|
*
|
|
68
|
-
* **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. The ID should be provided in the path
|
|
69
|
+
* **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. The ID should be provided in the path.
|
|
69
70
|
* @returns Success. The new credentials set has been created. The response contains the ID of the set.
|
|
70
71
|
*/
|
|
71
72
|
updateCredentials(config: {
|
|
72
73
|
body: Credentials;
|
|
73
74
|
/** The Dynatrace entity ID of the credentials set to be updated. */ id: string;
|
|
74
75
|
abortSignal?: AbortSignal;
|
|
75
|
-
}): Promise<
|
|
76
|
+
}): Promise<CredentialsId | void>;
|
|
76
77
|
/**
|
|
77
78
|
* Deletes the specified credentials set
|
|
78
79
|
*
|
package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ export declare class DavisSecurityAdvisorClient {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(httpClientImplementation: HttpClient);
|
|
14
14
|
/**
|
|
15
|
-
* Provides advice for security problems.
|
|
15
|
+
* Provides advice for security problems.
|
|
16
16
|
*
|
|
17
17
|
* **Required scope:** environment-api:security-problems:read<br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
|
|
18
18
|
* @returns Success
|
|
@@ -3,7 +3,7 @@ import { Event } from '../models/event';
|
|
|
3
3
|
import { EventIngest } from '../models/event-ingest';
|
|
4
4
|
import { EventIngestResults } from '../models/event-ingest-results';
|
|
5
5
|
import { EventList } from '../models/event-list';
|
|
6
|
-
import {
|
|
6
|
+
import { EventPropertiesList } from '../models/event-properties-list';
|
|
7
7
|
import { EventPropertyDetails } from '../models/event-property-details';
|
|
8
8
|
import { EventType } from '../models/event-type';
|
|
9
9
|
import { EventTypeList } from '../models/event-type-list';
|
|
@@ -21,7 +21,11 @@ export declare class EventsClient {
|
|
|
21
21
|
/**
|
|
22
22
|
* Ingests a custom event
|
|
23
23
|
*
|
|
24
|
-
* **
|
|
24
|
+
* **One of the following scopes is required:**
|
|
25
|
+
* + storage:events:write
|
|
26
|
+
* + environment-api:events:write
|
|
27
|
+
*
|
|
28
|
+
* <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
|
|
25
29
|
* @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
|
|
26
30
|
*/
|
|
27
31
|
createEvent(config: {
|
|
@@ -60,7 +64,7 @@ export declare class EventsClient {
|
|
|
60
64
|
* If not set, 100 is used.
|
|
61
65
|
*/ pageSize?: number;
|
|
62
66
|
abortSignal?: AbortSignal;
|
|
63
|
-
}): Promise<
|
|
67
|
+
}): Promise<EventPropertiesList>;
|
|
64
68
|
/**
|
|
65
69
|
* Gets the details of an event property
|
|
66
70
|
*
|
|
@@ -70,7 +74,7 @@ export declare class EventsClient {
|
|
|
70
74
|
getEventProperty(config: {
|
|
71
75
|
/** The event property key you're inquiring. */ propertyKey: string;
|
|
72
76
|
abortSignal?: AbortSignal;
|
|
73
|
-
}): Promise<
|
|
77
|
+
}): Promise<EventPropertyDetails>;
|
|
74
78
|
/**
|
|
75
79
|
* Gets the properties of an event type
|
|
76
80
|
*
|
|
@@ -185,16 +189,16 @@ export declare class EventsClient {
|
|
|
185
189
|
* * Entity type: `type("TYPE")`
|
|
186
190
|
* * 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.
|
|
187
191
|
*
|
|
188
|
-
* You can add one or
|
|
192
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
189
193
|
*
|
|
190
|
-
* * 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(`\`)
|
|
194
|
+
* * 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.
|
|
191
195
|
* * Management zone ID: `mzId(123)`
|
|
192
196
|
* * Management zone name: `mzName("value")`
|
|
193
197
|
* * Entity name:
|
|
194
198
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
195
199
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
196
200
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
197
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
201
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
198
202
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
199
203
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
200
204
|
* The following operators are available:
|
|
@@ -203,14 +207,14 @@ export declare class EventsClient {
|
|
|
203
207
|
* * `gte`: later than or at the specified time
|
|
204
208
|
* * `gt`: later than the specified time
|
|
205
209
|
* * 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.
|
|
206
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
210
|
+
* * 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.
|
|
207
211
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
208
212
|
*
|
|
209
213
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
210
214
|
*
|
|
211
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
215
|
+
* 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.
|
|
212
216
|
*
|
|
213
|
-
*
|
|
217
|
+
* The maximum string length is 2,000 characters.
|
|
214
218
|
*
|
|
215
219
|
* The number of entities that can be selected is limited to 10000.
|
|
216
220
|
*/ entitySelector?: string;
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
|
+
import { ErrorEnvelope } from '../models/error-envelope';
|
|
2
3
|
import { Extension } from '../models/extension';
|
|
4
|
+
import { ExtensionAssetsDto } from '../models/extension-assets-dto';
|
|
3
5
|
import { ExtensionEnvironmentConfigurationVersion } from '../models/extension-environment-configuration-version';
|
|
4
6
|
import { ExtensionEventsList } from '../models/extension-events-list';
|
|
5
7
|
import { ExtensionList } from '../models/extension-list';
|
|
@@ -107,6 +109,11 @@ export declare class Extensions_2_0Client {
|
|
|
107
109
|
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
108
110
|
abortSignal?: AbortSignal;
|
|
109
111
|
}): Promise<MonitoringConfigurationResponse[]>;
|
|
112
|
+
createMonitoringConfiguration(config: {
|
|
113
|
+
body: MonitoringConfigurationDto[];
|
|
114
|
+
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
115
|
+
abortSignal?: AbortSignal;
|
|
116
|
+
}): Promise<(MonitoringConfigurationResponse | ErrorEnvelope)[]>;
|
|
110
117
|
/**
|
|
111
118
|
* Gets the configuration schema of the specified version of the extension 2.0
|
|
112
119
|
*
|
|
@@ -141,6 +148,16 @@ export declare class Extensions_2_0Client {
|
|
|
141
148
|
/** The version of the requested extension 2.0 */ extensionVersion: string;
|
|
142
149
|
abortSignal?: AbortSignal;
|
|
143
150
|
}): Promise<Extension>;
|
|
151
|
+
/**
|
|
152
|
+
* Gets the information about assets in an active extension 2.0
|
|
153
|
+
*
|
|
154
|
+
* **Required scope:** environment-api:extensions:read
|
|
155
|
+
* @returns Success
|
|
156
|
+
*/
|
|
157
|
+
getEnvironmentConfigurationAssetsInfo(config: {
|
|
158
|
+
/** The name of the requested extension 2.0. */ extensionName: string;
|
|
159
|
+
abortSignal?: AbortSignal;
|
|
160
|
+
}): Promise<ExtensionAssetsDto>;
|
|
144
161
|
/**
|
|
145
162
|
* List of the latest extension environment configuration events
|
|
146
163
|
*
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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';
|
|
@@ -25,17 +25,17 @@ export declare class LogsClient {
|
|
|
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;
|
|
@@ -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;
|
|
@@ -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
|
*
|
package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts
CHANGED
|
@@ -19,7 +19,11 @@ export declare class MonitoredEntitiesClient {
|
|
|
19
19
|
/**
|
|
20
20
|
* Gets the information about monitored entities
|
|
21
21
|
*
|
|
22
|
-
* **
|
|
22
|
+
* **One of the following scopes is required:**
|
|
23
|
+
* + environment-api
|
|
24
|
+
* + environment-api:entities:read
|
|
25
|
+
*
|
|
26
|
+
* <br/><br/>Lists entities observed within the specified timeframe along with their properties.
|
|
23
27
|
*
|
|
24
28
|
* When you query entities of the `SERVICE_METHOD` type, only the following requests are returned:
|
|
25
29
|
*
|
|
@@ -53,16 +57,16 @@ export declare class MonitoredEntitiesClient {
|
|
|
53
57
|
* * Entity type: `type("TYPE")`
|
|
54
58
|
* * 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.
|
|
55
59
|
*
|
|
56
|
-
* You can add one or
|
|
60
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
57
61
|
*
|
|
58
|
-
* * 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(`\`)
|
|
62
|
+
* * 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.
|
|
59
63
|
* * Management zone ID: `mzId(123)`
|
|
60
64
|
* * Management zone name: `mzName("value")`
|
|
61
65
|
* * Entity name:
|
|
62
66
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
63
67
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
64
68
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
65
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
69
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
66
70
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
67
71
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
68
72
|
* The following operators are available:
|
|
@@ -71,14 +75,14 @@ export declare class MonitoredEntitiesClient {
|
|
|
71
75
|
* * `gte`: later than or at the specified time
|
|
72
76
|
* * `gt`: later than the specified time
|
|
73
77
|
* * 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.
|
|
74
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
78
|
+
* * 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.
|
|
75
79
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
76
80
|
*
|
|
77
81
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
78
82
|
*
|
|
79
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
83
|
+
* 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.
|
|
80
84
|
*
|
|
81
|
-
*
|
|
85
|
+
* The maximum string length is 2,000 characters.
|
|
82
86
|
*
|
|
83
87
|
* The field is **required** when you're querying the first page of results.
|
|
84
88
|
*/ entitySelector?: string;
|
|
@@ -137,7 +141,9 @@ export declare class MonitoredEntitiesClient {
|
|
|
137
141
|
/**
|
|
138
142
|
* Gets the properties of the specified monitored entity
|
|
139
143
|
*
|
|
140
|
-
* **
|
|
144
|
+
* **One of the following scopes is required:**
|
|
145
|
+
* + environment-api
|
|
146
|
+
* + environment-api:entities:read
|
|
141
147
|
* @returns Success
|
|
142
148
|
*/
|
|
143
149
|
getEntity(config: {
|
|
@@ -190,7 +196,9 @@ export declare class MonitoredEntitiesClient {
|
|
|
190
196
|
/**
|
|
191
197
|
* Gets a list of properties for the specified entity type
|
|
192
198
|
*
|
|
193
|
-
* **
|
|
199
|
+
* **One of the following scopes is required:**
|
|
200
|
+
* + environment-api
|
|
201
|
+
* + environment-api:entities:read
|
|
194
202
|
* @returns Success
|
|
195
203
|
*/
|
|
196
204
|
getEntityType(config: {
|
|
@@ -200,7 +208,11 @@ export declare class MonitoredEntitiesClient {
|
|
|
200
208
|
/**
|
|
201
209
|
* Gets a list of properties for all entity types
|
|
202
210
|
*
|
|
203
|
-
* **
|
|
211
|
+
* **One of the following scopes is required:**
|
|
212
|
+
* + environment-api
|
|
213
|
+
* + environment-api:entities:read
|
|
214
|
+
*
|
|
215
|
+
* <br/><br/>You can limit the output by using pagination:
|
|
204
216
|
* 1. Specify the number of results per page in the **pageSize** query parameter.
|
|
205
217
|
* 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
|
|
206
218
|
* @returns Success
|
|
@@ -225,7 +237,9 @@ export declare class MonitoredEntitiesClient {
|
|
|
225
237
|
/**
|
|
226
238
|
* Creates or updates a custom device
|
|
227
239
|
*
|
|
228
|
-
* **
|
|
240
|
+
* **One of the following scopes is required:**
|
|
241
|
+
* + environment-api
|
|
242
|
+
* + environment-api:entities:write
|
|
229
243
|
* @returns Success
|
|
230
244
|
*/
|
|
231
245
|
pushCustomDevice(config: {
|