list usageRecordReports

GET https://api.suger.cloud/org/{orgId}/usageRecordReport

List usageRecordReports under the given organization, partner, entitlement or buyer, within the given time range and pagination.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`partner`	query	string	no	Cloud Partner
`buyerId`	query	string	no	buyer ID
`entitlementId`	query	string	no	entitlement ID
`startDate`	query	string	no	start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate
`endDate`	query	string	no	end date (UTC) in YYYY-MM-DD format, default is today
`limit`	query	integer	no	List pagination size, default 1000, max value is 1000
`offset`	query	integer	no	List pagination offset, default 0

Responses

200 — OK

Content-Type: application/json · Schema: ListUsageRecordReportsResponse

ListUsageRecordReportsResponse fields:

Field	Type	Required	Description
`nextOffset`	integer	no
`usageRecordReports`	array<MeteringUsageRecordReport>	no

MeteringUsageRecordReport fields:

Field	Type	Required
`buyerID`	string	no
`creationTime`	string	no
`entitlementID`	string	no
`entitlementTermID`	string	no
`id`	string	no
`info`	MeteringUsageRecordReportInfo	no
`organizationID`	string	no
`partner`	string	no
`productID`	string	no

MeteringUsageRecordReportInfo fields:

Field	Type	Required	Description
`aggregatedBillableRecords`	array<AggregatedMeteringUsageRecord>	no	The aggregated billable records from the usage metering API v2.
`aggregatedUsageAllocations`	object	no	The aggregated usage allocations
`alibabaInternationalMeteringRequest`	github_com_alibabacloud-go_marketplaceintl-20221230_client.PushMeteringDataRequest	no
`alibabaInternationalMeteringResponse`	github_com_alibabacloud-go_marketplaceintl-20221230_client.PushMeteringDataResponseBody	no
`alibabaMeteringRequest`	github_com_alibabacloud-go_market-20151101_v3_client.PushMeteringDataRequest	no
`alibabaMeteringResponse`	github_com_alibabacloud-go_market-20151101_v3_client.PushMeteringDataResponseBody	no
`awsMeteringRequest`	AwsMarketplaceMeteringBatchMeterUsageInput	no
`awsMeteringResponse`	marketplacemetering.BatchMeterUsageOutput	no
`azureMeteringRequest`	AzureMarketplaceMeteringBatchUsageEvent	no
`azureMeteringResponse`	marketplacemeteringv1.BatchUsageEventOkResponse	no
`commitAmount`	number	no	The amount of the commit if applicable.
`creditAmount`	number	no	The amount of the credit if applicable.
`creditRecords`	object	no	The credit usage records in the map of <DimensionKey, Count> for usage metering API v1.
`decimalParts`	object	no	The decimal parts of the usage dimension quantity in the map of <DimensionKey, DecimalPart>, before this usage record report.
`dimensionCategories`	object	no	The categories of the usage records in the map of <DimensionKey, Category>. The dimension category is required when reporting usage records to Alibaba Marketplace. It comes from the metering dimension category.
`dimensionUnitListPrice`	object	no	The public list price of each dimension in the map of <DimensionKey, UnitPrice>.
`dimensionUnitPrice`	object	no	The unit price of each dimension in the map of <DimensionKey, UnitPrice>. It can be the negotiated price in the private offer or the public list price.
`endTime`	string	no	time in UTC when the UsageRecordReport ends
`gcpMeteringRequest`	GcpMarketplaceMeteringOperation	no
`gcpMeteringResponse`	servicecontrol.ReportResponse	no
`includedRecords`	object	no	The included usage records in the map of <DimensionKey, Count> for usage metering API v1.
`message`	string	no
`newDecimalParts`	object	no	The decimal parts of the usage dimension quantity in the map of <DimensionKey, DecimalPart>, after this usage record report.
`oracleMeteringRequest`	OracleMeteringRequest	no
`oracleMeteringResponse`	OracleMeteringResponse	no
`oracleTimeUsageEnded`	string	no
`oracleTimeUsageStarted`	string	no	OracleTimeUsageStarted / OracleTimeUsageEnded are the span of the usage this report bills, taken from the contributing groups' usage timestamps, and are what OCI is sent as TimeUsageStarted / TimeUsageEnded. OCI SELF only requires started < ended, so the span needs no hour alignment — that is an AWS/GCP bucket-API requirement, not Oracle's. Kept separate from StartTime/EndTime for the same reason as SnowflakeEventTimestamp above: those two are the CreationTime-based usage-record-group status window, and narrowing them to the usage span makes BatchUpdateUsageRecordGroupStatus (and the shared post-metering update) miss the very groups the report claims — a silent zero-row write that leaves them CREATED for the next run to bill again.
`partner`	string	no	The partner where this usage record report is sent to. Such as AWS, AZURE or GCP.
`recordsToReportBeforeAdjustmentAtListPrice`	object	no	The usage records to report before the adjustment by the commit with additional usage at list price, in the map of <DimensionKey, Count>.
`reportedRecords`	object	no	The reported usage records in the map of <DimensionKey, Count> for usage metering API v1.
`snowflakeEventTimestamp`	string	no	SnowflakeEventTimestamp is the report-generation time (now) captured when the report is aggregated; the reporter grounds it to the hour to derive a stable, recent event_timestamp for SYSTEM$CREATE_MARKETPLACE_CHARGE — never a customer-supplied usage time, which could exceed Snowflake's 6h backfill window. Kept separate from EndTime so the CreationTime-based usage-record-group status window stays correct.
`snowflakeMeteringCharges`	array<SnowflakeMeteringCharge>	no	Per-event SYSTEM$CREATE_MARKETPLACE_CHARGE calls emitted for this report. Snowflake has no batch metering API, so one entry is recorded per dimension.
`startTime`	string	no	time in UTC when the UsageRecordReport starts
`status`	UsageRecordReportStatus	no
`usageRecordGroupIds`	array<string>	no	The IDs of UsageRecordGroups aggregated in this UsageRecordReport.
`usedCommitAmount`	number	no	The amount of the used commit before this usage record report if applicable.
`usedCommitAmountIncrement`	number	no	The amount of the used commit increment in this usage record report if applicable.
`usedCreditAmount`	number	no	The amount of the used credit before this usage record report if applicable.
`usedCreditAmountIncrement`	number	no	The amount of the used credit increment in this usage record report if applicable.

AggregatedMeteringUsageRecord fields:

Field	Type	Required	Description
`amount`	number	no	Amount calculated by billable dimension's price model, this is only used for report billable usage records to marketplace.
`billableMetricAggregationType`	BillableMetricAggregationType	no
`billableMetricInfo`	BillableMetricInfo	no
`groupBysExpression`	string	no	GroupBysExpression is the string expression of array of group bys.
`key`	string	no	Key is the unique identifier of a billable metric.
`name`	string	no	Name is the name of a billable metric. Optional, it is only for display purpose.
`quantity`	number	no	Value is the value of a billable metric.
`uniqueCountAggregationResult`	UniqueCountAggregationResult	no

github_com_alibabacloud-go_marketplaceintl-20221230_client.PushMeteringDataRequest fields:

Field	Type	Required	Description
`GmtCreate`	string	no	example: 2023-01-11 10:31:00
`MeteringData`	array<client.PushMeteringDataRequestMeteringData>	no

github_com_alibabacloud-go_marketplaceintl-20221230_client.PushMeteringDataResponseBody fields:

Field	Type	Required	Description
`Code`	string	no	example: 200
`DynamicMessage`	string	no	example: parameter \\"service\\" can not be blank.
`ForceFatal`	boolean	no	example: false
`Message`	string	no	example: Instance 5723f7ee-952d-411f-94f4-b942a550d9b8 does not exist.
`RequestId`	string	no	example: A6A33748-D573-593C-A3BC-593E33D68311
`Result`	boolean	no	example: True
`Success`	boolean	no	example: True

github_com_alibabacloud-go_market-20151101_v3_client.PushMeteringDataRequest fields:

Field	Type	Required	Description
`Metering`	string	no	example: [{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]

github_com_alibabacloud-go_market-20151101_v3_client.PushMeteringDataResponseBody fields:

Field	Type	Required	Description
`RequestId`	string	no	example: 6EF60BEC-0242-43AF-BB20-270359FB54A7
`Success`	boolean	no	example: true

AwsMarketplaceMeteringBatchMeterUsageInput fields:

Field	Type	Required	Description
`ProductCode`	string	no	Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
`UsageRecords`	array<AwsMarketplaceMeteringUsageRecord>	no	The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

marketplacemetering.BatchMeterUsageOutput fields:

Field	Type	Required	Description
`resultMetadata`	ResponseMetadata	no
`results`	array<types.UsageRecordResult>	no	Contains all UsageRecords processed by BatchMeterUsage . These records were either honored by Amazon Web Services Marketplace Metering Service or were invalid. Invalid records should be fixed before being resubmitted.
`unprocessedRecords`	array<types.UsageRecord>	no	Contains all UsageRecords that were not processed by BatchMeterUsage . This is a list of UsageRecords . You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest .

AzureMarketplaceMeteringBatchUsageEvent fields:

Field	Type	Required	Description
`request`	array<AzureMarketplaceMeteringUsageEvent>	no

marketplacemeteringv1.BatchUsageEventOkResponse fields:

Field	Type	Required	Description
`count`	integer	no
`result`	array<marketplacemeteringv1.UsageBatchEventOkMessage>	no

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.