DescribeEipMonitorData - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeEipMonitorData for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

vpc:DescribeEipMonitorData

get

*Address

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No
AllocationId	string	Yes
StartTime	string	Yes
EndTime	string	Yes
Period	integer	No

Response elements

Element	Type	Description	Example
	object
RequestId	string
EipMonitorDatas	object
EipMonitorData	array<object>
	object
EipTX	integer	The EIP transmit traffic (TX), measured in kbit/s.
EipPackets	integer	The number of EIP network packets per second (pps).
EipBandwidth	integer	The EIP bandwidth, in Mbit/s.
TimeStamp	string	The timestamp of the data point. The value is a UTC time in the `YYYY-MM-DDThh:mm:ssZ` format.
EipFlow	integer	The EIP connection count.
EipRX	integer	The EIP receive traffic (RX), measured in kbit/s.

Examples

Success response

JSON format

{
  "RequestId": "",
  "EipMonitorDatas": {
    "EipMonitorData": [
      {
        "EipTX": 0,
        "EipPackets": 0,
        "EipBandwidth": 0,
        "TimeStamp": "",
        "EipFlow": 0,
        "EipRX": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.TooMany	monitor parameter too many data required.
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	InvalidAllocationId.NotFound	Specified allocation id is not found.
400	InvalidParameter	Specified value of "Period" is not valid
400	OperationDenied.TooManyDataQueried	Specified operation is denied as too many data to return.	The number of data entries queried exceeds the upper limit. Shorten the interval.
400	InvalidRegionInstance	The specified InstanceId does not exist in given region.	The instance does not exist in the specified region.
404	InvalidIpInstanceId.NotFound	The specified Eip InstanceId does not exist in our records.
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.