You need to enable JavaScript to run this app.
导航
查询镜像回源带宽
最近更新时间:2023.07.04 20:07:09首次发布时间:2023.01.03 19:25:55

本接口支持查询当前账号下镜像回源带宽用量数据。

注意事项

  • 请求频率:单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟约在 5~10 分钟
  • 历史数据查询时间范围:近 93 天

请求说明

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

说明

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

请求参数

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

参数类型是否必选示例值描述
Content-TypeStringapplication/json请求头字段

Query

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

Body

参数类型是否必选示例值描述

StartTime

String

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

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

说明

由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-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

1800

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

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

ServiceIds

Array of String

ys****yj,4q****n6

限制查询的服务 ID,传入多个时用英文逗号分割。缺省情况下表示不限制服务 ID。

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

DomainNames

Array of String

xxx.com,yyy.com

限制查询的域名,传入多个时用英文逗号分割。缺省情况下表示不限制域名。
您可以通过调用 GetServiceDomains 获取服务下所有域名信息。

返回参数

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

Data

参数类型示例值描述
TimeStampString2022-11-18T00:00:00.000+08:00统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
ValueNumber992带宽,单位为 bps。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXMirrorRequestBandwidth&Version=2018-08-01
{
  "StartTime": "2019-06-02T00:00:00+08:00",
  "Interval": "1800",
  "EndTime": "2019-06-02T01:00:00+08:00",
  "ServiceIds": [
    "ys****yj"
  ],
  "DomainNames": [
    "xxx.com"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXMirrorRequestBandwidth",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "TimeStamp": "2019-06-02T00:00:00.000+08:00",
                "Value": 992
            }
        ]
    }
}

错误码

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

服务端 SDK

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