DescribeSnapshotMonitorData-阿里云帮助中心

Operation description

Usage notes

Take note of the following items:

Up to 400 monitoring data entries can be returned at a time. Make sure that the TotalCount value does not exceed 400. The value is calculated by using the following formula: TotalCount = (EndTime - StartTime)/Period. If the TotalCount value is greater than 400, the InvalidParameter.TooManyDataQueried error is returned.
You can query the monitoring data of snapshot sizes in the last 30 days. If the value of StartTime is more than 30 days earlier than the current time, an error is returned.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeSnapshotMonitorData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the value of seconds (ss) is not 00, the time is rounded up to the next minute.	2019-05-10T00:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the value of seconds (ss) is not 00, the time is rounded up to the next minute.	2019-05-10T03:00:00Z
Period	integer	No	The interval at which to query the monitoring data of snapshot sizes. Unit: seconds. Valid values: 60 600 3600 Default value: 60.	60
Category	string	No	The type of the snapshot. Valid values: Standard: standard snapshot Flash: local snapshot Archive: archive snapshot Default value: Standard.	Standard

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9F8163A8-F5DE-47A2-A572-4E062D223E09
MonitorData	object
DataPoint	array<object>	The monitoring data of snapshot sizes.
	object
Size	integer	The total size of snapshots. Unit: bytes.	243036848128
TimeStamp	string	The timestamp that corresponds to a snapshot size.	2019-05-10T04:00:00Z

Examples

Success response

JSON format

{
  "RequestId": "9F8163A8-F5DE-47A2-A572-4E062D223E09",
  "MonitorData": {
    "DataPoint": [
      {
        "Size": 243036848128,
        "TimeStamp": "2019-05-10T04:00:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	The specified StartTime parameter does not conform to the specification.
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	The specified EndTime parameter is invalid.
400	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.
400	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
400	InvalidParameter.TooManyDataQueried	Too many data queried.
400	Throttling	Request was denied due to request throttling.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.