ESA Edge Container App Metrics API Overview - Edge Security Acceleration

Retrieves monitoring data for metrics of Edge Service Agent (ESA) edge containers.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Tenant	string	No	The tenant.	t-xxxx
App	string	Yes	Basic information about the application.	app-xxxx
Locate	string	No	The region.	huizhou
Isp	string	No	The Internet Service Provider (ISP).	telecom,unicom,mobile
Fields	string	Yes	The metric fields. Valid values: container_fs_writes_bytes_avg : Write IO container_memory_rss : Memory usage container_memory_rss_quota_rate : Memory usage as a percentage of the limit container_cpu_usage_seconds_quota_rate : CPU usage as a percentage of the limit container_cpu_usage_seconds_total : Number of CPU cores pod_ready_rate : Pod ready rate container_fs_reads_bytes_avg : Read IO	pod_ready_rate
StartTime	string	No	The start time. The date must be in ISO 8601 format and use UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2024-09-02T15:04:05Z
EndTime	string	No	The end time to retrieve data. The date must be in ISO 8601 format and use UTC. The format is yyyy-MM-ddTHH:mm:ssZ. Note The end time must be later than the start time.	2024-09-02T16:04:05Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
CpuUsageSecondsQuotaRateAvg	number	The average CPU usage as a percentage of the limit.	0.1
CpuUsageSecondsTotalAvg	number	Average CPU core usage, in seconds.	2
FsReadsBytesAvgAvg	number	The average read IO.	0
FsWritesBytesAvgAvg	number	The average write IO.	0
MemoryRssAvg	number	The average memory usage.	0.1
MemoryRssQuotaRateAvg	number	The average memory usage as a percentage of the limit.	1
PodReadyRateAvg	number	The average pod ready rate.	100
Points	array<object>	The time and value of each data point for the chart.
	object	The value and time of a data point.
Time	string	The time of the data point. The format is yyyy-MM-ddTHH:mm:ssZ in UTC.	2024-01-18T15:04:05Z
ContainerCpuUsageSecondsQuotaRate	number	The CPU usage as a percentage of the limit.	0.1
ContainerCpuUsageSecondsTotal	number	The number of CPU cores.	2
ContainerFsReadsBytesAvg	number	The read IO.	0
ContainerFsWritesBytesAvg	number	The write IO.	0
ContainerMemoryRss	number	The memory usage.	0.1
ContainerMemoryRssQuotaRate	number	The memory usage as a percentage of the limit.	1
PodReadyRate	number	The pod ready rate.	100
RequestId	string	Id of the request	35C66C7B-671H-4297-9187-2C4477247A78

Examples

Success response

JSON format

{
  "CpuUsageSecondsQuotaRateAvg": 0.1,
  "CpuUsageSecondsTotalAvg": 2,
  "FsReadsBytesAvgAvg": 0,
  "FsWritesBytesAvgAvg": 0,
  "MemoryRssAvg": 0.1,
  "MemoryRssQuotaRateAvg": 1,
  "PodReadyRateAvg": 100,
  "Points": [
    {
      "Time": "2024-01-18T15:04:05Z",
      "ContainerCpuUsageSecondsQuotaRate": 0.1,
      "ContainerCpuUsageSecondsTotal": 2,
      "ContainerFsReadsBytesAvg": 0,
      "ContainerFsWritesBytesAvg": 0,
      "ContainerMemoryRss": 0.1,
      "ContainerMemoryRssQuotaRate": 1,
      "PodReadyRate": 100
    }
  ],
  "RequestId": "35C66C7B-671H-4297-9187-2C4477247A78"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	Please provide the correct end time format. The date format follows ISO8601 notation and uses UTC time. The format is: yyyy-MM-ddTHH:mm:ssZ.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	Please provide the correct start time format. The date format follows ISO8601 notation and uses UTC time in the format yyyy-MM-ddTHH:mm:ssZ.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.