Use QueryUserOmsData to query metering records of cloud products - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Operation description

API description

The specified cloud service parameter must be one of the following cloud service codes. The metering data types include hourly and daily.
The time format must comply with the ISO 8601 standard. Time specification constraints:
- Due to delays in data push, the data integrity of hourly metering data is guaranteed for the past 24 hours, and the data integrity of daily metering data is guaranteed for the past 2 days.
- The time span can cover the metering data of the most recent quarter.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeUserOmsData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Table	string	Yes	The product and detail information for the usage data, which is typically the ProductCode. Different services support multiple metering models.	rds
DataType	string	Yes	The data timestamp type of the metering data. Refer to the specific service documentation for details. Valid values: Raw: hourly Hour: hourly Day: daily Month: monthly	Hour
StartTime	string	Yes	The start time of the request. The date format must comply with the ISO 8601 standard and use UTC time. Format: yyyy-mm-ddThh:mm:ssZ.	2020-02-20T12:00:00Z
EndTime	string	Yes	The end time of the request. The date format must comply with the ISO 8601 standard and use UTC time. Format: yyyy-mm-ddThh:mm:ssZ.	2020-02-21T12:00:00Z
Marker	string	No	The marker that specifies the starting point for returning results in alphabetical order after the NextToken. By default, results are returned from the beginning.	NextToken
PageSize	integer	No	The number of rows per page for paging in a paged query. Valid values: 1 to 200. Default value: 100.	1

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful！
RequestId	string	The request ID.	6000EE23-274B-4E07-A697-FF2E999520A4
Success	boolean	Indicates whether the request is successful.	true
Data	object	The returned data.
Marker	string	The NextToken field for the start of the next page. If this field is empty or not present, it indicates that no more data is available.	NextToken
HostId	string	The host ID.	cn
OmsData	array<object>	The OMS data list.
	object	The OMS data list.	[{ "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"}]

Examples

Success response

JSON format

{
  "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"
        }
      ]
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotApplicable	This API is not applicable for caller.
400	NotAuthorized	This API is not authorized for caller.
400	InvalidOwner	The specified owner doesn't belong to caller.	Invalid user identity.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.