All Products
Search
Document Center

Quota Center:ListAlarmHistories

Last Updated:Sep 06, 2024

Queries the alert records.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quotas:ListAlarmHistoriesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

The token that marks the position from which you want to start the query. If you leave this parameter empty, the query starts from the beginning.

1
MaxResultsintegerNo

The maximum number of records that can be returned for the query.

Valid values: 1 to 200. Default value: 30.

30
KeywordstringNo

The keyword that is used for the query.

Quantity
StartTimelongNo

The beginning of the time range to query.

20201020
EndTimelongNo

The end of the time range to query.

20201024
ProductCodestringNo

The abbreviation of the Alibaba Cloud service name.

Note For more information, see Alibaba Cloud services that support Quota Center.
ecs
AlarmIdstringNo

The ID of the alert.

18b3be23-b7b0-4d45-91bc-d0c331aa****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

None.

TotalCountinteger

The total number of records that are returned for the query.

4
NextTokenstring

The token that marks the position at which the query ends. An empty value indicates that all data is returned.

1
RequestIdstring

The ID of the request.

CB38DDF9-B1E0-48C1-9966-19C443C2841E
MaxResultsinteger

The maximum number of records that are returned for the query.

4
AlarmHistoriesarray<object>

The details of the quota alert records.

object
QuotaUsagefloat

The used quota.

31
ThresholdPercentfloat

The percentage of the quota alert threshold.

80
CreateTimestring

The time when the quota alert rule was created.

2021-01-24T09:20:09Z
QuotaActionCodestring

The quota ID.

q_security-groups
AlarmNamestring

The name of the quota alert.

security_groups
NotifyTargetstring

The quota alert contact.

accountContact
NotifyChannelsarray

The notification methods of the quota alert.

string

The notification methods of the quota alert. Valid values:

  • sms: text messages
  • email: emails
["sms", "email"]
Thresholdfloat

The threshold to trigger quota alerts.

29
ProductCodestring

The abbreviation of the Alibaba Cloud service name.

ecs

Examples

Sample success responses

JSONformat

{
  "TotalCount": 4,
  "NextToken": "1",
  "RequestId": "CB38DDF9-B1E0-48C1-9966-19C443C2841E",
  "MaxResults": 4,
  "AlarmHistories": [
    {
      "QuotaUsage": 31,
      "ThresholdPercent": 80,
      "CreateTime": "2021-01-24T09:20:09Z",
      "QuotaActionCode": "q_security-groups",
      "AlarmName": "security_groups\n",
      "NotifyTarget": "accountContact",
      "NotifyChannels": [
        "[\"sms\", \"email\"]"
      ],
      "Threshold": 29,
      "ProductCode": "ecs"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTimeInvalid StartTimeThe specified start time is invalid.
400InvalidEndTimeInvalid EndTimeThe specified end time is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-31The Error code has changed. The request parameters of the API has changedView Change Details