You need to enable JavaScript to run this app.
导航

获取基础处理量

最近更新时间2023.07.04 20:07:27

首次发布时间2022.08.23 20:12:27

本接口支持通过自定义时间段,获取时间段内的图像基础处理量。

注意事项

  • 请求频率:单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟约为 20~30 分钟
  • 历史数据查询时间范围:近 1 年

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=DescribeImageXBaseOpUsage&Version=2018-08-01

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeImageXBaseOpUsage接口名称。DescribeImageXBaseOpUsage
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

ServiceIds

String

s1,s2

服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。

  • 您可以在 veImageX 控制台服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考 GetAllImageServices

StartTime

String

2019-06-02T00:00:00+08:00

获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00

说明

由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00

EndTimeString2019-06-02T00:00:00+08:00获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00

Interval

String

300

查询数据的时间粒度。单位为秒。缺省时查询 StartTimeEndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:

  • 300:单次查询最大时间跨度为 31 天
  • 600:单次查询最大时间跨度为 31 天
  • 1200:单次查询最大时间跨度为 31 天
  • 1800:单次查询最大时间跨度为 31 天
  • 3600:单次查询最大时间跨度为 93 天
  • 86400:单次查询最大时间跨度为 93 天
  • 604800:单次查询最大时间跨度为 93 天

返回参数

参数类型示例值描述
BaseOpDataArray of BaseOpData基础处理量数据

BaseOpData

参数类型示例值描述
DataArray of Data具体数据

Data

参数类型示例值描述
TimeStampString2022-07-10T00:00:00+08:00统计时间点,时间片开始时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
ValueNumber374042309229044基础处理量,单位为 Byte。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXBaseOpUsage&Version=2018-08-01&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&Interval=300&ServiceIds=s1%2Cs2&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00


返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220322174114010204055149180006F0",
        "Action": "DescribeImageXBaseOpUsage",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "BaseOpData": [
            {
                "Data": [
                    {
                        "TimeStamp": "2022-07-10T00:00:00+08:00",
                        "Value": 390867451938279
                    },
                    {
                        "TimeStamp": "2022-07-11T00:00:00+08:00",
                        "Value": 374042309229044
                    }
                ]
            }
        ]
    }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: