DescribeResourceUsage - 查询资源使用量

更新时间:
复制 MD 格式

查询资源使用量。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mpserverless:DescribeResourceUsage

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

SpaceId

string

是

服务空间 ID。

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

PageNumber

integer

否

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

1

PageSize

integer

否

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

100

StartTime

string

否

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

2021-10-01T00:00:00Z

EndTime

string

否

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

2021-10-02T00:00:00Z

返回参数

名称

类型

描述

示例值

object

Code

string

请求返回状态。

  • success:成功。

  • failed:失败。

success

Message

string

错误信息。

SpaceNotExist

HttpStatusCode

string

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

200

RequestId

string

唯一请求 ID。

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

Success

boolean

请求返回状态。

  • true:成功。

  • false:失败

true

DataList

array<object>

返回数据。

array<object>

函数数据大小。

StartTime

string

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

2021-10-01T15:00:00Z

EndTime

string

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

2021-10-01T16:00:00Z

CloudStorage

object

云存储。

DataSize

integer

容量 (单位字节)。

0

Traffic

integer

流量(单位字节)。

0

Upload

integer

上传次数。

0

Download

integer

下载次数。

0

CloudDB

object

云数据库。

DataSize

integer

容量 (单位字节)。

0

Write

integer

写次数。

0

Read

integer

读次数。

0

CloudFunction

object

云函数。

Compute

integer

计算量(单位 GBS)。

0

Count

integer

调用次数。

0

Traffic

integer

流量(单位字节)。

0

StaticWeb

object

静态网站托管

DataSize

integer

容量 (单位字节)。

0

Traffic

integer

流量(单位字节)。

0

Paginator

object

分页信息。

PageCount

integer

当前页面总数。

3

PageNum

integer

页码。

1

PageSize

integer

分页大小。

100

Total

integer

总数

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
  }
}

错误码

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

变更历史

更多信息,参考变更详情。