文档

DescribeResourceUsage - 查询资源使用量

更新时间:

查询资源使用量。

调试

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

授权信息

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

请求参数

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

服务空间 ID。

226e5213-697c-****-b4ff-35a09f8a52de
PageNumberlong

页码。取值范围:大于 1 的任意整数。

1
PageSizelong

页大小。默认 30,最大 1000,取值:1-1000。

100
StartTimestring

获取资源用量起始时间。日期格式按照 ISO8601 表示法,并使用北京时间(UTC+8),格式为 yyyy-MM-ddTHH:mm:ssZ,默认返回今天的数据。

2021-10-01T00:00:00Z
EndTimestring

获取资源用量结束时间。日期格式按照 ISO8601 表示法,并使用北京时间(UTC+8),格式为 yyyy-MM-ddTHH:mm:ssZ。结束时间需晚于起始时间。

2021-10-02T00:00:00Z
Formatstring

可选,默认值 JSON,当前仅支持 JSON 格式。

JSON

返回参数

名称类型描述示例值
object
Codestring

请求返回状态。

  • success:成功。
  • failed:失败。
success
Messagestring

错误信息。

SpaceNotExist
HttpStatusCodestring

HTTP 请求返回的响应状态码,200 表示请求成功。

200
RequestIdstring

唯一请求 ID。

C293BB03-B6AD-46C2-80D1-19C8FB573916
Successboolean

请求返回状态。

  • true:成功。
  • false:失败
true
DataListobject []

返回数据。

StartTimestring

获取资源用量起始时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ, 默认返回今天的数据。

2021-10-01T15:00:00Z
EndTimestring

获取资源用量结束时间。结束时间需晚于起始时间。

2021-10-01T16:00:00Z
CloudStorageobject

云存储。

DataSizelong

容量 (单位字节)。

0
Trafficlong

流量(单位字节)。

0
Uploadlong

上传次数。

0
Downloadlong

下载次数。

0
CloudDBobject

云数据库。

DataSizelong

容量 (单位字节)。

0
Writelong

写次数。

0
Readlong

读次数。

0
CloudFunctionobject

云函数。

Computelong

计算量(单位 GBS)。

0
Countlong

调用次数。

0
Trafficlong

流量(单位字节)。

0
StaticWebobject

静态网站托管

DataSizelong

容量 (单位字节)。

0
Trafficlong

流量(单位字节)。

0
Paginatorobject

分页信息。

PageCountlong

当前页面总数。

3
PageNumlong

页码。

1
PageSizelong

分页大小。

100
Totallong

总数

255

示例

正常返回示例

JSON格式

{
  "Code": "success",
  "Message": "SpaceNotExist",
  "HttpStatusCode": "200",
  "RequestId": "C293BB03-B6AD-46C2-80D1-19C8FB573916",
  "Success": true,
  "DataList": [
    {
      "StartTime": "2021-10-01T15:00:00Z",
      "EndTime": "2021-10-01T16:00:00Z",
      "CloudStorage": {
        "DataSize": 0,
        "Traffic": 0,
        "Upload": 0,
        "Download": 0
      },
      "CloudDB": {
        "DataSize": 0,
        "Write": 0,
        "Read": 0
      },
      "CloudFunction": {
        "Compute": 0,
        "Count": 0,
        "Traffic": 0
      },
      "StaticWeb": {
        "DataSize": 0,
        "Traffic": 0
      }
    }
  ],
  "Paginator": {
    "PageCount": 3,
    "PageNum": 1,
    "PageSize": 100,
    "Total": 255
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-04新增 OpenAPI看变更集