组织
查看单个用量事件
返回一个用量事件的完整明细:用量、费用、结算状态与支付它的交易(x_Charges);不存在的 id 与别的组织的事件同样返回 404。
GET
/organization/v1/events/{id}● 支持请求参数
idstring必填path: 用量事件 id,来自用量事件列表的 data[].id
返回
200 usage.event
错误按 problem+json 格式返回,参见 错误码
响应
HTTP 200
The usage event
application/json
| 名称 | 类型 | 说明 |
|---|---|---|
| object | string | Object type; always `usage.event`. |
| id | string | Id of the usage event; pass it to getOrganizationEvent. |
| occurred_at | string | Time at which the usage happened, UTC. |
| ServiceName | string | Name of the platform service that produced the usage (the source service of the usage event). |
| ServiceCategory | string | Category of the service; a service without a registered category reports its own name. |
| ResourceId | string | Id of the resource that the usage belongs to. |
| ResourceName | string | Display name of the resource; falls back to ResourceId when no name is known. |
| BilledCost | string | Amount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles. |
| BillingCurrency | string | Currency of BilledCost; always `USD`. |
| ChargeClass | string | null | `Correction` for an event that corrects an earlier charge (its BilledCost is negative); null for ordinary usage. |
| request_id | string | null | X-Request-Id of the API call that produced the usage; null for usage that does not come from a request. |
| settlement | object | How the usage was charged: settlement state, any shortfall, and why nothing was charged. |
| settlement.status | string | Settlement state of the event. |
| settlement.shortfall | string | null | USD amount that could not be charged, as a decimal string, when status is settled_with_shortfall; null otherwise. |
| settlement.zero_reason | string | null | Why nothing was charged for the event: `byok` when the caller used its own provider key; null when a charge applies. |
| lines | array<object> | Priced lines of the event; their BilledCost values add up to the event's BilledCost. |
| lines[].meter | string | Key of the meter that measured the line. |
| lines[].display_name | string | English label of the meter; falls back to the meter key in list pages. |
| lines[].ConsumedQuantity | string | Quantity consumed, an exact decimal string in ConsumedUnit. |
| lines[].ConsumedUnit | string | Unit of ConsumedQuantity as reported by the metering line; quantities of different units are never added together. |
| lines[].ListUnitPrice | string | null | List price in USD per PricingUnit as a decimal string; null when the line is not priced. |
| lines[].PricingUnit | string | null | Unit that ListUnitPrice applies to; null when the line is not priced. |
| lines[].BilledCost | string | Amount billed for this line in USD as a decimal string. |
| x_Charges | array<object> | The transactions that paid this event; their BilledCost sums to the event's BilledCost. |
| x_Charges[].transaction_id | string | The id of the billing transaction that paid part of this event. |
| x_Charges[].BilledCost | string | Amount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles. |
| x_Charges[].BillingCurrency | string | Currency of BilledCost; always `USD`. |
| x_Charges[].sub_account | string | Which balance the transaction was taken from. |
响应字段
| 字段 | 说明 |
|---|---|
object / id / occurred_at | 固定 "usage.event"、事件 id、发生时间(UTC) |
ServiceName / ServiceCategory / ResourceId / ResourceName / BilledCost / BillingCurrency / ChargeClass / request_id / settlement | 与用量事件列表中同一事件完全相同的字段 |
lines[].meter / lines[].display_name | 计量项标识与其英文显示名 |
lines[].ConsumedQuantity / ConsumedUnit | 该计量项的消耗数量与单位 |
lines[].ListUnitPrice / PricingUnit | 恒为 null:计费按整个事件定价,没有逐计量项的单价 |
lines[].BilledCost | 该计量项的费用,等于事件的 BilledCost |
x_Charges[] | 支付这个事件的交易:transaction_id、BilledCost、BillingCurrency,以及 sub_account(promotional 赠送额度或 cash 现金;赠送额度先扣)。各笔相加等于事件的 BilledCost |
支付一个事件的交易明细见查看单个用量事件。