chargebackData

Content Platform Tenant Management
Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The chargebackData data type describes the chargebackData property of the chargebackReport data type. The chargebackReport data type is used to generate chargeback reports.

Most of the properties in the chargebackData data type represent statistics that describe the usage of a given namespace or of all the namespaces owned by a given tenant. In a chargeback report, each set of these statistics applies to one namespace or tenant during a given reporting interval (for example, one hour or one day).

Chargeback statistics either reflect a point in time or are dynamic. Point-in-time statistics are measurements taken at the end of a reporting interval, such as the used storage capacity for a namespace at the end of an hour. Dynamic statistics are measurements, such as the number of reads or writes to a namespace, that are accumulated over time.

HCP accumulates dynamic statistics on an hourly basis, starting at the beginning of each hour. So, for example, if the reporting interval is an hour, one statistic might represent the number of successful writes to a namespace that occurred between 11:00:00 and 11:59:59. If the reporting interval is a day, each reported dynamic statistic is the sum of the hourly values for the day, where the day starts at 00:00:00 and ends at 23:59:59.

Properties

The table below describes the properties included in the chargebackData data type. When the output format for a chargebackReport resource is CSV, the properties included in the chargebackData data type are ordered. This table lists the properties in the order in which they appear in a CSV response body.

Property name Data type Description Notes
systemName String

One of:

  • The name of the domain associated with the [hcp_system] network for the HCP system to which the set of aggregated statistics in the line applies
  • The name of the domain associated with the data access network for the tenant to which the set of aggregated statistics in the line applies
  • The name of the domain associated with the data access network for the tenant that owns the namespace to which the set of statistics in the line applies
tenantName String

Either:

  • The name of the tenant to which the set of statistics applies
  • The name of the tenant that owns the namespace to which the set of statistics applies
namespaceName String The name of the namespace to which the set of statistics applies. For aggregated namespace statistics, this property has no value.
startTime String

The start time of the reporting interval to which the set of statistics applies, in this ISO 8601 format:

yyyy-MM-ddThh:mm:ssZ

Z represents the offset from UTC, in this format:

(+|-)hhmm

For example:

2017-02-18T14:00:00-0500
endTime String The end time of the reporting interval to which the set of statistics applies, in the same ISO 8601 format as is used for the startTime property.
objectCount Long

The total number of objects currently stored in the given namespace or in all the namespaces owned by the given tenant.

Each version of an object counts as a separate object. The object count does not include object versions that are delete markers or delete records.

Each multipart object counts as a single object. Objects that are in the process of being created by multipart uploads are not included in the object count.

 This is a point-in-time statistic.
ingestedVolume Long The total size of the currently stored data and custom metadata, in bytes, before it was added to the given namespace or to all the namespaces owned by the given tenant. This is a point-in-time statistic.

storageCapacity

Used

 Long

The total number of bytes currently occupied by stored data in the given namespace or in all the namespaces owned by the given tenant. This includes object data, metadata, and any redundant data required to satisfy the applicable service plan.

Used storage capacity also includes storage occupied by the parts of in-progress multipart uploads that have already been written to HCP. Used storage capacity does not include replaced parts of multipart uploads, parts uploaded for aborted multipart uploads, or unused parts of completed multipart uploads.

 This is a point-in-time statistic.
bytesIn Long

The total number of bytes successfully written to the given namespace or to all the namespaces owned by the given tenant during the reporting interval.

The total number of bytes written includes all parts uploaded for multipart uploads regardless of whether the upload of the part has finished, the part was subsequently replaced, the multipart upload was aborted, or the part was not used in the completed multipart upload.

If data was compressed before being transmitted, this is the number of bytes before compression.

 This is a dynamic statistic.
bytesOut Long

The total number of bytes read from the given namespace or from all the namespaces owned by the given tenant during the reporting interval.

If data (including XML for directory listings) was compressed before being transmitted, this is the number of bytes before compression.

 This is a dynamic statistic.
reads Long

The total number of read operations performed in the given namespace or in all the namespaces owned by the given tenant during the reporting interval.

A read of a multipart object counts as a single read operation.

 This is a dynamic statistic.
writes Long

The total number of write operations successfully performed in the given namespace or in all the namespaces owned by the given tenant during the reporting interval.

Each upload of a part for a multipart upload counts as a separate write operation. This applies even if the part was subsequently replaced, the multipart upload was aborted, or the part was not used in the completed multipart upload.

 This is a dynamic statistic.
deletes Long

The total number of delete and purge operations performed in the given namespace or in all the namespaces owned by the given tenant during the reporting interval.

A delete of a multipart object counts as a single delete operation. The count of delete and purge operations does note include automatic deletions of replaced parts, parts of aborted multipart uploads, or unused parts of completed multipart uploads.

 This is a dynamic statistic.
multipartObjects Long The total number of multipart objects currently stored in the given namespace or in all the namespaces owned by the given tenant. This is a point-in-time statistic.
mulltipartObject Parts Long The total number of parts of multipart objects currently stored in the given namespace or in all the namespaces owned by the given tenant. This is a point-in-time statistic.
mulltipartObject Bytes Long The total number of bytes of object data in all the parts of multipart objects currently stored in the given namespace or in all the namespaces owned by the given tenant. This is a point-in-time statistic.
multipartUploads Long The total number of multipart uploads that are currently in progress in the given namespace or in all the namespaces owned by the given tenant. This is a point-in-time statistic.
multipartUpload Parts Long

The total number of successfully uploaded parts of multipart uploads that are currently in progress in the given namespace or in all the namespaces owned by the given tenant.

This number does not include replaced parts of multipart uploads, parts uploaded for aborted multipart uploads, or unused parts of completed multipart uploads.

 This is a point-in-time statistic.
multipartUpload Bytes Long

The total number of bytes of object data in all the successfully uploaded parts of multipart uploads that are currently in progress in the given namespace or in all the namespaces owned by the given tenant.

This number does not include bytes of data in replaced parts of multipart uploads, parts uploaded for aborted multipart uploads, or unused parts of completed multipart uploads.

 This is a point-in-time statistic.
deleted String

One of:

false
The namespace or tenant currently exists.
included
For a tenant only, the statistics in the set include values for one or more namespaces that were subsequently deleted.
valid Boolean

The status of the set of statistics in the line. Possible values are:

true
HCP successfully collected all statistics in the set.
false
The statistics in the set do not reflect all the activity that occurred during the reporting interval. This may be due, for example, to one or more nodes being unavailable during that time, to a network failure, or to other hardware issues.
  

Example

Here’s an XML example of the chargebackData data type that shows the properties for a namespace:

<chargebackData>
    <bytesIn>134243721</bytesIn>
    <bytesOut>87561</bytesOut>
    <deleted>false</deleted>
    <deletes>0</deletes>
    <endTime>2017-02-18T13:59:59-0500</endTime>
    <ingestedVolume>134243721</ingestedVolume>
    <multipartObjectBytes>93213889</multipartObjectBytes>
    <multipartObjectParts>7</multipartObjectParts>
    <multipartObjects>2</multipartObjects>
    <multipartUploadBytes>0</multipartUploadBytes>
    <multipartUploadParts>0</multipartUploadParts>
    <multipartUploads>0</multipartUploads>
    <namespaceName>finance</namespaceName>
    <objectCount>6</objectCount>
    <reads>1</reads>
    <startTime>2017-02-18T13:00:00-0500</startTime>
    <storageCapacityUsed>134270976</storageCapacityUsed>
    <systemName>hcp.example.com</systemName>
    <tenantName>europe</tenantName>
    <valid>true</valid>
    <writes>11</writes>
</chargebackData>