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

更新时间:2025-02-08 10:00:42

获取接入设备用量数据。

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
vs:DescribeVsDevicesData
*全部资源
*

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
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
    DevicesDataPerIntervalarray<object>

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

    DataModuleobject
    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错误码错误信息描述
    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)
    • 接口说明
    • 调试
    • 授权信息
    • 请求参数
    • 返回参数
    • 示例
    • 错误码