租用戶資源使用量 API 參考
租使用者可以使用租使用者 API 來檢視租使用者自己的資源使用量數據。 這些 API 與 Azure 使用量 API 一致。
您可以使用 Windows PowerShell Cmdlet Get-UsageAggregates 來取得使用量數據,就像在 Azure 中一樣。
API 呼叫
Request
要求可取得所要求的訂用帳戶在要求的時間範圍內的取用量詳細資料。 沒有要求本文。
方法 | 要求 URI |
---|---|
GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value} |
參數
參數 | 說明 |
---|---|
Armendpoint | 您 Azure Stack Hub 環境的 Azure Resource Manager 端點。 Azure Stack Hub 慣例是,Azure Resource Manager 端點的名稱格式 https://management.{domain-name} 為 。 例如,針對開發工具包,功能變數名稱是local.azurestack.external,則Resource Manager端點為 https://management.local.azurestack.external 。 |
subId | 進行通話之用戶的訂用帳戶標識碼。 您只能使用此 API 來查詢單一訂用帳戶的使用方式。 提供者可以使用提供者資源使用量 API 來查詢所有租使用者的使用量。 |
reportedStartTime | 查詢的開始時間。 DateTime 的值應該在 UTC 和小時開頭,例如 13:00。 針對每日彙總,請將這個值設定為 UTC 午夜。 格式會逸出 ISO 8601;例如, 2015-06-16T18%3a53%3a11%2b00%3a00Z,其中冒號會逸出至 %3a,加號會逸出至 %2b,使其 URI 易記。 |
reportedEndTime | 查詢的結束時間。 套用至 reportedStartTime 的條件約束也適用於此參數。 reportedEndTime 的值不能在未來。 |
aggregationGranularity | 具有兩個離散潛在值的選擇性參數: 每日 和 每小時。 如同以上兩個值所暗示,一個會每日傳回資料,另一個則會每小時傳回資料。 每日選項是預設值。 |
api-version | 用來提出此要求的通訊協定版本。 您必須使用 2015-06-01-preview。 |
continuationToken | 從上次呼叫使用情況 API 提供者所擷取的權杖。 當回應大於 1,000 行時,就需要這個權杖。 它可作為進度的書籤。 如果沒有,則會根據傳入的數據粒度,從一天或一小時開始擷取數據。 |
回應
GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0
{
"value": [
{
"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",
"properties": {
"subscriptionId":"sub1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"
}
},
...
回覆詳細資料
參數 | 說明 |
---|---|
id | 使用情況彙總的唯一識別碼。 |
NAME | 使用情況彙總的名稱。 |
type | 資源定義。 |
subscriptionId | Azure 使用者的訂用帳戶標識碼。 |
usageStartTime | 此使用情況彙總所屬的使用情況貯體 UTC 開始時間。 |
usageEndTime | 此使用情況彙總所屬的使用情況貯體 UTC 結束時間。 |
instanceData | 實例詳細數據的索引鍵/值組(格式為): resourceUri:完整資源標識符,包括資源群組和實例名稱。 location:執行此服務的區域。 tags:使用者指定的資源標籤。 additionalInfo:已取用之資源的詳細數據。 例如,OS 版本或映像類型。 |
數量 | 此時間範圍內發生的資源取用量。 |
meterId | 已取用之資源的唯一標識碼(也稱為 ResourceID)。 |