查询实例资源状态 GetPodMetric--云手机-火山引擎

文档中心

立即注册

导航

云手机

查询实例资源状态 GetPodMetric

最近更新时间：2024.05.08 16:33:53首次发布时间：2024.02.02 15:51:38

此接口用于查询指定实例的资源状态。例如，指定实例所属业务 ID 和实例 ID，获取实例资源状态。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetPodMetric&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetPodMetric`	接口名称。当前 API 的名称为 `GetPodMetric`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	实例所属业务 ID。可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7235890322201xxxxxx`	实例 ID。可通过调用 ListPod 接口获取。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PodId	String	`732934xxxxxxxxxx`	实例 ID。
MemTotal	Long	`10737418240`	总内存，单位 byte。
DiskTotal	Long	`34359738368`	磁盘总量，单位 byte。
TimeStamp	Long	`1706672705`	时间戳。
CPUMax	Double	`8`	单 pod 最大可使用核数。
IOwait	Double	`0`	Data 分区 IO 请求平均响应时间，单位为 ms，保留两位小数。
UpLoss	Double	`0`	上行丢包率，小于 1 的数，小数点后保留 4 位。
ReadOPS	Integer	`0`	Data 分区每秒读请求数。
CPUAlloc	Double	`8`	理论分配的 CPU 核数。例如，单 node 8C12G 为例，单开 8 核，双开 4 核，以此类推。
CPUUsage	Double	`0.06`	CPU 使用量。
DownLoss	Double	`0`	下行丢包率，小于 1 的数，小数点后保留 4 位。
MemAlloc	Long	`12884901888`	理论分配的内存数，单位 byte。
MemUsage	Long	`1604407296`	实际已使用内存，单位 byte。
WriteOPS	Integer	`0`	Data 分区每秒写请求数。
DiskUsage	Long	`15596621824`	实际已使用磁盘容量，单位 byte。
UpBandwidth	Long	`3660`	pod 上行带宽（出向），单位 byte/s。
DownBandwidth	Long	`922`	pod 下行带宽（入向），单位 byte/s。

请求示例

GET https://open.volcengineapi.com?Action=GetPodMetric&Version=2023-10-30&ProductId=1591495366954xxxxxx&PodId=7235890322201xxxxxx

返回示例

{
  "ResponseMetadata": {
    "Action": "GetPodMetric",
    "Region": "cn-north-1",
    "RequestId": "2024020117***D00A0D6E9B89771",
    "Service": "ACEP",
    "Version": "2023-10-30"
  },
  "Result": {
    "PodId": "732934xxxxxxxxxx",
    "CPUUsage": 0.06,
    "CPUAlloc": 8,
    "CPUMax": 8,
    "MemTotal": 10737418240,
    "MemAlloc": 12884901888,
    "MemUsage": 1604407296,
    "DiskTotal": 34359738368,
    "DiskUsage": 15596621824,
    "ReadOPS": 0,
    "WriteOPS": 0,
    "UpBandwidth": 3660,
    "DownBandwidth": 922,
    "UpLoss": 0,
    "DownLoss": 0,
    "TimeStamp": 1706672705,
    "IOwait": 0
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。