文档

DescribeVsDevicesData - 获取接入设备用量数据

更新时间:

获取接入设备用量数据。

接口说明

不指定 StartTime 和 EndTime 时,默认读取过去 24 小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。 最大查询范围 31 天。

  • 支持批量域名查询,多个域名用英文逗号(,)分隔。
  • 最多可获取最近 90 天的数据。
  • 时间粒度为小时。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
GroupIdstring

按空间 ID 查询。

348*****174-cn-qingdao
StartTimestring

获取数据的起始时间。

说明
  • 日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
  • 最小数据粒度为 5 分钟。
  • 不填的话,默认读取过去 24 小时数据。
  • 2022-01-04T16:00:00Z
    EndTimestring

    获取数据的结束时间,需要大于起始时间。

    说明
  • 日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
  • 最小数据粒度为 5 分钟。
  • 不填的话,默认读取过去 24 小时数据。
  • 2022-01-30T16:00:00Z

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    BEA5625F-8FCF-48F4-851B-CA63946DA664
    DevicesDataPerIntervalobject []

    每个时间间隔的接入设备用量。

    TimeStampstring

    统计数据的时间点。

    2022-01-04T16:00:00Z
    DevicesDataValuestring

    接入设备用量数值。单位:个。

    128

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
      "DevicesDataPerInterval": {
        "DataModule": [
          {
            "TimeStamp": "2022-01-04T16:00:00Z",
            "DevicesDataValue": "128"
          }
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedThe format of the specified StartTime is invalid.开始时间格式不对
    400InvalidEndTime.MalformedThe format of the specified EndTime is invalid.截止时间格式不对
    400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查
    400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.不支持该开始时间

    访问错误中心查看更多错误码。

    • 本页导读 (1)
    文档反馈