文档中心

查询附加组件通用请求次数

最近更新时间：2023.08.22 15:00:57

首次发布时间：2023.08.22 15:00:57

本接口支持通过自定义查询时间段，获取该时间段的附加组件通用请求次数。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 20~30 分钟。
历史数据查询时间范围：近 1 年。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXBillingRequestCntUsage`	接口名称。当前 API 的名称为 `DescribeImageXBillingRequestCntUsage`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceIds	String	否	`s1,s2`	服务 ID。为空时表示不筛选，支持查询多个服务，不同的服务使用逗号分隔。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
AdvFeats	String	否	`a1,a2`	组件名称。为空时表示不筛选，支持查询多个`AdvFeat`，不同的`AdvFeat`使用逗号分隔。您可通过调用 GetImageAddOnConf 查看`Key`返回值。
GroupBy	String	是	`AdvFeat`	固定值，仅支持`AdvFeat`即附加组件。
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`。
EndTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据结束时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Interval	String	否	`300`	查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据，此时单次查询最大时间跨度为 93 天。支持取值如下： `300`：单次查询最大时间跨度为 31 天 `600`：单次查询最大时间跨度为 31 天 `1200`：单次查询最大时间跨度为 31 天 `1800`：单次查询最大时间跨度为 31 天 `3600`：单次查询最大时间跨度为 93 天 `86400`：单次查询最大时间跨度为 93 天 `604800`：单次查询最大时间跨度为 93 天

返回参数

参数	类型	示例值	描述
RequestCntData	Array of RequestCntData		附加组件通用请求次数据。

RequestCntData

参数	类型	示例值	描述
AdvFeat	String	`enhance`	附加组件类型，如：enhance，smartcut。取值为`total`，表示包含所选`AdvFeat`请求次数相加。
Data	Array of Data		时序数据列表。

Data

参数	类型	示例值	描述
TimeStamp	String	`2022-07-10T00:00:00+08:00`	统计时间点，时间片开始时刻。按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`。
Value	Integer	`875`	请求次。

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20220322174114010204055149180006F0",
    "Action": "DescribeImageXBillingRequestCntUsage",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "RequestCntData": [
      {
        "AdvFeat": "enhance",
        "Data": [
          {
            "TimeStamp": "2022-07-10T00:00:00+08:00",
            "Value": 4402081
          },
          {
            "TimeStamp": "2022-07-11T00:00:00+08:00",
            "Value": 4184814
          }
        ]
      },
      {
        "AdvFeat": "total",
        "Data": [
          {
            "TimeStamp": "2022-07-10T00:00:00+08:00",
            "Value": 4608032
          },
          {
            "TimeStamp": "2022-07-11T00:00:00+08:00",
            "Value": 4384746
          }
        ]
      }
    ]
  }
}

错误码

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

注意事项

请求说明

请求参数

Query

返回参数

RequestCntData

Data

示例

请求示例

返回示例

错误码