DescribeMultiContainerGroupMetric - Elastic Container Instance

You can call the DescribeContainerGroupMetric operation to query the monitoring data of an ECI instance.

Operation description

This operation returns only the most recent monitoring record for each ECI instance.
You can query monitoring data only for ECI instances created after 15:00 on April 3, 2019 (UTC+8).

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

eci:DescribeMultiContainerGroupMetric

get

*containergroup

acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ContainerGroupIds	string	Yes	The IDs of the ECI instances. The value is the same as the container group ID. Specify the IDs in a JSON array. You can specify a maximum of 20 IDs.	["eci-2zegym1qhbmdfr1s**","eci-2ze39w5svzj5ic34**"]
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-acfmzw2jz2z****
MetricType	string	No	The type of monitoring data. Only summary is supported. If you set this parameter to summary, Records are returned.	summary

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	B8756BA0-6452-419C-9727-37A6209C85E0
MonitorDatas	array<object>	The collection of monitoring data.
	array<object>
Records	array<object>	The details of the monitoring data.
	array<object>
Network	object	The network data.
Interfaces	array<object>	The data of the network interface card (NIC).
	object
RxErrors	integer	The total number of errors that occurred when packets were received.	0
TxDrops	integer	The total number of sent packets that were dropped.	0
TxBytes	integer	The total number of bytes sent.	1381805699
RxPackets	integer	The total number of packets received.	4800583
TxPackets	integer	The total number of packets sent.	5158427
Name	string	The name of the NIC.	eth0
TxErrors	integer	The total number of errors that occurred when packets were sent.	0
RxBytes	integer	The total number of bytes received.	505001954
RxDrops	integer	The total number of received packets that were dropped.	0
CPU	object	The CPU data.
UsageNanoCores	integer	The CPU usage in the sampling window, in nanocores.	0
Limit	integer	The CPU limit. The value is the number of vCPUs multiplied by 1,000.	2000
UsageCoreNanoSeconds	integer	The total CPU usage over time.	70769883
Load	integer	The average load over the last 10 seconds.	0
Disk	array<object>	The disk data.
	object
WriteBytes	integer	The amount of data written to the disk, in bytes.	1375109120
Device	string	The disk name.	/dev/vda
WriteIo	integer	This parameter is not in use.	123
ReadBytes	integer	The amount of data read from the disk, in bytes.	210714112
ReadIo	integer	This parameter is not in use.	123
Timestamp	string	The time when the monitoring data was collected. The time is in the RFC 3339 format.	2019-12-19T02:31:54Z
Memory	object	The memory data.
Rss	integer	The resident set size (RSS), which indicates the physical memory that is used.	1593344
UsageBytes	integer	The memory usage.	11153408
WorkingSet	integer	The working set size.	5521408
AvailableBytes	integer	The available memory.	4289445888
Cache	integer	The cache size.	7028736
Containers	array<object>	The details of the monitoring data about the container.
	array<object>
CPU	object	The CPU data of the container.
UsageNanoCores	integer	The CPU usage in the sampling window, in nanocores.	0
Limit	integer	The CPU limit. The value is the number of vCPUs multiplied by 1,000.	321234
UsageCoreNanoSeconds	integer	The total CPU usage over time.	40876694
Load	integer	The average load over the last 10 seconds.	12341
Memory	object	The memory data of the container.
Rss	integer	The RSS, which indicates the physical memory that is used.	9289728
UsageBytes	integer	The memory usage.	9289728
WorkingSet	integer	The working set size.	9289728
AvailableBytes	integer	The available memory.	4285091840
Cache	integer	The cache size.	9289728
Name	string	The name of the container.	test1
Filesystem	array<object>	The data of the file system partition.
	object
Capacity	integer	The total space.	41610981376
Available	integer	The available space.	35319836672
FsName	string	The partition name.	/dev/root
Usage	integer	The used space.	4368744448
ContainerGroupId	string	The instance ID, which is the container group ID.	eci-bp15oolgorelvhfb****

Examples

Success response

JSON format

{
  "RequestId": "B8756BA0-6452-419C-9727-37A6209C85E0",
  "MonitorDatas": [
    {
      "Records": [
        {
          "Network": {
            "Interfaces": [
              {
                "RxErrors": 0,
                "TxDrops": 0,
                "TxBytes": 1381805699,
                "RxPackets": 4800583,
                "TxPackets": 5158427,
                "Name": "eth0",
                "TxErrors": 0,
                "RxBytes": 505001954,
                "RxDrops": 0
              }
            ]
          },
          "CPU": {
            "UsageNanoCores": 0,
            "Limit": 2000,
            "UsageCoreNanoSeconds": 70769883,
            "Load": 0
          },
          "Disk": [
            {
              "WriteBytes": 1375109120,
              "Device": "/dev/vda",
              "WriteIo": 123,
              "ReadBytes": 210714112,
              "ReadIo": 123
            }
          ],
          "Timestamp": "2019-12-19T02:31:54Z",
          "Memory": {
            "Rss": 1593344,
            "UsageBytes": 11153408,
            "WorkingSet": 5521408,
            "AvailableBytes": 4289445888,
            "Cache": 7028736
          },
          "Containers": [
            {
              "CPU": {
                "UsageNanoCores": 0,
                "Limit": 321234,
                "UsageCoreNanoSeconds": 40876694,
                "Load": 12341
              },
              "Memory": {
                "Rss": 9289728,
                "UsageBytes": 9289728,
                "WorkingSet": 9289728,
                "AvailableBytes": 4285091840,
                "Cache": 9289728
              },
              "Name": "test1"
            }
          ],
          "Filesystem": [
            {
              "Capacity": 41610981376,
              "Available": 35319836672,
              "FsName": "/dev/root",
              "Usage": 4368744448
            }
          ]
        }
      ],
      "ContainerGroupId": "eci-bp15oolgorelvhfb****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.