調用DescribeDomainUsageData查詢域名在特定計費區域的用量數據。
接口說明
-
此接口支持批量域名查詢，多個域名用英文逗號（,）分隔，最多一次可以查詢 100 個域名。如果 DomainName 參數為空，則返回賬號下所有域名的數據。
-
用量數據包括流量、帶寬和請求數三類，單位分別為 Byte、bps 和次數。
-
如果不指定 Interval 參數，最長可查詢近 1 年的數據，單次查詢的最大時間跨度為 31 天。查詢時間為 1~3 天，數據按小時粒度返回；查詢時間大于 3 天，數據按天粒度返回。
-
指定 Interval 參數時，支持單次查詢的時間跨度、對應的可查詢歷史數據時間范圍和數據延遲如下：
| 時間粒度 | 單次查詢的最大時間跨度 | 可查詢歷史數據時間范圍 | 數據延遲 |
|---|---|---|---|
| 5 分鐘 | 3 天 | 93 天 | 15 分鐘 |
| 1 小時 | 31 天 | 186 天 | 4 小時 |
| 1 天 | 90 天 | 366 天 | 次日凌晨 4 點 |
QPS 限制
本接口的單用戶 QPS 限制為 10 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| live:DescribeDomainUsageData | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 否 | 直播域名。
| example.com |
| StartTime | string | 是 | 起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。 | 2015-12-10T20:00:00Z |
| EndTime | string | 是 | 結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。 需大于起始時間，且與起始時間相差不能超過 31 天。 | 2015-12-10T21:00:00Z |
| Type | string | 否 | 需要獲取的用量類型。 當 Field 取值為 bps 或 traf 時，該參數取值范圍：
當 Field 取值為req_traf或req_bps 時，該參數取值范圍：
| all |
| Field | string | 是 | 查詢用量的數據類型。取值：
| traf |
| Area | string | 否 | 區域代號。支持：
說明
不傳值則默認為中國內地。海外大區說明：- 亞太 1 區：中國香港地區、中國澳門地區、中國臺灣地區、日本以及東南亞除越南和印尼之外的國家。- 亞太 2 區：印尼、韓國、越南。- 亞太 3 區：澳大利亞、新西蘭。北美：美國、加拿大。- 南美：巴西。- 歐洲：烏克蘭、英國、法國、荷蘭、西班牙、意大利、瑞典、德國。- 中東非洲：南非、阿曼、阿聯酋、科威特。
| CN |
| DataProtocol | string | 否 | 需要獲取的數據的協議。取值：
| all |
| Interval | string | 否 | 強制指定獲取指定時間粒度的數據，單位為秒。支持 300（5 分鐘）、3600（1 小時）和 86400（1 天）。 | 300 |
示例：當您查詢 12 月 21 日下午 1 點鐘數據，可在 12 月 21 日下午 3 點鐘獲取到 1 點及 1 點前的穩態數據。
返回參數
示例
正常返回示例
JSON格式
{
"EndTime": "2015-12-10T21:00Z",
"Type": "all",
"StartTime": "2015-12-10T20:00Z",
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"Area": "CN",
"DomainName": "example.com",
"DataInterval": "300",
"UsageDataPerInterval": {
"DataModule": [
{
"Value": "423304182",
"TimeStamp": "2015-12-10T20:00:00Z"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvaildParameter | Invalid Parameter | 請求參數非法 |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | StartTime參數錯誤，請您確認該StartTime參數是否正確。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 結束時間錯誤，請您確認結束時間是否正確。 |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 傳入的StartTime參數不支持。 |
| 400 | InvalidTime.Malformed | Specified Time is malformed. | 制定時間錯誤，請您確認該制定時間是否正確。 |
| 400 | InvalidParameterField | The specified Field is invalid. | Field參數錯誤，請確認后輸入 |
| 400 | InvalidParameterType | The specified Type is invalid. | Type參數錯誤，請確認后輸入 |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | 結束時間與開始時間不匹配，請您確認時間的匹配度。 |
| 400 | InvalidTimeSpan | The time span exceeds the limit. | 時間跨度超過限制，請參照接口文檔，配置合理查詢跨度。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-29 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
特殊錯誤碼
| 錯誤代碼 | 描述 | HTTP 狀態碼 | 語義 |
|---|---|---|---|
| Throttling | Request was denied due to request throttling. | 503 | 請求被流量控制限制 |
| IllegalOperation | Illegal domain, operation is not permitted. | 403 | 非法域名，無法操作 |
| OperationDenied | Your account does not open Live service yet. | 403 | 未開通 Live 服務 |
| OperationDenied | Your Live service is suspended. | 403 | Live 服務已被停止 |
| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不屬于當前用戶 |
| InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下線 |
| ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中，請稍后再試 |
| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失敗 |
| InvalidParameter | Invalid Parameter. | 400 | 參數錯誤 |
| InvalidParameterProduct | Invalid Parameter Product. | 400 | Product 參數錯誤 |
| InvalidParameterArea | Invalid Parameter Area. | 400 | Area 參數錯誤 |
| InvalidParameterField | Invalid Parameter Field. | 400 | Field 參數錯誤 |
| InvalidParameterStartTime | Invalid Parameter StartTime. | 400 | StartTime 參數錯誤 |
| InvalidParameterEndTime | Invalid Parameter EndTime. | 400 | EndTime 參數錯誤 |
| InvalidTimeRange | StartTime and EndTime range should less than 1 month. | 400 | EndTime 和 StartTime 差值不能超過 31 天 |
| InvalidParameterInterval | Invalid Parameter Interval. | 400 | Interval 參數錯誤 |