查詢寫入量數據，支持應用監控、可觀測鏈路OpenTelemetry版、Prometheus、用戶體驗監控四大產品用量數據。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| arms:QueryCommercialUsage | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IntervalInSec | integer | 是 | 數據片的時間間隔，單位為秒，最小值為 3600。 枚舉值：
| 3600 |
| StartTime | long | 是 | 起始時間的時間戳，精確到毫秒。 | 1699200000000 |
| EndTime | long | 是 | 結束時間的時間戳，精確到毫秒。 | 1699286400000 |
| OrderBy | string | 否 | 排序依據，可設為任一 dimesion 枚舉值：
| dataType |
| Metric | string | 是 | 指標名稱，取值：USAGEFEE.STAT | USAGEFEE.STAT |
| Order | string | 否 | 排序標準。取值：
| ASC |
| AdvancedFilters | array<object> | 否 | 過濾條件數組 | |
| object | 否 | |||
| Key | string | 否 | 過濾條件的 key | regionId |
| Value | string | 否 | 過濾條件的 value | cn-hangzhou |
| OpType | string | 否 | 操作符，目前僅支持等于或者 in 枚舉值：
| eq |
| Dimensions | array | 否 | 指標對應的維度。
| |
| string | 否 | 指標對應的維度。 | dataType | |
| Measures | array | 否 | 指標對應的測量數據。 | |
| string | 否 | 指標對應的測量數據。目前僅支持 byte_sum | byte_sum | |
| QueryType | string | 是 | 查詢的數據返回類型：
| instantQuery |
返回參數
示例
正常返回示例
JSON格式
{
"Code": 200,
"HttpStatusCode": 0,
"Message": "success",
"RequestId": "99A663CB-8D7B-4B0D-A006-03C8EE38E7BB",
"Success": true,
"Data": {
"Complete": true,
"Items": [
{
"date": "1697108400",
"dataType": "metrics",
"byte_sum": 9497922
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ParameterMetricIllegal | The specified metric is invalid. | 參數metric非法 |
| 400 | ParameterMeasuresIllegal | The specified Measures is invalid. | Measures非法 |
| 400 | ParameterTimeStampIllegal | The specified timeStamp is invalid. | 時間參數非法 |
| 400 | ParameterOrderIllegal | The specified order is invalid. | 參數order非法 |
| 400 | ParameterPageSizeIllegal | The specified PageSize is invalid. | PageSize非法 |
| 400 | ParameterIntervalIllegal | The specified interval is invalid. | 參數Interval非法 |
| 400 | ParameterMeasuresMissing | You must specify measures. | 參數measures缺失 |
| 400 | ParameterDimensionsIllegal | The specified dimensions is invalid. | Dimensions非法 |
| 400 | ParameterRegionIdIllegal | The specified RegionId is invalid. | RegionId非法 |
| 400 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | 內部錯誤，建議重試。如果多次重試報錯請聯系釘釘服務賬號。 |
| 403 | APINotAuthorize | The current user is not authorized to access the interface. | 當前用戶無權限訪問該接口 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-25 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
- 調用時為什么會出現 RAM 的權限問題？ 這可能是由于該 RAM 角色沒有權限，您可以為用戶添加權限，請參見借助 RAM 角色實現跨云賬號訪問資源。
- 怎么拉取列表數據（不考慮時間粒度）？ 將 queryType 設置為 instantQuery
- 返回時間非法，目前 intervalInSec 僅支持 3600 以及 8600,不支持其他間隔