DescribeVodDomainReqHitRateData - 查詢請求命中率 -

調用本介面查詢加速網域名稱的請求命中率（命中請求百分比）。

介面說明

目前該介面服務地址僅支援：華東 2（上海）。
支援批量查詢，一次最多查詢 500 個網域名稱資料。
如果您不指定StartTime和EndTime，該介面預設返回過去 24 小時的資料；指定StartTime和EndTime，該介面返回指定時間段的資料。

返回資料時間粒紋

根據您指定StartTime和EndTime的時間跨度，且未同時設定Interval的情況下，預設返回的資料時間粒紋，以及對應的可查詢歷史資料時間範圍和資料延遲如下：

時間粒紋	單次查詢的時間跨度	可查詢歷史資料時間範圍	資料延遲
5 分鐘	單次查詢的時間跨度＜ 3 天	93 天	15 分鐘
1 小時	3 天 ≤ 單次查詢的時間跨度＜ 31 天	186 天	一般延遲 3-4 小時
1 天	31 天 ≤ 單次查詢的時間跨度 ≤ 90 天	366 天	一般延遲 4 小時，不超過 24 小時

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:DescribeVodDomainReqHitRateData

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DomainName	string	否	要查詢的加速網域名稱。不傳入該參數，則預設返回所有加速網域名稱的合并資料。支援批量查詢，多個網域名稱之間用半形逗號（,）分隔，一次最多支援 500 個網域名稱查詢。您可以登入ApsaraVideo for VOD控制台，從左側導航選擇組態管理 > 分發加速配置 > 網域名稱管理，查看您已接入到ApsaraVideo for VOD的加速網域名稱，或者調用 DescribeVodUserDomains 介面查詢加速網域名稱列表。	example.com
StartTime	string	否	擷取資料起始時間點。日期格式按照 ISO8601 標記法，並使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2023-12-21T08:00:00Z
EndTime	string	否	擷取資料的結束時間點。日期格式按照 ISO8601 標記法，並使用 UTC 時間，格式為：yyyy-MM-ddTHH:mm:ssZ。說明結束時間需大於起始時間。	2023-12-22T08:00:00Z
Interval	string	否	設定查詢資料的時間粒紋。單位：秒。取值：300、3600 和 86400。不傳和傳的值不支援時，使用預設值。根據您指定的`StartTime`和`EndTime`的時間跨度，支援設定的時間粒紋如下： 3 天以內（不包含 3 天整）支援：300（預設）、3600、86400。 3-31 天（不包含 31 天整）支援：3600（預設）和 86400。 31 天以上支援：86400（預設）。	300

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
EndTime	string	資料的結束時間點。	2023-12-22T08:00:00Z
RequestId	string	請求 ID。	D94E471F-1A27-442E-552D-D4D2000C****
Data	object
DataModule	array<object>	每個時間間隔的請求命中率資料列表。
	object
Value	string	總請求命中率。	100
TimeStamp	string	資料時間戳記。日期格式按照 ISO8601 標記法，並使用 UTC 時間。	2023-12-21T08:00:00Z
HttpsValue	string	HTTPS 請求命中率。	50
StartTime	string	資料的起始時間點。	2023-12-21T08:00:00Z
DomainName	string	加速網域名稱。	example.com
DataInterval	string	每條資料的時間間隔，即資料的時間粒紋。單位：秒。	300

樣本

正常返回樣本

JSON格式

{
  "EndTime": "2023-12-22T08:00:00Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "Data": {
    "DataModule": [
      {
        "Value": "100",
        "TimeStamp": "2023-12-21T08:00:00Z",
        "HttpsValue": "50"
      }
    ]
  },
  "StartTime": "2023-12-21T08:00:00Z",
  "DomainName": "example.com",
  "DataInterval": "300"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidTime.ValueNotSupported	StartTime or EndTime is miss match.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。