You need to enable JavaScript to run this app.
导航
查询资源占用量
最近更新时间:2024.01.31 15:12:58首次发布时间:2024.01.31 15:12:58

本接口支持通过自定义查询时间段,查询该时间段的每天资源占用量。

使用说明

单次查询最大时间跨度为 93 天。

注意事项

  • 请求频率:单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟约为 1 天
  • 历史数据查询时间范围:近 1 年
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。详情参见服务地址

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=DescribeImageXBucketRetrievalUsage&Version=2023-05-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeImageXBucketRetrievalUsage接口名称。当前 API 的名称为 DescribeImageXBucketRetrievalUsage
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

ServiceIds

String

s1,s2

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

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

BucketNames

String

b1,b2

Bucket 名称。支持同时查询多个 BucketName,不同的 BucketNmae 使用逗号分隔。
您可以通过调用 GetAllImageServices 获取所需的 Bucket 名称。

GroupBy

String

ServiceId,BucketName,StorageType

需要分组查询的参数,多个数据用逗号分隔。取值如下所示:

  • ServiceId:服务 ID
  • BucketName:Bucket 名称
  • StorageType:存储类型

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

返回参数

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

参数类型示例值描述
StorageDataArray of StorageData-计量数据列表

StorageData

参数类型示例值描述
ServiceIdStrings1服务 ID,GroupBy包含ServiceId时有返回值。
BucketNameStringb1Bucket 名称,GroupBy包含BucketName时有返回值。

StorageType

String

STANDARD

存储类型,GroupBy包含StorageType时有返回值。取值如下所示:

  • STANDARD:标准存储
  • IA:低频存储
  • ARCHIVE:归档存储
  • COLD_ARCHIVE:冷归档存储
DataArray of Data-具体数据

Data

参数类型示例值描述
TimeStampString2023-01-01T00:00:00+08:00统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
ValueFloat123存储量,单位为 Byte。

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXBucketRetrievalUsage&Version=2023-05-01&ServiceIds=s1,s2&BucketNames=b1,b2&GroupBy=ServiceId,BucketName,StorageType&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00
{}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXBucketRetrievalUsage",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "StorageData": [
            {
                "ServiceId": "s1",
                "BucketName": "b1",
                "StorageType": "STANDARD",
                "Data": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 123
                    }
                ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码

状态码错误码错误信息说明
400InvalidParameterMissing Parameter.请求参数错误
401ParamAccountMismatchParam {} did not belong to your account.请求参数不属于账号
500InternalErrorInternal Error.内部错误