DescribeMultiContainerGroupMetric - Elastic Container Instance

Queries the monitoring data of elastic container instances.

Operation description

Only the latest entry of monitoring data of each elastic container instance is returned.
You can query only the monitoring data of elastic container instances that are created after April 3, 2019 15:00:00 UTC+8.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
eci:DescribeMultiContainerGroupMetric	READ	containergroup acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}	eci:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
ContainerGroupIds	string	Yes	The instance ID. The value is a JSON array. You can specify up to 20 instance IDs at a time.	["eci-2zegym1qhbmdfr1s**","eci-2ze39w5svzj5ic34**"]
ResourceGroupId	string	No	The ID of the resource group to which the elastic container instances belong.	rg-acfmzw2jz2z****
MetricType	string	No	The type of the monitoring data. Set the value to summary. This value indicates that records are returned.	summary

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B8756BA0-6452-419C-9727-37A6209C85E0
MonitorDatas	object []	The monitoring data of the elastic container instances.
Records	object []	The details about monitoring data.
Network	object	The monitoring data of the network.
Interfaces	object []	The monitoring data of network interface controllers (NICs).
RxErrors	long	The number of receipt errors.	0
TxDrops	long	The number of packets that fail to arrive at their destination.	0
TxBytes	long	The total number of bytes sent.	1381805699
RxPackets	long	The total number of packets received.	4800583
TxPackets	long	The total number of packets sent.	5158427
Name	string	The name of the NIC.	eth0
TxErrors	long	The total number of sending errors.	0
RxBytes	long	The total number of bytes received.	505001954
RxDrops	long	The number of packets that fail to be received.	0
CPU	object	The monitoring data of vCPUs.
UsageNanoCores	long	The vCPU usage in the sampling window. Unit for the sampling window: nanoseconds.	0
Limit	long	The upper limit of vCPU usage. The calculation formula for this parameter: The number of vCPUs × 1000.	2000
UsageCoreNanoSeconds	long	The cumulative usage of vCPUs.	70769883
Load	long	The average load in the last 10 seconds.	0
Disk	object []	The monitoring data of disks.
WriteBytes	long	The amount of data that was written to the disk. Unit: bytes.	1375109120
Device	string	The name of the disk.	/dev/vda
WriteIo	long	This parameter is unavailable for public use.	123
ReadBytes	long	The amount of data that was read from the disk. Unit: bytes.	210714112
ReadIo	long	This parameter is unavailable for public use.	123
Timestamp	string	The time when the entry of monitoring data was collected. The time follows the RFC 3339 format.	2019-12-19T02:31:54Z
Memory	object	The monitoring data of the memory.
Rss	long	The size of the resident memory set, which indicates the size of the physical memory that is actually used. Unit: bytes.	1593344
UsageBytes	long	The size of the used memory. Unit: bytes.	11153408
WorkingSet	long	The usage of the working set. Unit: bytes.	5521408
AvailableBytes	long	The size of the available memory. Unit: bytes.	4289445888
Cache	long	The size of the cache. Unit: bytes.	7028736
Containers	object []	The monitoring data of containers.
CPU	object	The vCPU monitoring data of the container.
UsageNanoCores	long	The vCPU usage in the sampling window. Unit for the sampling window: nanoseconds.	0
Limit	long	The upper limit of vCPU usage. The calculation formula for this parameter: The number of vCPUs × 1000.	321234
UsageCoreNanoSeconds	long	The cumulative usage of vCPUs.	40876694
Load	long	The average load in the last 10 seconds.	12341
Memory	object	The memory monitoring data of the container.
Rss	long	The size of the resident memory set, which indicates the size of the physical memory that is actually used. Unit: bytes.	9289728
UsageBytes	long	The size of the used memory. Unit: bytes.	9289728
WorkingSet	long	The usage of the working set. Unit: bytes.	9289728
AvailableBytes	long	The size of the available memory. Unit: bytes.	4285091840
Cache	long	The size of the cache. Unit: bytes.	9289728
Name	string	The name.	test1
Filesystem	object []	The monitoring data of file system partitions.
Capacity	long	The total file system space.	41610981376
Available	long	The size of the available space.	35319836672
FsName	string	The name of the partition.	/dev/root
Usage	long	The size of used space.	4368744448
ContainerGroupId	string	The ID of the elastic container instance.	eci-bp15oolgorelvhfb****

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time

Summary of changes

Operation

2022-09-19

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.