This topic describes how to call QueryUserOmsData to query Object Storage Service (OSS) billing data generated on an hourly basis.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryUserOmsData The operation that you want to perform. Set the value to QueryUserOmsData.
DataType String Yes Hour The unit in which billing data is generated. Set the value to Hour.
Table String Yes OSS The type of report that contains billable items. Valid values:
  • OSS: the OSS billing report that contains basic OSS billable items.
  • OssDataReplication: the OSS billing report that contains billable items related to cross-region replication (CRR).
  • OssSddpScan: the OSS billing report that contains billable items related to Sensitive Data Discovery and Protection (SDDP).
  • OssCache: the OSS billing report that contains billable items related to the accelerator cache capacity.
StartTime String Yes 2021-01-22T09:12:43.083Z The beginning of the time range to query. The time must be in UTC.
EndTime String Yes 2021-01-22T10:12:43.083Z The end of the time range to query. The time must be in UTC.
Maker String No test Specifies that billing data that is alphabetically after the value of Marker is returned. By default, if this parameter is not specified, all billing data is returned.
PageSize Integer No 50 Specifies the number of rows on each returned page for paginating query results.

Valid values: 1 to 200.

Default value: 100.

Response parameters

  • Response parameters in the billing report that contains basic OSS billable items
    Parameter Type Example Description
    HostId String cn The site to which the user belongs. Valid value:intl.
    LessthanMonthDatasize Integer 180 The storage fees billed for Infrequent Access (IA) and Archive objects that are stored for less than the minimum storage duration.
    • Storage usage of IA objects that are stored for less than the minimum storage duration

      If an IA locally redundant storage (LRS) object is deleted after it is stored for less than 30 days (720 hours), the storage fees for the object are charged as it is stored for 30 days, including the remaining duration (720 hours - Actual storage duration).

    • Storage usage of Archive objects that are stored for less than the minimum storage duration

      If an Archive LRS object is deleted after it is stored for less than 60 days (1,440 hours), the storage fees for the object are charged as it is stored for 60 days, including the remaining duration (1,440 hours - Actual storage duration).

    ChargedDatasize Integer 200 The charged storage usage of IA and Archive objects.
    RetrievalData Integer 200 The size of retrieved IA and Archive objects.
    • Size of retrieved IA objects

      Fees are billed based on retrieved IA objects. You are charged data retrieval fees based on the size of retrieved objects.

    • Size of retrieved Archive objects

      Fees are billed based on retrieved Archive objects. You are charged data retrieval fees based on the size of retrieved objects.

    ChargedDatasizeCA Integer 100 You are charged storage fees based on the total size and storage duration of Cold Archive LRS objects.
    Notice Cold Archive objects have a minimum billable size of 64 KB. Objects that are smaller than 64 KB in size are charged as 64 KB. Objects that are larger than or equal to 64 KB in size are charged based on their actual sizes.
    EarlyDeletionCA Integer 100 If a Cold Archive object is overwritten or deleted after it is stored for less than 180 days (4,320 hours), the storage fees for the object are charged as it is stored for 180 days, including the remaining duration (4,320 hours - Actual storage duration).
    Bucket String examplebucket The name of the bucket.
    NetworkIn Integer 2000 The traffic generated by the data transmission from the client to OSS over the Internet within the duration of the request. Unit: bytes.
    NetworkOut Integer 2000 The traffic generated by the data transmission from OSS to the client over the Internet within the duration of the request. Unit: bytes.
    PutRequest Integer 1000 Fees are billed based on the number of complete PUT requests initiated by calling OSS API operations.
    GetRequest Integer 2000 Fees are billed based on the number of complete GET requests initiated by calling OSS API operations.
    ProcessImgSize Integer 200 You are charged data processing fees based on the size of the processed source images. Unit: bytes.
    AdvImageProcLow Integer 200 You are charged image processing fees based on the number of times that you use the advanced image compression feature to process images. The size of images compressed by using advanced image compression is smaller than 800 × 600 pixels.
    AdvImageProcMed Integer 200 You are charged image processing fees based on the number of times that you use the advanced image compression feature to process images. The size of images compressed by using advanced image compression is smaller than 1600 × 1200 pixels.
    Storage Integer 2000 The billed storage usage of objects whose storage classes are those specified by StorageType. Unit: bytes.
    Note
    • If you call GetBucketInfo by using an endpoint that is not corresponding to the region in which the bucket is located, the value of Storage may be 0.
    • The billed storage usage of IA, Archive, or Cold Archive objects is different from the charged storage usage of these objects. For more information about the charged storage usage of these objects, see the corresponding parameter details.
    StorageType String Standard The storage class. Valid values:
    • standard: This storage class is suitable for data that is frequently accessed.
    • IA: This storage class is suitable for data that is infrequently accessed, such as once or twice a month. IA objects have a minimum storage period of 30 days and a minimum billable size of 64 KB.
    • archive: This storage class is suitable for data that needs to be stored for a long period of time. Archive objects have a minimum storage period of 60 days and a minimum billable size of 64 KB. You must restore an Archive object before you can access it. The restoration takes approximately 1 minute. When you restore Archive objects, you are charged data retrieval fees.
    • coldarchive: This storage class is suitable for data that needs to be stored over an ultra-long period of time. Cold Archive objects have a minimum storage period of 180 days and a minimum billable size of 64 KB. You must restore a Cold Archive object before you can access it. The amount of time required to restore a Cold Archive object depends on the object size and the restoration mode. When you restore Cold Archive objects, you are charged data retrieval fees.
    • standard-zrs: This storage class uses the multi-zone mechanism to distribute user data across three zones within the same region. If one zone becomes unavailable, you can continue to access the data that is stored in the other two zones.
    • IA-zrs: This storage class uses the multi-zone mechanism to distribute user data across three zones within the same region. If one zone becomes unavailable, you can continue to access the data that is stored in the other two zones.

    For more information about storage classes, see Overview.

    CAStdRetrievalData Integer 65536 The amount of data retrieved when the Cold Archive data is restored between 2 and 5 hours based on the standard priority. Unit: bytes.
    CABulkRetrievalData Integer 65536 The amount of data retrieved when the Cold Archive data is restored between 5 and 12 hours based on the bulk priority. Unit: bytes.
    CAHighPriorRetrievalData Integer 65536 The amount of data retrieved when the Cold Archive data is restored within 1 hour based on the expedited priority. Unit: bytes.
    CAStdRetrievalRequest Integer 10000 The number of requests sent to restore the Cold Archive data with the standard priority.
    CABulkRetrievalRequest Integer 10000 The number of requests sent to restore the Cold Archive data with the bulk priority.
    CAHighPriorRetrievalRequest Integer 10000 The number of requests sent to restore the Cold Archive data with the expedited priority.
    CdnIn Integer 500 The upstream traffic generated when you access data by using Content Delivery Network (CDN) after the CDN acceleration service is activated.
    CdnOut Integer 500 The downstream traffic generated when you access data by using CDN after the CDN acceleration service is activated. The downstream traffic is also the back-to-origin traffic.
    ProcessI Integer 50 You are charged image processing fees based on the number of images captured by using video snapshots.
    StorageZRS Integer 100 You are charged storage fees based on the total size and storage duration of Standard zone-redundant storage (ZRS) objects.
    ChargedDatasizeZRS Integer 65536 You are charged storage fees based on the total size and storage duration of IA ZRS objects.

    IA ZRS objects have a minimum billable size of 64 KB. Objects that are smaller than 64 KB in size are charged as 64 KB. Objects that are larger than or equal to 64 KB in size are charged based on their actual sizes.

    LessthanMonthDatasizeZRS Integer 700 If an IA ZRS object is deleted after it is stored for less than 30 days (720 hours), the storage fees for the object are charged as it is stored for 30 days, including the remaining duration (720 hours - Actual storage duration).
    AccM2MIn Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and upload data between regions inside the Chinese mainland. Unit: bytes.
    AccM2MOut Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and download data between regions inside the Chinese mainland. Unit: bytes.
    AccM2OIn Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and upload data from regions inside the Chinese mainland to regions outside the Chinese mainland. Unit: bytes.
    AccM2OOut Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and download data from regions inside the Chinese mainland to regions outside the Chinese mainland. Unit: bytes.
    AccO2MIn Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and upload data from regions outside the Chinese mainland to regions inside the Chinese mainland. Unit: bytes.
    AccO2MOut Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and download data from regions outside the Chinese mainland to regions inside the Chinese mainland. Unit: bytes.
    AccO2OIn Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and upload data between regions outside the Chinese mainland. Unit: bytes.
    AccO2OOut Integer 500 The traffic generated when your acceleration endpoint is used to access OSS and download data between regions outside the Chinese mainland. Unit: bytes.
    SelectScanSize Integer 300 You are charged scanning fees based on the size of objects scanned by OSS Select.
    TagCount Integer 100 You are charged tagging fees based on the number of object tags in a bucket.
    StartTime String 2021-02-22T09:12:43.083Z The time when billing data starts to be generated. The time is in UTC.
    EndTime String 2021-02-22T15:12:43.083Z The time when billing data stops to be generated. The time is in UTC.
  • Response parameters in the OssDataReplication billing report
    Parameter Type Example Description
    HostId String cn The site to which the user belongs. Valid value:intl.
    ProviderId String 26842 The ID of the product provider. Valid value:26888.
    UserId String 148562088256**** The UID of the Alibaba Cloud account.
    SourceRegion String oss-cn-hangzhou The region in which the source bucket is located when CRR is used.
    DestRegion String oss-us-west-1 The region in which the destination bucket is located when CRR is used.
    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 replicated from the source bucket to the destination bucket. Unit: bytes.
    StartTime String 2021-05-22T10:12:43.083Z The time when billing data starts to be generated. The time is in UTC.
    EndTime String 2021-05-22T12:12:43.083Z The time when billing data stops to be generated. The time is in UTC.
  • Response parameters in the OssSddpScan billing report
    Parameter Type Example Description
    HostId String cn The site to which the user belongs. Valid value:intl.
    ProviderId String 26842 The ID of the product provider. Valid value:26888.
    UserId String 148562088256**** The UID of the Alibaba Cloud account.
    Bucket String examplebucket The name of the bucket in which the sensitive data is stored.
    StartTime String 2021-05-22T10:12:43.083Z The time when billing data starts to be generated. The time is in UTC.
    EndTime String 2021-05-22T12:12:43.083Z The time when billing data stops to be generated. The time is in UTC.
    SddpScanSize Integer 1000 The size of data on which Sensitive Data Discovery and Protection (SDDP) is authorized to perform full or incremental scanning. Unit: bytes.
  • Response parameters in the OssCache billing report
    Parameter Type Example Description
    HostId String cn The site to which the user belongs. Valid value:intl.
    ProviderId String 26842 The ID of the product provider. Valid value:26888.
    UserId String 148562088256**** The UID of the Alibaba Cloud account.
    Zone String Zone-A The zone of the accelerator.
    StartTime String 2021-05-22T10:12:43.083Z The time when billing data starts to be generated. The time is in UTC.
    EndTime String 2021-05-22T12:12:43.083Z The time when billing data stops to be generated. The time is in UTC.
    CacheSize Integer 1000 The capacity of the accelerator cache. Unit: bytes.

Examples

  • Sample requests
    https://business.aliyuncs.com/?Action=QueryUserOmsData
    &DataType=Hour
    &EndTime=2021-01-22T10:12:43.083Z
    &StartTime=2021-01-22T09:12:43.083Z
    &Table=oss
    &<Common request parameters>
  • Sample responses
    {
        "Data": {
            "OmsData": [
                {
                    "LessthanMonthDatasize": "180",                
                    "RetrievalData": "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": "2021-05-22T10:12:43.083Z",
                    "StartTime": "2021-05-22T12:12:43.083Z",
                    "StorageType": "standard",
                    "ProcessI": "50",
                    "CdnOut": "500"
                }
            ],
            "HostId": "cn"
        },
        "Message": "Successful!",
        "RequestId": "4C489CA2-5036-4B06-95A9-34AF55FDE1B2",
        "Success": true,
        "Code": "Success"
    }