@dynatrace-sdk/client-classic-environment-v2 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/README.md +1 -1
- package/cjs/index.js +2548 -2410
- package/docs/DOCS.md +149 -81
- package/dynatrace-metadata.json +1 -1
- package/esm/index.js +2548 -2410
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +1 -1
- 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 +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +21 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +1 -1
- 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 +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +1 -1
- 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 +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group-info-dto.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group-info-dto.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups-info-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups-info-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-info-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-info-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +6 -0
- package/types/packages/http-client/src/lib/platform/http-client-response-error.d.ts +4 -1
- package/types/packages/platform/error-handlers/src/lib/types/common-serialized-error.d.ts +2 -0
- package/types/packages/platform/error-handlers/src/lib/types/http-serialized-error.d.ts +3 -0
package/docs/DOCS.md
CHANGED
|
@@ -24,7 +24,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
|
|
|
24
24
|
</a>
|
|
25
25
|
</div>
|
|
26
26
|
<div class="col" style={{textAlign: 'right'}}>
|
|
27
|
-
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.4.
|
|
27
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.4.2">v1.4.2</a>
|
|
28
28
|
</div>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
@@ -380,7 +380,7 @@ You can limit the output by using pagination:
|
|
|
380
380
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters tokens based on the last usage time. The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> |
|
|
381
381
|
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
382
382
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of API tokens in a single response payload.</p> <p>The maximal allowed page size is 10000 and the minimal allowed page size is 100.</p> <p>If not set, 200 is used.</p> |
|
|
383
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort order of the token list.</p> <p>You can sort by the following properties with a sign prefix for the sort order:</p> <ul> <li><code>name</code>: token name (<code>+</code> a...z or <code>-</code> z...a)</li> <li><code>lastUsedDate</code> last used (<code>+</code> never used tokens first <code>-</code> most recently used tokens first)</li> <li><code>creationDate</code> (<code>+</code> oldest tokens first <code>-</code> newest tokens first)</li> <li><code>expirationDate</code> (<code>+</code> tokens that expire soon first <code>-</code> unlimited tokens first)</li> <li><code>modifiedDate</code> last modified (<code>+</code> never modified tokens first <code>-</code> most recently modified tokens first)</li> </ul> <p>If no prefix is set, + is used.</p> <p>If not set, tokens are sorted by creation date with newest first.</p>
|
|
383
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort order of the token list.</p> <p>You can sort by the following properties with a sign prefix for the sort order:</p> <ul> <li><code>name</code>: token name (<code>+</code> a...z or <code>-</code> z...a)</li> <li><code>lastUsedDate</code> last used (<code>+</code> never used tokens first <code>-</code> most recently used tokens first)</li> <li><code>creationDate</code> (<code>+</code> oldest tokens first <code>-</code> newest tokens first)</li> <li><code>expirationDate</code> (<code>+</code> tokens that expire soon first <code>-</code> unlimited tokens first)</li> <li><code>modifiedDate</code> last modified (<code>+</code> never modified tokens first <code>-</code> most recently modified tokens first)</li> </ul> <p>If no prefix is set, + is used.</p> <p>If not set, tokens are sorted by creation date with newest first.</p> <i>default:</i> <code>"-creationDate"</code> |
|
|
384
384
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters tokens based on the last usage time. The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
385
385
|
|
|
386
386
|
#### Returns
|
|
@@ -977,11 +977,11 @@ The response includes ActiveGates that have both completed (successful and faile
|
|
|
977
977
|
| Name | Type | Description |
|
|
978
978
|
| ------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
979
979
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of one day is used (<code>now-1d</code>).</p> <p>Maximum timeframe is 31 days.</p> |
|
|
980
|
-
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type.
|
|
980
|
+
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type. <i>default:</i> <code>false</code> |
|
|
981
981
|
| config.startVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the initial version (required format <code><major>.<minor>.<revision></code>). |
|
|
982
|
-
| config.startVersionCompareType | GetAllUpdateJobListQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p>
|
|
982
|
+
| config.startVersionCompareType | GetAllUpdateJobListQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
983
983
|
| config.targetVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the target version (required format <code><major>.<minor>.<revision></code>). |
|
|
984
|
-
| config.targetVersionCompareType | GetAllUpdateJobListQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p>
|
|
984
|
+
| config.targetVersionCompareType | GetAllUpdateJobListQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
985
985
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
986
986
|
| config.updateType | GetAllUpdateJobListQueryUpdateType | Filters the resulting set of update-jobs by the update type. |
|
|
987
987
|
|
|
@@ -1071,11 +1071,11 @@ The job can update the ActiveGate to the specified version or the latest availab
|
|
|
1071
1071
|
| -------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1072
1072
|
| config.agId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required ActiveGate. |
|
|
1073
1073
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of one week is used (<code>now-1w</code>).</p> <p>Maximum timeframe is 31 days.</p> |
|
|
1074
|
-
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type.
|
|
1074
|
+
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type. <i>default:</i> <code>false</code> |
|
|
1075
1075
|
| config.startVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the initial version (required format <code><major>.<minor>.<revision></code>). |
|
|
1076
|
-
| config.startVersionCompareType | GetUpdateJobListByAgIdQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p>
|
|
1076
|
+
| config.startVersionCompareType | GetUpdateJobListByAgIdQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
1077
1077
|
| config.targetVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the target version (required format <code><major>.<minor>.<revision></code>). |
|
|
1078
|
-
| config.targetVersionCompareType | GetUpdateJobListByAgIdQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p>
|
|
1078
|
+
| config.targetVersionCompareType | GetUpdateJobListByAgIdQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
1079
1079
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
1080
1080
|
| config.updateType | GetUpdateJobListByAgIdQueryUpdateType | Filters the resulting set of update-jobs by the update type. |
|
|
1081
1081
|
|
|
@@ -1186,7 +1186,7 @@ The response includes all ActiveGates that are currently connected to the enviro
|
|
|
1186
1186
|
| config.type | GetAllActiveGatesQueryType | Filters the resulting set of ActiveGates by the ActiveGate type. |
|
|
1187
1187
|
| config.updateStatus | GetAllActiveGatesQueryUpdateStatus | Filters the resulting set of ActiveGates by the auto-update status. |
|
|
1188
1188
|
| config.version | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the version in <code><major>.<minor>.<revision></code> format (for example, <code>1.195.0</code>) here.</p> |
|
|
1189
|
-
| config.versionCompareType | GetAllActiveGatesQueryVersionCompareType | <p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the comparison operator here.</p>
|
|
1189
|
+
| config.versionCompareType | GetAllActiveGatesQueryVersionCompareType | <p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
1190
1190
|
|
|
1191
1191
|
#### Returns
|
|
1192
1192
|
|
|
@@ -1323,7 +1323,7 @@ You can limit the output by using pagination:
|
|
|
1323
1323
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
1324
1324
|
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
1325
1325
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of log entries in a single response payload.</p> <p>The maximal allowed page size is 5000.</p> <p>If not set, 1000 is used.</p> |
|
|
1326
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p>
|
|
1326
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p> <i>default:</i> <code>"-timestamp"</code> |
|
|
1327
1327
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
1328
1328
|
|
|
1329
1329
|
#### Returns
|
|
@@ -2403,6 +2403,47 @@ const data = await extensions_2_0Client.getActiveEnvironmentConfiguration({
|
|
|
2403
2403
|
|
|
2404
2404
|
</div>
|
|
2405
2405
|
|
|
2406
|
+
### getActiveGateGroupsInfo
|
|
2407
|
+
|
|
2408
|
+
<div class="padding-bottom--md">
|
|
2409
|
+
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto">ActiveGateGroupsInfoDto</a>></strong>
|
|
2410
|
+
|
|
2411
|
+
<div class="padding-left--md">
|
|
2412
|
+
|
|
2413
|
+
List all ActiveGate groups available for extension | maturity=IN_DEVELOPMENT
|
|
2414
|
+
|
|
2415
|
+
</div>
|
|
2416
|
+
|
|
2417
|
+
#### Parameters
|
|
2418
|
+
|
|
2419
|
+
| Name | Type | Description |
|
|
2420
|
+
| -------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------ |
|
|
2421
|
+
| config.extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the requested extension 2.0. |
|
|
2422
|
+
| config.extensionVersion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the requested extension 2.0 |
|
|
2423
|
+
|
|
2424
|
+
#### Returns
|
|
2425
|
+
|
|
2426
|
+
Success
|
|
2427
|
+
|
|
2428
|
+
<details>
|
|
2429
|
+
<summary>
|
|
2430
|
+
Code example
|
|
2431
|
+
|
|
2432
|
+
</summary>
|
|
2433
|
+
|
|
2434
|
+
```ts
|
|
2435
|
+
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2436
|
+
|
|
2437
|
+
const data = await extensions_2_0Client.getActiveGateGroupsInfo({
|
|
2438
|
+
extensionName: "...",
|
|
2439
|
+
extensionVersion: "...",
|
|
2440
|
+
});
|
|
2441
|
+
```
|
|
2442
|
+
|
|
2443
|
+
</details>
|
|
2444
|
+
|
|
2445
|
+
</div>
|
|
2446
|
+
|
|
2406
2447
|
### getEnvironmentConfigurationAssetsInfo
|
|
2407
2448
|
|
|
2408
2449
|
<div class="padding-bottom--md">
|
|
@@ -3078,11 +3119,11 @@ Uploads or verifies a new extension 2.0
|
|
|
3078
3119
|
|
|
3079
3120
|
#### Parameters
|
|
3080
3121
|
|
|
3081
|
-
| Name | Type | Description
|
|
3082
|
-
| -------------------------------- | ------------------------------------------------------------------------------- |
|
|
3083
|
-
| config.body<sup>\*required</sup> | Blob |
|
|
3084
|
-
| config.type<sup>\*required</sup> | "application/octet-stream" | "multipart/form-data" |
|
|
3085
|
-
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Only run validation but do not persist the extension even if validation was successful. |
|
|
3122
|
+
| Name | Type | Description |
|
|
3123
|
+
| -------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
3124
|
+
| config.body<sup>\*required</sup> | Blob | |
|
|
3125
|
+
| config.type<sup>\*required</sup> | "application/octet-stream" | "multipart/form-data" | |
|
|
3126
|
+
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Only run validation but do not persist the extension even if validation was successful. <i>default:</i> <code>false</code> |
|
|
3086
3127
|
|
|
3087
3128
|
#### Returns
|
|
3088
3129
|
|
|
@@ -3141,9 +3182,9 @@ Disabled on _Log Management and Analytics, powered by Grail_.
|
|
|
3141
3182
|
| ------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3142
3183
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
3143
3184
|
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
3144
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of results per result page.
|
|
3145
|
-
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p>
|
|
3146
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p>
|
|
3185
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of results per result page. <i>default:</i> <code>1000</code> |
|
|
3186
|
+
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p> <i>default:</i> <code>""</code> |
|
|
3187
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> <i>default:</i> <code>"-timestamp"</code> |
|
|
3147
3188
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
3148
3189
|
|
|
3149
3190
|
#### Returns
|
|
@@ -3192,9 +3233,9 @@ If _Log Management and Analytics, powered by Grail_ is enabled, then a bearer OA
|
|
|
3192
3233
|
| --------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3193
3234
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
3194
3235
|
| config.groupBy | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>The groupings to be included in the response.</p> <p>You can specify several groups in the following format: <code>groupBy=status&groupBy=log.source</code>.</p> <p>If not set, all possible groups are returned. You can use this option to check for possible grouping values.</p> <p>Unique log data attributes (high-cardinality attributes) for example, <code>span_id</code> or <code>trace_id</code> cannot be used for grouping.</p> |
|
|
3195
|
-
| config.maxGroupValues | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of values in each group.</p> <p>You can get up to 100 values per group.</p> <p>If not set, 10 is used.</p>
|
|
3196
|
-
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p>
|
|
3197
|
-
| config.timeBuckets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The number of time slots in the result.</p> <p>The query timeframe is divided equally into the specified number of slots.</p> <p>The minimum length of a slot is 1 ms.</p> <p>If not set, 1 is used.</p>
|
|
3236
|
+
| config.maxGroupValues | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of values in each group.</p> <p>You can get up to 100 values per group.</p> <p>If not set, 10 is used.</p> <i>default:</i> <code>10</code> |
|
|
3237
|
+
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p> <i>default:</i> <code>""</code> |
|
|
3238
|
+
| config.timeBuckets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The number of time slots in the result.</p> <p>The query timeframe is divided equally into the specified number of slots.</p> <p>The minimum length of a slot is 1 ms.</p> <p>If not set, 1 is used.</p> <i>default:</i> <code>1</code> |
|
|
3198
3239
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
3199
3240
|
|
|
3200
3241
|
#### Returns
|
|
@@ -3244,10 +3285,10 @@ If _Log Management and Analytics, powered by Grail_ is enabled, then a bearer OA
|
|
|
3244
3285
|
| Name | Type | Description |
|
|
3245
3286
|
| ------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3246
3287
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
3247
|
-
| config.limit | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The desired amount of log records.</p> <p>The maximal allowed limit is 1000.</p> <p>If not set, 1000 is used.</p>
|
|
3288
|
+
| config.limit | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The desired amount of log records.</p> <p>The maximal allowed limit is 1000.</p> <p>If not set, 1000 is used.</p> <i>default:</i> <code>1000</code> |
|
|
3248
3289
|
| config.nextSliceKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next slice of results. You can find it in the <strong>nextSliceKey</strong> field of the previous response.</p> <p>The first slice is always returned if you don't specify this parameter.</p> <p>If this parameter is set, all other query parameters are ignored.</p> |
|
|
3249
|
-
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p>
|
|
3250
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p>
|
|
3290
|
+
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p> <i>default:</i> <code>""</code> |
|
|
3291
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> <i>default:</i> <code>"-timestamp"</code> |
|
|
3251
3292
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
3252
3293
|
|
|
3253
3294
|
#### Returns
|
|
@@ -4341,10 +4382,10 @@ Gets the statistics about hosts using the network zone
|
|
|
4341
4382
|
|
|
4342
4383
|
#### Parameters
|
|
4343
4384
|
|
|
4344
|
-
| Name | Type | Description
|
|
4345
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
4346
|
-
| config.filter | GetHostStatsQueryFilter | <p>Filters the resulting set of hosts:</p> <ul> <li><code>all</code>: All hosts using the zone.</li> <li><code>configuredButNotConnectedOnly</code>: Hosts from the network zone that use other zones.</li> <li><code>connectedAsAlternativeOnly</code>: Hosts that use the network zone as an alternative.</li> <li><code>connectedAsFailoverOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.</li> <li><code>connectedAsFailoverWithoutOwnActiveGatesOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) and <strong>no</strong> ActiveGates of higher priority are available.</li> </ul> <p>If not set, <code>all</code> is used.</p> |
|
|
4347
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required network zone.
|
|
4385
|
+
| Name | Type | Description |
|
|
4386
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4387
|
+
| config.filter | GetHostStatsQueryFilter | <p>Filters the resulting set of hosts:</p> <ul> <li><code>all</code>: All hosts using the zone.</li> <li><code>configuredButNotConnectedOnly</code>: Hosts from the network zone that use other zones.</li> <li><code>connectedAsAlternativeOnly</code>: Hosts that use the network zone as an alternative.</li> <li><code>connectedAsFailoverOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.</li> <li><code>connectedAsFailoverWithoutOwnActiveGatesOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) and <strong>no</strong> ActiveGates of higher priority are available.</li> </ul> <p>If not set, <code>all</code> is used.</p> <i>default:</i> <code>"all"</code> |
|
|
4388
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required network zone. |
|
|
4348
4389
|
|
|
4349
4390
|
#### Returns
|
|
4350
4391
|
|
|
@@ -4864,15 +4905,15 @@ Returns all releases
|
|
|
4864
4905
|
|
|
4865
4906
|
#### Parameters
|
|
4866
4907
|
|
|
4867
|
-
| Name | Type | Description
|
|
4868
|
-
| ----------------------- | ------------------------------------------------------------------------------- |
|
|
4869
|
-
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>).
|
|
4870
|
-
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p>
|
|
4871
|
-
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>
|
|
4872
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of Releases in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p>
|
|
4873
|
-
| config.releasesSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.</li> <li>Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.</li> <li>Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId("id").</li> <li>Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion("version"). Filters for all releases that contain the given value in their version. The filter is case-insensitive.</li> </ul> <p>To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").</p> <p>The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").</p> |
|
|
4874
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p>
|
|
4875
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
4908
|
+
| Name | Type | Description |
|
|
4909
|
+
| ----------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4910
|
+
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>). <i>default:</i> <code>false</code> |
|
|
4911
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
4912
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
4913
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of Releases in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
|
|
4914
|
+
| config.releasesSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.</li> <li>Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.</li> <li>Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId("id").</li> <li>Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion("version"). Filters for all releases that contain the given value in their version. The filter is case-insensitive.</li> </ul> <p>To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").</p> <p>The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").</p> <i>default:</i> <code>""</code> |
|
|
4915
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p> <i>default:</i> <code>"name"</code> |
|
|
4916
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
4876
4917
|
|
|
4877
4918
|
#### Returns
|
|
4878
4919
|
|
|
@@ -5603,7 +5644,7 @@ Creates an alert of the provided alert type for an SLO
|
|
|
5603
5644
|
| config.body<sup>\*required</sup> | <a href="#abstractsloalertdto">AbstractSloAlertDto</a> | |
|
|
5604
5645
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
5605
5646
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required SLO. |
|
|
5606
|
-
| config.timeFrame | CreateAlertQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p>
|
|
5647
|
+
| config.timeFrame | CreateAlertQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> <i>default:</i> <code>"CURRENT"</code> |
|
|
5607
5648
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5608
5649
|
|
|
5609
5650
|
#### Returns
|
|
@@ -5744,19 +5785,19 @@ By default the values are calculated for the SLO's own timeframe. You can use a
|
|
|
5744
5785
|
|
|
5745
5786
|
#### Parameters
|
|
5746
5787
|
|
|
5747
|
-
| Name | Type | Description
|
|
5748
|
-
| --------------------- | ------------------------------------------------------------------------------- |
|
|
5749
|
-
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>).
|
|
5750
|
-
| config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>).
|
|
5751
|
-
| config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25.
|
|
5752
|
-
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p>
|
|
5753
|
-
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>
|
|
5754
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p>
|
|
5755
|
-
| config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>).
|
|
5756
|
-
| config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p> |
|
|
5757
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p>
|
|
5758
|
-
| config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p>
|
|
5759
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
5788
|
+
| Name | Type | Description |
|
|
5789
|
+
| --------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5790
|
+
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>). <i>default:</i> <code>false</code> |
|
|
5791
|
+
| config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>). <i>default:</i> <code>"true"</code> |
|
|
5792
|
+
| config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25. <i>default:</i> <code>"false"</code> |
|
|
5793
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
5794
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
5795
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p> |
|
|
5796
|
+
| config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>). <i>default:</i> <code>true</code> |
|
|
5797
|
+
| config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p> <i>default:</i> <code>""</code> |
|
|
5798
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p> <i>default:</i> <code>"name"</code> |
|
|
5799
|
+
| config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> <i>default:</i> <code>"CURRENT"</code> |
|
|
5800
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5760
5801
|
|
|
5761
5802
|
#### Returns
|
|
5762
5803
|
|
|
@@ -5803,7 +5844,7 @@ If **from** and **to** parameters are provided, the SLO is calculated for that t
|
|
|
5803
5844
|
| ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5804
5845
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
5805
5846
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required SLO. |
|
|
5806
|
-
| config.timeFrame | GetSloByIdQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p>
|
|
5847
|
+
| config.timeFrame | GetSloByIdQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> <i>default:</i> <code>"CURRENT"</code> |
|
|
5807
5848
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5808
5849
|
|
|
5809
5850
|
#### Returns
|
|
@@ -5953,13 +5994,13 @@ If no object along the hierarchy is persisted, the default value as defined in t
|
|
|
5953
5994
|
|
|
5954
5995
|
#### Parameters
|
|
5955
5996
|
|
|
5956
|
-
| Name | Type | Description
|
|
5957
|
-
| ------------------ | ----------------------------------------------------------------------------- |
|
|
5958
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
5959
|
-
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>
|
|
5960
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p>
|
|
5961
|
-
| config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p>
|
|
5962
|
-
| config.scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scope. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, this parameter is required.</p>
|
|
5997
|
+
| Name | Type | Description |
|
|
5998
|
+
| ------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5999
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> <i>default:</i> <code>"origin,value"</code> |
|
|
6000
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
6001
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
6002
|
+
| config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
6003
|
+
| config.scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scope. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, this parameter is required.</p> |
|
|
5963
6004
|
|
|
5964
6005
|
#### Returns
|
|
5965
6006
|
|
|
@@ -6054,7 +6095,7 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
6054
6095
|
| Name | Type | Description |
|
|
6055
6096
|
| ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
6056
6097
|
| config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
6057
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p>
|
|
6098
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> <i>default:</i> <code>"objectId,value"</code> |
|
|
6058
6099
|
| config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 512.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
|
|
6059
6100
|
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
6060
6101
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
@@ -6103,10 +6144,10 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
6103
6144
|
|
|
6104
6145
|
#### Parameters
|
|
6105
6146
|
|
|
6106
|
-
| Name | Type | Description
|
|
6107
|
-
| -------------------------------- | ------------------------------------------------------------------------------- |
|
|
6108
|
-
| config.body<sup>\*required</sup> | Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>> |
|
|
6109
|
-
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. |
|
|
6147
|
+
| Name | Type | Description |
|
|
6148
|
+
| -------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
6149
|
+
| config.body<sup>\*required</sup> | Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>> | |
|
|
6150
|
+
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. <i>default:</i> <code>false</code> |
|
|
6110
6151
|
|
|
6111
6152
|
#### Returns
|
|
6112
6153
|
|
|
@@ -7218,6 +7259,33 @@ Global configuration of ActiveGates auto-update.
|
|
|
7218
7259
|
| globalSetting<sup>\*required</sup> | ActiveGateGlobalAutoUpdateConfigGlobalSetting |
|
|
7219
7260
|
| metadata | <a href="#configurationmetadata">ConfigurationMetadata</a> |
|
|
7220
7261
|
|
|
7262
|
+
### ActiveGateGroupInfoDto
|
|
7263
|
+
|
|
7264
|
+
Metadata for each ActiveGate group.
|
|
7265
|
+
|
|
7266
|
+
| Name | Type | Description |
|
|
7267
|
+
| -------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
7268
|
+
| activeGates | Array<<a href="#activegateinfodto">ActiveGateInfoDto</a>> | ActiveGates in group. |
|
|
7269
|
+
| availableActiveGates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of ActiveGates in group available for Extension. |
|
|
7270
|
+
| groupName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ActiveGate group name. |
|
|
7271
|
+
|
|
7272
|
+
### ActiveGateGroupsInfoDto
|
|
7273
|
+
|
|
7274
|
+
ActiveGate groups metadata for extensions.
|
|
7275
|
+
|
|
7276
|
+
| Name | Type | Description |
|
|
7277
|
+
| ------------------------------------- | ------------------------------------------------------------------------- | ----------------------------------- |
|
|
7278
|
+
| activeGateGroups<sup>\*required</sup> | Array<<a href="#activegategroupinfodto">ActiveGateGroupInfoDto</a>> | Metadata for each ActiveGate group. |
|
|
7279
|
+
|
|
7280
|
+
### ActiveGateInfoDto
|
|
7281
|
+
|
|
7282
|
+
ActiveGates in group.
|
|
7283
|
+
|
|
7284
|
+
| Name | Type | Description |
|
|
7285
|
+
| ------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
|
7286
|
+
| errors | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | List of errors if Extension cannot be run on the ActiveGate |
|
|
7287
|
+
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | ActiveGate ID. |
|
|
7288
|
+
|
|
7221
7289
|
### ActiveGateList
|
|
7222
7290
|
|
|
7223
7291
|
A list of ActiveGates.
|
|
@@ -10537,16 +10605,16 @@ Metadata map for the execution batch.
|
|
|
10537
10605
|
|
|
10538
10606
|
Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.
|
|
10539
10607
|
|
|
10540
|
-
| Name | Type | Description
|
|
10541
|
-
| ------------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
10542
|
-
| failOnPerformanceIssue | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the execution will fail in case of performance issue. |
|
|
10543
|
-
| failOnSslWarning | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. |
|
|
10544
|
-
| group | <a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a> |
|
|
10545
|
-
| metadata | <a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a> |
|
|
10546
|
-
| monitors | Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>> | List of monitors to be triggered.
|
|
10547
|
-
| processingMode | SyntheticOnDemandExecutionRequestProcessingMode |
|
|
10548
|
-
| stopOnProblem | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, no executions will be scheduled if a problem occurs.
|
|
10549
|
-
| takeScreenshotsOnSuccess | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the screenshots will be taken during the execution of a browser monitor.
|
|
10608
|
+
| Name | Type | Description |
|
|
10609
|
+
| ------------------------ | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
10610
|
+
| failOnPerformanceIssue | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the execution will fail in case of performance issue. <i>default:</i> <code>true</code> |
|
|
10611
|
+
| failOnSslWarning | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. <i>default:</i> <code>true</code> |
|
|
10612
|
+
| group | <a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a> | |
|
|
10613
|
+
| metadata | <a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a> | |
|
|
10614
|
+
| monitors | Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>> | List of monitors to be triggered. |
|
|
10615
|
+
| processingMode | SyntheticOnDemandExecutionRequestProcessingMode | <i>default:</i> <code>"STANDARD"</code> |
|
|
10616
|
+
| stopOnProblem | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, no executions will be scheduled if a problem occurs. <i>default:</i> <code>false</code> |
|
|
10617
|
+
| takeScreenshotsOnSuccess | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the screenshots will be taken during the execution of a browser monitor. <i>default:</i> <code>false</code> |
|
|
10550
10618
|
|
|
10551
10619
|
### SyntheticOnDemandExecutionRequestGroup
|
|
10552
10620
|
|
|
@@ -10567,13 +10635,13 @@ String to string map of metadata properties for execution
|
|
|
10567
10635
|
|
|
10568
10636
|
Contains monitors to be executed on demand from the locations specified.
|
|
10569
10637
|
|
|
10570
|
-
| Name | Type | Description
|
|
10571
|
-
| ------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
10572
|
-
| customizedScript | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> |
|
|
10573
|
-
| executionCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of times the monitor is to be executed per location; if not set, the monitor will be executed once. |
|
|
10574
|
-
| locations | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations from where the monitor is to be executed.
|
|
10575
|
-
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier.
|
|
10576
|
-
| repeatMode | SyntheticOnDemandExecutionRequestMonitorRepeatMode |
|
|
10638
|
+
| Name | Type | Description |
|
|
10639
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10640
|
+
| customizedScript | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
|
|
10641
|
+
| executionCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of times the monitor is to be executed per location; if not set, the monitor will be executed once. <i>default:</i> <code>1</code> |
|
|
10642
|
+
| locations | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations from where the monitor is to be executed. |
|
|
10643
|
+
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier. |
|
|
10644
|
+
| repeatMode | SyntheticOnDemandExecutionRequestMonitorRepeatMode | <i>default:</i> <code>"SEQUENTIAL"</code> |
|
|
10577
10645
|
|
|
10578
10646
|
### SyntheticOnDemandExecutionResult
|
|
10579
10647
|
|