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

Updated on 2025-12-08 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ies:edgeSite:getMetricData	Read	edgeSite *	g:EnterpriseProjectId	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the path.
site_id	Yes	String	Edge site ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
dim	No	String	Query by specified dimension. site_id: Compute and storage resource capacities queried by site ID flavor: Compute resource usage queried by flavor storage: Usage of each storage type queried flavor_capacity: the predicted number of available instances of each flavor queried storage_pool: Usage of each storage pool queried

Request Parameters

**Table 3** Request header parameters
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	Metrics. cpu_used: Number of used vCPU cores by site ID or flavor. cpu_available_total: Total number of vCPU cores available by site_id or flavor. cpu_total: Total number of vCPU cores (including the cores reserved for HA) by site ID or flavor. memory_used: Used memory by site ID or flavor. The unit is GB. memory_available_total: Total memory available by site ID or flavor. The unit is GB. memory_total: Total memory (including the memory reserved for HA) by site ID and flavor. The unit is GB. capacity_used: Used block storage by site ID or storage type. The unit is GiB. capacity_available_total: Total block storage available (storage subscribed by users) by site ID or storage type. The unit is GiB. capacity_total: Maximum block storage subscribed (it may be greater than the enabled storage) by site ID or storage type. The unit is GiB. available: Number of remaining available racks of corresponding flavor by flavor capacity.
value	Long	Monitored 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 Requests

Viewing the capacity of

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

Example Responses

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"
    }
  } ]
}