Dynatrace platform subscription API v1 - GET limits
Lists all unit-consumption limits configured for a Dynatrace platform subscription.
The request produces an application/json
payload.
GET |
|
Authentication
To execute this request, you need the Allow read access for usage and consumption resources (account-uac-read
) scope assigned to your token. To learn how to obtain and use it, see Authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
accountUuid | string | The ID of the required account. You can find the UUID on the Account > Account management API page, during creation of an OAuth client. | path | required |
subscriptionId | number | The ID of the required subscription. You can fetch the list of subscriptions with the GET subscriptions call. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | ClaBudgetLimitRecordListDto | Success. The response contains all limits of your account. |
Response body objects
The ClaBudgetLimitRecordListDto
object
Element | Type | Description |
---|---|---|
totalCount | number | The number of entries in the list. |
records | ClaBudgetLimitRecordsDto[] | - |
The ClaBudgetLimitRecordsDto
object
Element | Type | Description |
---|---|---|
clusterUuid | string | The ID of the cluster to which the limit applies. |
environmentUuid | string | The ID of the environment to which the limit applies. |
dimensionName | string | The consumption units to which the limit applies. |
tierType | string | -
|
startDate | string | The date and time when the restriction takes effect in The limit is not enforeced in real-time and might lead to overages. |
endDate | string | The date and time when the restriction ends in The limit is not enforeced in real-time and might lead to overages. |
amount | number | The limit for the cluster or environment. If consumption exceeds the limit, monitoring will stop. |
subscriptionId | number | The ID of the Dynatrace Platform Subscription. |
Response body JSON model
{"totalCount": 1,"records": [{"clusterUuid": "string","environmentUuid": "string","dimensionName": "string","tierType": "LIMIT","startDate": "string","endDate": "string","amount": 1,"subscriptionId": 1}]}
Example
In this example, the request shows the unit-consumption limits in the subscription with the ID of 40655 for the account with the ID of 2b794097-8ad2-4b32-b923-0131da2eeddf.
curl --request GET \--url 'https://api.dynatrace.com/sub/v1/accounts/2b794097-8ad2-4b32-b923-0131da2eeddf/subscriptions/40655/limits' \--header 'Authorization: Bearer abcdefjhij1234567890'
Request URL
https://api.dynatrace.com/sub/v1/accounts/2b794097-8ad2-4b32-b923-0131da2eeddf/subscriptions/40655/limits
Response body
{"totalCount": 1,"records": [{"clusterUuid": "","environmentUuid": "mySampleEnv","dimensionName": "Total","tierType": "LIMIT","startDate": "2020-07-23T00:00:00Z","endDate": "2022-04-22T23:59:59Z","amount": 300000,"subscriptionId": 40655}]}