Query hourly data of OSS - - Alibaba Cloud Documentation Center

You can call the QueryUserOmsData operation to query the hourly metering data of OSS.

Request parameters

Name	Type	Required	Example	Description
Action	String	Yes	QueryUserOmsData	A required parameter. Set the value to QueryUserOmsData.
DataType	String	Yes	Hour	The time type of the metering data. Set the value to Hour.
Table	String	Yes	OSS	The name of the metering table. Valid values: OSS: the basic metering table of OSS. OssDataReplication: the metering table related to cross-region replication. OssSddpScan: the metering table related to sensitive data protection. OssCache: the metering table related to accelerator cache capacity.
StartTime	String	Yes	2022-12-01T09:12:43Z	The time when the request is initiated. The time is in UTC.
EndTime	String	Yes	2022-12-01T09:13:46Z	The time when the request ends. The time is in UTC.
Marker	String	No	test	The position from which to start the query. The results are returned in alphabetical order after the specified marker. If you do not set this parameter, data is returned from the beginning.
PageSize	Integer	No	50	The number of entries to return on each page for a paged query. Valid values: 1 to 200. Default value: 100.

Note

For information about the common request parameters, see Common request parameters.

Response parameters

Response parameters for the basic OSS metering table

Name	Type	Example	Description
HostId	String	intl	The site of the user. Valid values: and intl.
Marker	string	NextToken	If the query is paged, the data on the next page is retrieved from the position specified by the Marker value until all data is retrieved. If the Marker value is empty, all data is returned.
ProviderId	String	26888	The ID of the product provider. Valid values: and 26888.
UserId	String	148562088256****	The UID of the user.
LessthanMonthDatasize	Integer	180	The billable storage usage for Infrequent Access and Archive Storage objects that are stored for a period shorter than the minimum storage duration. Unit: bytes. Insufficient storage duration for Infrequent Access If an Infrequent Access LRS object is overwritten or deleted in less than 30 days (720 hours), you are charged for the remaining storage duration (720 hours - actual storage duration). Archive Storage data stored for less than the minimum duration If an Archive LRS object is overwritten or deleted in less than 60 days (1,440 hours), you are charged for the remaining storage duration (1,440 hours - actual storage duration).
ChargedDatasize	Integer	200	The billable storage usage for Infrequent Access LRS and Archive LRS. Unit: bytes.
RetrievalData	Integer	200	The amount of data retrieved from Infrequent Access and Archive Storage. Infrequent Access data retrieval The fees are generated when you access Infrequent Access objects. You are charged based on the volume of retrieved data. Archive Storage data retrieval The fees are generated when you restore Archive Storage objects. You are charged based on the size of the restored files.
RetrievalDataArchiveDirect	Integer	200	The amount of data retrieved from Archive Storage using direct read. The fees are generated when you directly access Archive Storage objects. You are charged based on the volume of directly retrieved data.
ChargedDatasizeCA	Integer	100	The fees are calculated based on the size and storage duration of Cold Archive LRS objects. Important Cold Archive objects have a minimum billable size. If a single object is smaller than 64 KB, it is billed as 64 KB. If an object is 64 KB or larger, it is billed based on its actual size.
EarlyDeletionCA	Integer	100	If a Cold Archive object is overwritten or deleted in less than 180 days (4,320 hours), you are charged for the remaining storage duration (4,320 hours - actual storage duration).
Bucket	String	examplebucket	The name of the bucket.
NetworkIn	Integer	2000	The inbound traffic that is generated when data is transferred from a client to OSS over the Internet within the specified time range. Unit: bytes.
NetworkOut	Integer	2000	The outbound traffic that is generated when data is transferred from OSS to a client over the Internet within the specified time range. Unit: bytes.
PutRequest	Integer	1000	The fees for the number of PUT requests that are initiated to call OSS API operations within the specified time range.
GetRequest	Integer	2000	The fees for the number of GET requests that are initiated to call OSS API operations within the specified time range.
ProcessImgSize	Integer	200	The fees are calculated based on the actual size of the source image that is processed. Unit: bytes.
AdvImageProcLow	Integer	200	The fees for the number of times that images are processed using advanced compression. The output image resolution for advanced compression is 800 × 600 pixels or smaller.
AdvImageProcMed	Integer	200	The fees for the number of times that images are processed using advanced compression. The output image resolution for advanced compression is 1600 × 1200 pixels or smaller.
Storage	Integer	2000	The metered storage usage for each storage class. Unit: bytes. Note If you call the GetBucketInfo operation using an endpoint that is not in the same region as the bucket, the value of Storage may be 0. Infrequent Access, Archive, Cold Archive, and Deep Cold Archive objects have a minimum billable size of 64 KB. Therefore, the metered storage usage and billable storage usage of these storage classes may be different.
StorageType	String	standard	The storage class of the data. Valid values: standard: Standard LRS IA: Infrequent Access LRS archive: Archive LRS coldarchive: Cold Archive deepcoldarchive: Deep Cold Archive standard-zrs: Standard ZRS IA-zrs: Infrequent Access ZRS archive-zrs: Archive ZRS For more information, see Overview of storage classes.
CAStdRetrievalData	Integer	65536	The volume of data retrieved when a Cold Archive object is restored within 2 to 5 hours at the Standard priority. Unit: bytes.
CABulkRetrievalData	Integer	65536	The volume of data retrieved when a Cold Archive object is restored within 5 to 12 hours at the Bulk priority. Unit: bytes.
CAHighPriorRetrievalData	Integer	65536	The volume of data retrieved when a Cold Archive object is restored within 1 hour at the High priority. Unit: bytes.
DeepCAStdRetrievalData	Integer	65536	The volume of data retrieved when a Deep Cold Archive object is restored within 48 hours at the Standard priority. Unit: bytes.
DeepCAHighPriorRetrievalData	Integer	65536	The volume of data retrieved when a Deep Cold Archive object is restored within 12 hours at the High priority. Unit: bytes.
CAStdRetrievalRequest	Integer	10000	The number of requests to restore Cold Archive objects at the Standard priority.
CABulkRetrievalRequest	Integer	10000	The number of requests to restore Cold Archive objects at the Bulk priority.
CAHighPriorRetrievalRequest	Integer	10000	The number of requests to restore Cold Archive objects at the High priority.
DeepCAStdRetrievalRequest	Integer	10000	The number of requests to restore Deep Cold Archive objects at the Standard priority.
DeepCAHighPriorRetrievalRequest	Integer	10000	The number of requests to restore Deep Cold Archive objects at the High priority.
CdnIn	Integer	500	The upstream traffic that is generated when you access data over CDN after you enable CDN acceleration. Unit: bytes.
CdnOut	Integer	500	The downstream traffic, which is the back-to-origin traffic, that is generated when you access data over CDN after you enable CDN acceleration. Unit: bytes.
ProcessI	Integer	50	The fees are calculated based on the number of images captured using video snapshot.
StorageZRS	Integer	100	The fees are calculated based on the size and storage duration of Standard ZRS objects.
ChargedDatasizeZRS	Integer	65536	The fees are calculated based on the size and storage duration of Infrequent Access ZRS objects. Infrequent Access ZRS objects have a minimum billable size. If a single object is smaller than 64 KB, it is billed as 64 KB. If an object is 64 KB or larger, it is billed based on its actual size.
LessthanMonthDatasizeZRS	Integer	700	If an Infrequent Access ZRS object is overwritten or deleted in less than 30 days (720 hours), you are charged for the remaining storage duration (720 hours - actual storage duration).
AccM2MIn	Integer	500	The accelerated upload traffic that is generated when you use an acceleration endpoint to access OSS from the Chinese mainland to the Chinese mainland. Unit: bytes.
AccM2MOut	Integer	500	The accelerated download traffic that is generated when you use an acceleration endpoint to access OSS from the Chinese mainland to the Chinese mainland. Unit: bytes.
AccM2OIn	Integer	500	The accelerated upload traffic that is generated when you use an acceleration endpoint to access OSS from the Chinese mainland to a region outside the Chinese mainland. Unit: bytes.
AccM2OOut	Integer	500	The accelerated download traffic that is generated when you use an acceleration endpoint to access OSS from the Chinese mainland to a region outside the Chinese mainland. Unit: bytes.
AccO2MIn	Integer	500	The accelerated upload traffic that is generated when you use an acceleration endpoint to access OSS from a region outside the Chinese mainland to the Chinese mainland. Unit: bytes.
AccO2MOut	Integer	500	The accelerated download traffic that is generated when you use an acceleration endpoint to access OSS from a region outside the Chinese mainland to the Chinese mainland. Unit: bytes.
AccO2OIn	Integer	500	The accelerated upload traffic that is generated when you use an acceleration endpoint to access OSS from a region outside the Chinese mainland to another region outside the Chinese mainland. Unit: bytes.
AccO2OOut	Integer	500	The accelerated download traffic that is generated when you use an acceleration endpoint to access OSS from a region outside the Chinese mainland to another region outside the Chinese mainland. Unit: bytes.
TempStorageCAStd	Integer	500	When you restore a Cold Archive or Deep Cold Archive object, a replica of the object is created for access. You are charged for the storage of the replica before the restoration is complete. The replica is automatically deleted after the restoration is complete.
SelectScanSize	Integer	300	The fees are calculated based on the actual size of the source object scanned by SelectObject.
TagCount	Integer	100	The fees are calculated based on the number of object tags in the bucket.
StartTime	String	2022-12-01T09:12:43Z	The time when the billing data starts to be generated. The time is in UTC.
EndTime	String	2022-12-01T09:13:46Z	The time when the billing data stops to be generated. The time is in UTC.

Response parameters for the OssDeepColdArchive metering table

Name	Type	Example	Description
HostId	String	cn	The site of the user. Valid values: and intl.
Marker	string	NextToken	If the query is paged, the data on the next page is retrieved from the position specified by the Marker value until all data is retrieved. If the Marker value is empty, all data is returned.
ProviderId	String	26842	The ID of the product provider. Valid values: and 26888.
UserId	String	148562088256****	The UID of the user.
ChargedDatasizeDeepCA	Integer	100	The fees are calculated based on the size and storage duration of Deep Cold Archive LRS objects. Important Deep Cold Archive objects have a minimum billable size. If a single object is smaller than 64 KB, it is billed as 64 KB. If an object is 64 KB or larger, it is billed based on its actual size.
EarlyDeletionDeepCA	Integer	100	If a Deep Cold Archive object is overwritten or deleted in less than 180 days (4,320 hours), you are charged for the remaining storage duration (4,320 hours - actual storage duration).
StartTime	String	2022-12-01T09:12:43Z	The time when the billing data starts to be generated. The time is in UTC.
EndTime	String	2022-12-01T09:13:46Z	The time when the billing data stops to be generated. The time is in UTC.

Response parameters for the OssDataReplication metering table

Name	Type	Example	Description
HostId	String	cn	The site of the user. Valid values: and intl.
Marker	string	NextToken	If the query is paged, the data on the next page is retrieved from the position specified by the Marker value until all data is retrieved. If the Marker value is empty, all data is returned.
ProviderId	String	26842	The ID of the product provider. Valid values: and 26888.
UserId	String	148562088256****	The UID of the user.
SourceRegion	String	oss-cn-hangzhou	The region where the source bucket is located when you use cross-region replication.
DestRegion	String	oss-us-west-1	The region where the destination bucket is located when you use cross-region replication.
SourceBucket	String	srcbucket	The name of the source bucket.
DestBucket	String	destbucket	The name of the destination bucket.
ReplicationDatasize	Integer	1000	The size of the data that is replicated from the source bucket to the destination bucket. Unit: bytes.
RtcDatasize	Integer	1000	The data replication traffic that is generated for a replication task for which RTC is enabled. Unit: bytes.
StartTime	String	2022-12-01T09:12:43Z	The time when the billing data starts to be generated. The time is in UTC.
EndTime	String	2022-12-01T09:13:46Z	The time when the billing data stops to be generated. The time is in UTC.

Response parameters for the OssSec metering table

Name	Type	Example	Description
HostId	String	cn	The site of the user. Valid values: and intl.
Marker	string	NextToken	If the query is paged, the data on the next page is retrieved from the position specified by the Marker value until all data is retrieved. If the Marker value is empty, all data is returned.
ProviderId	String	26842	The ID of the product provider. Valid values: and 26888.
UserId	String	148562088256****	The UID of the user.
Bucket	String	examplebucket	The name of the bucket for which OSS DDoS protection is configured.
StartTime	String	2022-12-01T09:12:43Z	The time when the billing data starts to be generated. The time is in UTC.
EndTime	String	2022-12-01T09:13:46Z	The time when the billing data stops to be generated. The time is in UTC.
SecReserved	Integer	5	The fees are calculated based on the number of Anti-DDoS instances and their usage duration.
SecEarlyReleased	Integer	100	If you use an OSS Anti-DDoS instance for less than seven days, you are charged a resource reservation fee for the remaining duration (7 days × 24 hours - usage duration of the Anti-DDoS instance).
SecFlow	Integer	2000	The DDoS protection fee for traffic is calculated based on the greater value between the total outbound and inbound traffic over the Internet for all buckets that are attached to the Anti-DDoS instance.
SecRequest	Integer	10000	The DDoS protection fee for requests is calculated based on the number of OSS API requests for all buckets that are attached to the Anti-DDoS instance. Note The number of requests is counted regardless of whether the requests are successful.

Response parameters for the OssSddpScan metering table

Name	Type	Example	Description
HostId	String	cn	The site of the user. Valid values: and intl.
Marker	string	NextToken	If the query is paged, the data on the next page is retrieved from the position specified by the Marker value until all data is retrieved. If the Marker value is empty, all data is returned.
ProviderId	String	26842	The ID of the product provider. Valid values: and 26888.
UserId	String	148562088256****	The UID of the user.
Bucket	String	examplebucket	The name of the bucket that stores sensitive data.
StartTime	String	2022-12-01T09:12:43Z	The time when the billing data starts to be generated. The time is in UTC.
EndTime	String	2022-12-01T09:13:46Z	The time when the billing data stops to be generated. The time is in UTC.
SddpScanSize	Integer	1000	The size of the data that is authorized for a full or incremental scan. Unit: bytes.

Examples

Request example

https://business.aliyuncs.com/?Action=QueryUserOmsData
&DataType=Hour
&EndTime=2022-12-01T09:13:46Z
&StartTime=2022-12-01T09:12:43Z
&Table=oss
&<Common request parameters>

Response example

{
    "Data": {
        "Marker": "NextToken",
        "OmsData": [
            {
                "LessthanMonthDatasize": 180,                
                "RetrievalData": 200,
                "RetrievalDataArchiveDirect": 200,
                "ChargedDatasize": 200,
                "Bucket": "examplebucket",
                "NetworkIn": 2000,
                "PutRequest": 1000,
                "NetworkOut": 2000,
                "GetRequest": 2000,
                "ProcessImgSize": 200,                
                "Storage": 2000,
                "Region": "cn-hangzhou",
                "ProviderId": "26842",
                "CdnIn": 500,
                "EndTime": "2022-12-01T09:13:46Z",
                "StartTime": "2022-12-01T09:12:43Z",
                "StorageType": "standard",
                "ProcessI": 50,
                "CdnOut": 500
            }
        ],
        "HostId": "cn"
    },
    "Message": "Successful!",
    "RequestId": "4C489CA2-5036-4B06-95A9-34AF55FDE1B2",
    "Success": true,
    "Code": "Success"
}