You need to enable JavaScript to run this app.
导航
Resource Monitor OpenAPI
最近更新时间:2023.09.01 17:36:57首次发布时间:2022.02.24 10:16:44

Resource Monitor OpenAPI

本文档提供 LAS 中核心 资源的用量 相关的 OpenAPI,具体包含:

  • SQL 作业总扫描量 :GetDataScannedAmmount

  • Spark 作业总扫描量 :GetCUHourAmmount

  • 总存储量: GetStorageAmmount

  • 总作业数 :CountTotalJob

  • 当前运行的总作业数: CountRunningJob

1. GetDataScannedAmmount

获取队列的 SQL 作业总数据扫描量(1 小时内)

1.1 请求参数

参数名称类型是否必选示例值描述
ActionStringGetDataScannedAmmount要执行的操作,取值:GetDataScannedAmmount。
VersionString2022-01-01
QueueIdString1000001队列 ID

1.2 返回数据

Double, 单位 MB, 保留两位小数

1.3 请求示例

GET /?Action=GetDataScannedAmmount&Version=2022-01-01&QueueId=1001 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: las
Region: cn-beijing

1.4 返回示例

{
      ResponseMetadata  :{
          RequestId  :  2000xxxx  ,
          Action  :  GetDataScannedAmmount  ,
          Version  :  2022-01-01  ,
          Service  :  las  ,
          Region  :  cn-beijing  
    },
     Result : 100.23
}

2. GetCUHourAmmount

获取队列的 Spark Jar 作业总数据扫描量(1 小时内)

2.1 请求参数

参数名称类型是否必选示例值描述
ActionStringGetCUHourAmmount要执行的操作,取值:GetCUHourAmmount。
VersionString2022-01-01
QueueIdString1000001队列 ID

2.2 返回数据

Integer, 单位 CU 时

2.3 请求示例

GET /?Action=GetCUHourAmmount&Version=2022-01-01&QueueId=1001 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: las
Region: cn-beijing

2.4 返回示例

{
      ResponseMetadata  :{
          RequestId  :  2000xxxx  ,
          Action  :  GetCUHourAmmount  ,
          Version  :  2022-01-01  ,
          Service  :  las  ,
          Region  :  cn-beijing  
    },
     Result : 300
}

3. GetStorageAmmount

获取总存储用量(本日)

3.1 请求参数

参数名称类型是否必选示例值描述
ActionStringGetStorageAmmount要执行的操作,取值:GetStorageAmmount。
VersionString2022-01-01

3.2 返回数据

Integer, 单位 MB

3.3 请求示例

GET /?Action=GetStorageAmmount&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: las
Region: cn-beijing

3.4 返回示例

{
      ResponseMetadata  :{
          RequestId  :  2000xxxx  ,
          Action  :  GetStorageAmmount  ,
          Version  :  2022-01-01  ,
          Service  :  las  ,
          Region  :  cn-beijing  
    },
     Result : 3000
}

4. CountTotalJob

获取队列的总作业数

4.1 请求参数

参数名称类型是否必选示例值描述
ActionStringCountTotalJob要执行的操作,取值:CountTotalJob。
VersionString2022-01-01
QueueIdString1000001队列 ID

4.2 返回数据

Integer, 单位 个

4.3 请求示例

GET /?Action=CountTotalJob&Version=2022-01-01&QueueId=1001 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: las
Region: cn-beijing

4.4 返回示例

{
      ResponseMetadata  :{
          RequestId  :  2000xxxx  ,
          Action  :  CountTotalJob  ,
          Version  :  2022-01-01  ,
          Service  :  las  ,
          Region  :  cn-beijing  
    },
     Result : 140
}

5. CountRunningJob

获取队列当前运行的总作业数

5.1 请求参数

参数名称类型是否必选示例值描述
ActionStringCountRunningJob要执行的操作,取值:CountRunningJob。
VersionString2022-01-01
QueueIdString1000001队列 ID

5.2 返回数据

Integer, 单位:个

5.3 请求示例

GET /?Action=CountRunningJob&Version=2022-01-01&QueueId=1001 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: las
Region: cn-beijing

5.4 返回示例

{
      ResponseMetadata  :{
          RequestId  :  2000xxxx  ,
          Action  :  CountRunningJob  ,
          Version  :  2022-01-01  ,
          Service  :  las  ,
          Region  :  cn-beijing  
    },
     Result : 12
}