Help Center/ CloudPond/ API Reference/ API/ Edge Site Monitoring/ Viewing Resource Capacity at an Edge Site

Updated on 2025-10-28 GMT+08:00

View PDF

Viewing Resource Capacity at an Edge Site

Function

This API is used to view resource capacity at an edge site.

This API supports fine-grained permissions for enterprise projects. For details, see ies:edgeSite:getMetricData.

URI

GET /v1/{domain_id}/edge-sites/{site_id}/metric-data

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the URI.
site_id	Yes	String	Edge site ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
dim	No	String	Dimension for query. site_id: site ID for querying compute and storage resource capacity flavor: flavor for querying the compute resource usage storage: storage type for querying the storage resource usage flavor_capacity: flavor capacity for querying the predicted number of available instances of each flavor storage_pool: storage pool for querying the usage of each storage pool at a site

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
metric_data	Array of MetricDataDetail objects	Monitoring data.

**Table 5** MetricDataDetail
Parameter	Type	Description
name	String	Monitoring metric name. Options: cpu_used: the number of used vCPU cores queried by site ID or flavor cpu_available_total: the total number of available vCPU cores queried by site ID or flavor. cpu_total: the total number of vCPU cores (including the cores reserved for HA) queried by site ID or flavor memory_used: the used memory queried by site ID or flavor. The unit is GB. memory_available_total: the total available memory queried by site ID or flavor. The unit is GB. memory_total: the total memory (including the memory reserved for HA) queried by site ID or flavor. The unit is GB. capacity_used: the used block storage queried by site ID or storage type. The unit is GiB. capacity_available_total: the available total block storage (storage subscribed by users) queried by site ID or storage type. The unit is GiB. capacity_total: the maximum block storage subscribed (it may be greater than the enabled storage) queried by site ID or storage type. The unit is GiB. available: the number of remaining available instances of the flavor queried by flavor capacity.
value	Long	Metic value.
read_at	String	Time when the record was last modified.
dimension	dimension object	Dimension information.

**Table 6** dimension
Parameter	Type	Description
name	String	Dimension name.
value	String	Dimension value.

Example Request

Querying capacity information about an edge site

GET https://{ies_endpoint}/v1/{domain_id}/edge-sites/{site_id}/metric-data?dim=site_id

Example Response

Status code: 200

successful operation

{
  "metric_data" : [ {
    "name" : "cpu_used",
    "value" : 136,
    "read_at" : "2022-04-28T08:15:00.428Z",
    "dimension" : {
      "name" : "site_id",
      "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc"
    }
  }, {
    "name" : "cpu_total",
    "value" : 184,
    "read_at" : "2022-04-28T08:15:00.428Z",
    "dimension" : {
      "name" : "site_id",
      "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc"
    }
  }, {
    "name" : "memory_used",
    "value" : 272,
    "read_at" : "2022-04-28T08:15:00.428Z",
    "dimension" : {
      "name" : "site_id",
      "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc"
    }
  }, {
    "name" : "memory_total",
    "value" : 648,
    "read_at" : "2022-04-28T08:15:00.428Z",
    "dimension" : {
      "name" : "site_id",
      "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc"
    }
  }, {
    "name" : "capacity_used",
    "value" : 5707,
    "read_at" : "2022-04-28T08:15:00.501Z",
    "dimension" : {
      "name" : "site_id",
      "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc"
    }
  }, {
    "name" : "capacity_total",
    "value" : 113090,
    "read_at" : "2022-04-28T08:15:00.501Z",
    "dimension" : {
      "name" : "site_id",
      "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc"
    }
  } ]
}