文档

QueryUserOmsData - 根据传入的云产品查询相应的计量记录

更新时间:
一键部署

根据传入的云产品查询相应的计量记录。

接口说明

API 描述

  • 传入云产品参数必须在以下云产品 code 中,计量数据类型有小时、天类型。
  • 传入时间格式按照 ISO8601 标准,时间规范约束:
    • 由于数据推送存在一定延时,按小时类型能保证 24 小时前计量数据完整性,按天类型能保证 2 天前计量数据完整性。
    • 时间跨度上,可取最近一个季度的计量数据。

调试

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

授权信息

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

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

请求参数

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

用量数据产品和明细信息,一般为 ProductCode,不同产品存在多种计量模型。

rds
DataTypestring

计量数据时间类型,参考具体产品文档描述选用。

  • Raw:小时。
  • Hour:小时。
  • Day:天。
  • Month:月。
Hour
StartTimestring

请求的开始时间。

日期格式按照 ISO8601 标准标示,并需要使用 UTC 时间。格式:yyyy-mm-ddThh:mm:ssZ。

2020-02-20T12:00:00Z
EndTimestring

请求的结束时间。

日期格式按照 ISO8601 标准标示,并需要使用 UTC 时间。格式:yyyy-mm-ddThh:mm:ssZ。

2020-02-21T12:00:00Z
Markerstring

设定结果从 NextToken 之后按字母排序的第一个开始返回。默认从头返回。

NextToken
PageSizeinteger

分页查询每页行数,1~200,默认值 100。

1

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 ID。

6000EE23-274B-4E07-A697-FF2E999520A4
Successboolean

是否成功。

true
Dataobject

返回数据。

Markerstring

下页开始 NextToken 字段,如为空或无此项表示已无数据。

NextToken
HostIdstring

主机 ID。

cn
OmsDataobject []
object

OMS 数据列表。

[{ "SyncIn": "0", "Bucket": "quota_for_get_service_", "NetworkIn": "0", "PutRequest": "1", "NetworkOut": "0", "GetRequest": "0", "ProcessImgSize": "0", "SyncOut": "0", "Storage": "0", "Region": "ap-northeast-1", "ProviderId": "26842", "CdnIn": "0", "EndTime": "2019-09-03T16:00:00Z", "StartTime": "2019-09-02T16:00:00Z", "StorageType": "standard", "CdnOut": "0"}]

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "Success": true,
  "Data": {
    "Marker": "NextToken",
    "HostId": "cn",
    "OmsData": [
      [
        {
          "SyncIn": "0",
          "Bucket": "quota_for_get_service_",
          "NetworkIn": "0",
          "PutRequest": "1",
          "NetworkOut": "0",
          "GetRequest": "0",
          "ProcessImgSize": "0",
          "SyncOut": "0",
          "Storage": "0",
          "Region": "ap-northeast-1",
          "ProviderId": "26842",
          "CdnIn": "0",
          "EndTime": "2019-09-03T16:00:00Z",
          "StartTime": "2019-09-02T16:00:00Z",
          "StorageType": "standard",
          "CdnOut": "0"
        }
      ]
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NotApplicableThis API is not applicable for caller.-
400NotAuthorizedThis API is not authorized for caller.-
400InvalidOwnerThe specified owner doesn't belong to caller.用户身份错误
500InternalErrorThe request processing has failed due to some unknown error.内部服务器错误。

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

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