@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
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/>**Required permission:** environment:roles:viewer<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,11 @@ 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
|
|
147
|
+
*
|
|
148
|
+
* <br/>**Required permission:** environment:roles:viewer
|
|
141
149
|
* @returns Success
|
|
142
150
|
*/
|
|
143
151
|
getEntity(config: {
|
|
@@ -190,7 +198,11 @@ export declare class MonitoredEntitiesClient {
|
|
|
190
198
|
/**
|
|
191
199
|
* Gets a list of properties for the specified entity type
|
|
192
200
|
*
|
|
193
|
-
* **
|
|
201
|
+
* **One of the following scopes is required:**
|
|
202
|
+
* + environment-api
|
|
203
|
+
* + environment-api:entities:read
|
|
204
|
+
*
|
|
205
|
+
* <br/>**Required permission:** environment:roles:viewer
|
|
194
206
|
* @returns Success
|
|
195
207
|
*/
|
|
196
208
|
getEntityType(config: {
|
|
@@ -200,7 +212,11 @@ export declare class MonitoredEntitiesClient {
|
|
|
200
212
|
/**
|
|
201
213
|
* Gets a list of properties for all entity types
|
|
202
214
|
*
|
|
203
|
-
* **
|
|
215
|
+
* **One of the following scopes is required:**
|
|
216
|
+
* + environment-api
|
|
217
|
+
* + environment-api:entities:read
|
|
218
|
+
*
|
|
219
|
+
* <br/>**Required permission:** environment:roles:viewer<br/><br/>You can limit the output by using pagination:
|
|
204
220
|
* 1. Specify the number of results per page in the **pageSize** query parameter.
|
|
205
221
|
* 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
|
|
206
222
|
* @returns Success
|
|
@@ -225,7 +241,11 @@ export declare class MonitoredEntitiesClient {
|
|
|
225
241
|
/**
|
|
226
242
|
* Creates or updates a custom device
|
|
227
243
|
*
|
|
228
|
-
* **
|
|
244
|
+
* **One of the following scopes is required:**
|
|
245
|
+
* + environment-api
|
|
246
|
+
* + environment-api:entities:write
|
|
247
|
+
*
|
|
248
|
+
* <br/>**Required permission:** environment:roles:manage-settings
|
|
229
249
|
* @returns Success
|
|
230
250
|
*/
|
|
231
251
|
pushCustomDevice(config: {
|
|
@@ -17,7 +17,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
17
17
|
/**
|
|
18
18
|
* Gets a list of custom tags applied to the specified entities
|
|
19
19
|
*
|
|
20
|
-
* **Required scope:** environment-api<br/><br/>Automatically applied tags and imported tags are not included.
|
|
20
|
+
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Automatically applied tags and imported tags are not included.
|
|
21
21
|
* @returns Success
|
|
22
22
|
*/
|
|
23
23
|
getTags(config: {
|
|
@@ -29,16 +29,16 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
29
29
|
* * Entity type: `type("TYPE")`
|
|
30
30
|
* * 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.
|
|
31
31
|
*
|
|
32
|
-
* You can add one or
|
|
32
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
33
33
|
*
|
|
34
|
-
* * 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(`\`)
|
|
34
|
+
* * 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.
|
|
35
35
|
* * Management zone ID: `mzId(123)`
|
|
36
36
|
* * Management zone name: `mzName("value")`
|
|
37
37
|
* * Entity name:
|
|
38
38
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
39
39
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
40
40
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
41
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
41
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
42
42
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
43
43
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
44
44
|
* The following operators are available:
|
|
@@ -47,14 +47,14 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
47
47
|
* * `gte`: later than or at the specified time
|
|
48
48
|
* * `gt`: later than the specified time
|
|
49
49
|
* * 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.
|
|
50
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
50
|
+
* * 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.
|
|
51
51
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
52
52
|
*
|
|
53
53
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
54
54
|
*
|
|
55
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
55
|
+
* 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.
|
|
56
56
|
*
|
|
57
|
-
*
|
|
57
|
+
* The maximum string length is 2,000 characters.
|
|
58
58
|
*/ entitySelector: string;
|
|
59
59
|
/**
|
|
60
60
|
* The start of the requested timeframe.
|
|
@@ -97,7 +97,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
97
97
|
/**
|
|
98
98
|
* Adds custom tags to the specified entities
|
|
99
99
|
*
|
|
100
|
-
* **Required scope:** environment-api<br/><br/>All existing tags remain unaffected.
|
|
100
|
+
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>All existing tags remain unaffected.
|
|
101
101
|
* @returns Success
|
|
102
102
|
*/
|
|
103
103
|
postTags(config: {
|
|
@@ -110,16 +110,16 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
110
110
|
* * Entity type: `type("TYPE")`
|
|
111
111
|
* * 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.
|
|
112
112
|
*
|
|
113
|
-
* You can add one or
|
|
113
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
114
114
|
*
|
|
115
|
-
* * 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(`\`)
|
|
115
|
+
* * 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.
|
|
116
116
|
* * Management zone ID: `mzId(123)`
|
|
117
117
|
* * Management zone name: `mzName("value")`
|
|
118
118
|
* * Entity name:
|
|
119
119
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
120
120
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
121
121
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
122
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
122
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
123
123
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
124
124
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
125
125
|
* The following operators are available:
|
|
@@ -128,14 +128,14 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
128
128
|
* * `gte`: later than or at the specified time
|
|
129
129
|
* * `gt`: later than the specified time
|
|
130
130
|
* * 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.
|
|
131
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
131
|
+
* * 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.
|
|
132
132
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
133
133
|
*
|
|
134
134
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
135
135
|
*
|
|
136
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
136
|
+
* 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.
|
|
137
137
|
*
|
|
138
|
-
*
|
|
138
|
+
* The maximum string length is 2,000 characters.
|
|
139
139
|
*/ entitySelector: string;
|
|
140
140
|
/**
|
|
141
141
|
* The start of the requested timeframe.
|
|
@@ -178,7 +178,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
178
178
|
/**
|
|
179
179
|
* Deletes the specified tag from the specified entities
|
|
180
180
|
*
|
|
181
|
-
* **Required scope:** environment-api
|
|
181
|
+
* **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
|
|
182
182
|
* @returns Success
|
|
183
183
|
*/
|
|
184
184
|
deleteTags(config: {
|
|
@@ -208,16 +208,16 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
208
208
|
* * Entity type: `type("TYPE")`
|
|
209
209
|
* * 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.
|
|
210
210
|
*
|
|
211
|
-
* You can add one or
|
|
211
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
212
212
|
*
|
|
213
|
-
* * 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(`\`)
|
|
213
|
+
* * 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.
|
|
214
214
|
* * Management zone ID: `mzId(123)`
|
|
215
215
|
* * Management zone name: `mzName("value")`
|
|
216
216
|
* * Entity name:
|
|
217
217
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
218
218
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
219
219
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
220
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
220
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
221
221
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
222
222
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
223
223
|
* The following operators are available:
|
|
@@ -226,14 +226,14 @@ export declare class MonitoredEntitiesCustomTagsClient {
|
|
|
226
226
|
* * `gte`: later than or at the specified time
|
|
227
227
|
* * `gt`: later than the specified time
|
|
228
228
|
* * 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.
|
|
229
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
229
|
+
* * 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.
|
|
230
230
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
231
231
|
*
|
|
232
232
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
233
233
|
*
|
|
234
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
234
|
+
* 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.
|
|
235
235
|
*
|
|
236
|
-
*
|
|
236
|
+
* The maximum string length is 2,000 characters.
|
|
237
237
|
*/ entitySelector: string;
|
|
238
238
|
/**
|
|
239
239
|
* The start of the requested timeframe.
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
|
+
import { MonitoredStates } from '../models/monitored-states';
|
|
3
|
+
/**
|
|
4
|
+
* Read state of monitored entities
|
|
5
|
+
*/
|
|
6
|
+
export declare class MonitoredEntitiesMonitoringStateClient {
|
|
7
|
+
private httpClient;
|
|
8
|
+
/**
|
|
9
|
+
* @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a MonitoredEntitiesMonitoringStateClient. Custom http client should implement {HttpClient} interface.
|
|
10
|
+
* @example
|
|
11
|
+
* const queryClientNodeJs = new QueryClient(yourCustomImplementation);
|
|
12
|
+
*/
|
|
13
|
+
constructor(httpClientImplementation: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* Lists monitoring states of entities
|
|
16
|
+
*
|
|
17
|
+
* **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Only porcess group instances are supported.
|
|
18
|
+
* @returns Success
|
|
19
|
+
*/
|
|
20
|
+
getStates(config: {
|
|
21
|
+
/**
|
|
22
|
+
* Specifies the process group instances where you're querying the state. Use the `PROCESS_GROUP_INSTANCE` entity type.
|
|
23
|
+
*
|
|
24
|
+
* You must set one of these criteria:
|
|
25
|
+
*
|
|
26
|
+
* * Entity type: `type("TYPE")`
|
|
27
|
+
* * 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.
|
|
28
|
+
*
|
|
29
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
30
|
+
*
|
|
31
|
+
* * 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.
|
|
32
|
+
* * Management zone ID: `mzId(123)`
|
|
33
|
+
* * Management zone name: `mzName("value")`
|
|
34
|
+
* * Entity name:
|
|
35
|
+
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
36
|
+
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
37
|
+
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
38
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
39
|
+
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
40
|
+
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
41
|
+
* The following operators are available:
|
|
42
|
+
* * `lte`: earlier than or at the specified time
|
|
43
|
+
* * `lt`: earlier than the specified time
|
|
44
|
+
* * `gte`: later than or at the specified time
|
|
45
|
+
* * `gt`: later than the specified time
|
|
46
|
+
* * 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.
|
|
47
|
+
* * 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.
|
|
48
|
+
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
49
|
+
*
|
|
50
|
+
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
51
|
+
*
|
|
52
|
+
* 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.
|
|
53
|
+
*
|
|
54
|
+
* The maximum string length is 2,000 characters.
|
|
55
|
+
*/ entitySelector: string;
|
|
56
|
+
abortSignal?: AbortSignal;
|
|
57
|
+
}): Promise<MonitoredStates>;
|
|
58
|
+
}
|
|
59
|
+
export declare const monitoredEntitiesMonitoringStateClient: MonitoredEntitiesMonitoringStateClient;
|
|
@@ -19,7 +19,7 @@ export declare class NetworkZonesClient {
|
|
|
19
19
|
/**
|
|
20
20
|
* Gets parameters of the specified network zone
|
|
21
21
|
*
|
|
22
|
-
* **Required scope:** environment-api:network-zones:read
|
|
22
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
23
23
|
* @returns Success
|
|
24
24
|
*/
|
|
25
25
|
getSingleNetworkZone(config: {
|
|
@@ -29,7 +29,7 @@ export declare class NetworkZonesClient {
|
|
|
29
29
|
/**
|
|
30
30
|
* Updates an existing network zone or creates a new one
|
|
31
31
|
*
|
|
32
|
-
* **Required scope:** environment-api:network-zones:write<br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
|
|
32
|
+
* **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
|
|
33
33
|
*
|
|
34
34
|
* The ID is not case sensitive. Dynatrace stores the ID in lowercase.
|
|
35
35
|
* @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
|
|
@@ -48,7 +48,7 @@ export declare class NetworkZonesClient {
|
|
|
48
48
|
/**
|
|
49
49
|
* Deletes the specified network zone
|
|
50
50
|
*
|
|
51
|
-
* **Required scope:** environment-api:network-zones:write<br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
|
|
51
|
+
* **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
|
|
52
52
|
*
|
|
53
53
|
* If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.
|
|
54
54
|
*/
|
|
@@ -59,14 +59,14 @@ export declare class NetworkZonesClient {
|
|
|
59
59
|
/**
|
|
60
60
|
* Lists all existing network zones
|
|
61
61
|
*
|
|
62
|
-
* **Required scope:** environment-api:network-zones:read
|
|
62
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
63
63
|
* @returns Success
|
|
64
64
|
*/
|
|
65
65
|
getAllNetworkZones(abortSignal?: AbortSignal): Promise<NetworkZoneList>;
|
|
66
66
|
/**
|
|
67
67
|
* Gets the statistics about hosts using the network zone
|
|
68
68
|
*
|
|
69
|
-
* **Required scope:** environment-api:network-zones:read
|
|
69
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:manage-settings
|
|
70
70
|
* @returns Success
|
|
71
71
|
*/
|
|
72
72
|
getHostStats(config: {
|
|
@@ -87,14 +87,14 @@ export declare class NetworkZonesClient {
|
|
|
87
87
|
/**
|
|
88
88
|
* Gets the global configuration of network zones
|
|
89
89
|
*
|
|
90
|
-
* **Required scope:** environment-api:network-zones:read
|
|
90
|
+
* **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
|
|
91
91
|
* @returns Success
|
|
92
92
|
*/
|
|
93
93
|
getNetworkZoneSettings(abortSignal?: AbortSignal): Promise<NetworkZoneSettings>;
|
|
94
94
|
/**
|
|
95
95
|
* Updates the global configuration of network zones
|
|
96
96
|
*
|
|
97
|
-
* **Required scope:** environment-api:network-zones:write
|
|
97
|
+
* **Required scope:** environment-api:network-zones:write<br/>**Required permission:** environment:roles:manage-settings
|
|
98
98
|
*/
|
|
99
99
|
updateNetworkZoneSettings(config: {
|
|
100
100
|
body: NetworkZoneSettings;
|
|
@@ -20,7 +20,7 @@ export declare class ProblemsClient {
|
|
|
20
20
|
/**
|
|
21
21
|
* Closes the specified problem and adds a closing comment on it
|
|
22
22
|
*
|
|
23
|
-
* **Required scope:** environment-api:problems:write
|
|
23
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
24
24
|
* @returns Success
|
|
25
25
|
*/
|
|
26
26
|
closeProblem(config: {
|
|
@@ -31,7 +31,7 @@ export declare class ProblemsClient {
|
|
|
31
31
|
/**
|
|
32
32
|
* Gets all comments on the specified problem
|
|
33
33
|
*
|
|
34
|
-
* **Required scope:** environment-api:problems:read
|
|
34
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
35
35
|
* @returns Success
|
|
36
36
|
*/
|
|
37
37
|
getComments(config: {
|
|
@@ -55,7 +55,7 @@ export declare class ProblemsClient {
|
|
|
55
55
|
/**
|
|
56
56
|
* Adds a new comment on the specified problem
|
|
57
57
|
*
|
|
58
|
-
* **Required scope:** environment-api:problems:write
|
|
58
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
59
59
|
*/
|
|
60
60
|
createComment(config: {
|
|
61
61
|
body: CommentRequestDtoImpl;
|
|
@@ -65,7 +65,7 @@ export declare class ProblemsClient {
|
|
|
65
65
|
/**
|
|
66
66
|
* Gets the specified comment on a problem
|
|
67
67
|
*
|
|
68
|
-
* **Required scope:** environment-api:problems:read
|
|
68
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
69
69
|
* @returns Success
|
|
70
70
|
*/
|
|
71
71
|
getComment(config: {
|
|
@@ -76,7 +76,7 @@ export declare class ProblemsClient {
|
|
|
76
76
|
/**
|
|
77
77
|
* Updates the specified comment on a problem
|
|
78
78
|
*
|
|
79
|
-
* **Required scope:** environment-api:problems:write
|
|
79
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
80
80
|
*/
|
|
81
81
|
updateComment(config: {
|
|
82
82
|
body: CommentRequestDtoImpl;
|
|
@@ -87,7 +87,7 @@ export declare class ProblemsClient {
|
|
|
87
87
|
/**
|
|
88
88
|
* Deletes the specified comment from a problem
|
|
89
89
|
*
|
|
90
|
-
* **Required scope:** environment-api:problems:write
|
|
90
|
+
* **Required scope:** environment-api:problems:write<br/>**Required permission:** environment:roles:viewer
|
|
91
91
|
*/
|
|
92
92
|
deleteComment(config: {
|
|
93
93
|
/** The ID of the required problem. */ problemId: string;
|
|
@@ -97,7 +97,7 @@ export declare class ProblemsClient {
|
|
|
97
97
|
/**
|
|
98
98
|
* Gets the properties of the specified problem
|
|
99
99
|
*
|
|
100
|
-
* **Required scope:** environment-api:problems:read
|
|
100
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
101
101
|
* @returns Success
|
|
102
102
|
*/
|
|
103
103
|
getProblem(config: {
|
|
@@ -118,7 +118,7 @@ export declare class ProblemsClient {
|
|
|
118
118
|
/**
|
|
119
119
|
* Lists problems observed within the specified timeframe
|
|
120
120
|
*
|
|
121
|
-
* **Required scope:** environment-api:problems:read
|
|
121
|
+
* **Required scope:** environment-api:problems:read<br/>**Required permission:** environment:roles:viewer
|
|
122
122
|
* @returns Success
|
|
123
123
|
*/
|
|
124
124
|
getProblems(config: {
|
|
@@ -215,16 +215,16 @@ export declare class ProblemsClient {
|
|
|
215
215
|
* * Entity type: `type("TYPE")`
|
|
216
216
|
* * 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.
|
|
217
217
|
*
|
|
218
|
-
* You can add one or
|
|
218
|
+
* You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
|
|
219
219
|
*
|
|
220
|
-
* * 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(`\`)
|
|
220
|
+
* * 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.
|
|
221
221
|
* * Management zone ID: `mzId(123)`
|
|
222
222
|
* * Management zone name: `mzName("value")`
|
|
223
223
|
* * Entity name:
|
|
224
224
|
* * `entityName.equals`: performs a non-casesensitive `EQUALS` query.
|
|
225
225
|
* * `entityName.startsWith`: changes the operator to `BEGINS WITH`.
|
|
226
226
|
* * `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
|
|
227
|
-
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an
|
|
227
|
+
* * `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
|
|
228
228
|
* * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
|
|
229
229
|
* * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
|
|
230
230
|
* The following operators are available:
|
|
@@ -233,14 +233,14 @@ export declare class ProblemsClient {
|
|
|
233
233
|
* * `gte`: later than or at the specified time
|
|
234
234
|
* * `gt`: later than the specified time
|
|
235
235
|
* * 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.
|
|
236
|
-
* * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`.
|
|
236
|
+
* * 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.
|
|
237
237
|
* * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
|
|
238
238
|
*
|
|
239
239
|
* For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
|
|
240
240
|
*
|
|
241
|
-
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
|
|
241
|
+
* 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.
|
|
242
242
|
*
|
|
243
|
-
*
|
|
243
|
+
* The maximum string length is 2,000 characters.
|
|
244
244
|
*
|
|
245
245
|
* The maximum number of entities that may be selected is limited to 10000.
|
|
246
246
|
*/ entitySelector?: string;
|
|
@@ -14,7 +14,7 @@ export declare class ReleasesClient {
|
|
|
14
14
|
/**
|
|
15
15
|
* Returns all releases
|
|
16
16
|
*
|
|
17
|
-
* **Required scope:** environment-api:releases:read
|
|
17
|
+
* **Required scope:** environment-api:releases:read<br/>**Required permission:** environment:roles:viewer
|
|
18
18
|
* @returns Success
|
|
19
19
|
*/
|
|
20
20
|
getReleases(config: {
|