获取加速域名的字节命中率_数据监控类接口_新版API参考_CDN

调用该接口前，请您注意：

如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，返回起止时间的数据。
您可以查询批量域名的数据，多个域名用英文逗号（,）分隔。
单用户调用频率：100次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	否	DescribeDomainHitRateData	操作接口名，系统规定参数。取值：DescribeDomainHitRateData。
DomainName	String	否	www.yourdomain.com	加速域名，多个域名用英文逗号（,）分隔。默认查询所有加速域名。
StartTime	String	否	2019-12-30T08:00:00Z	获取数据起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	否	2019-12-30T08:10:00Z	获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。结束时间需大于起始时间。
Interval	String	否	300	查询数据的时间粒度，单位：秒。根据您指定StartTime和EndTime两者的时间跨度，该参数取值如下： 3天以内（不包含3天整）支持300、3600、 86400，如果不传该参数，默认值为300。 3-31天（不包含31天整）支持3600和86400，如果不传该参数，默认值为3600。 31天及以上支持86400，如果不传该参数，默认值为86400。

返回数据


名称	类型	示例值	描述
DomainName	String	test.com	加速域名信息。
DataInterval	String	300	每条记录的时间间隔，以秒为单位。
StartTime	String	2019-12-30T08:00:00Z	开始时间。
EndTime	String	2019-12-30T08:10:00Z	结束时间。
HitRateInterval	Array of DataModule		每个时间间隔的字节命中百分占比。
DataModule
TimeStamp	String	2019-12-30T08:00:00Z	时间片起始时刻。
Value	String	100.0	详细使用数据。
HttpsValue	String	50.0	Https字节命中率。
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	请求ID。

示例

请求示例

http://cdn.aliyuncs.com?Action=DescribeDomainHitRateData
&DomainName=test.com
&StartTime=2019-12-30T08:00:00Z
&EndTime=2019-12-30T08:10:00Z
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDomainHitRateDataResponse>
  <DomainName>test.com</DomainName>
  <DataInterval>300</DataInterval>
  <RequestId>0A521165-99B6-41EF-B166-5B8B8068E1CF</RequestId>
  <EndTime>2019-12-30T08:10:00Z</EndTime>
  <StartTime>2019-12-30T08:00:00Z</StartTime>
  <HitRateInterval>
        <DataModule>
              <TimeStamp>2019-12-30T08:00:00Z</TimeStamp>
              <Value>74.82824427480917</Value>
              <HttpsValue>0</HttpsValue>
        </DataModule>
        <DataModule>
              <TimeStamp>2019-12-30T08:05:00Z</TimeStamp>
              <Value>62.83283497081019</Value>
              <HttpsValue>100</HttpsValue>
        </DataModule>
  </HitRateInterval>
</DescribeDomainHitRateDataResponse>

JSON 格式

{    
    "DomainName":"test.com",
	"DataInterval": 300,
	"RequestId": "0A521165-99B6-41EF-B166-5B8B8068E1CF",
	"EndTime": "2019-12-30T08:10:00Z",
	"StartTime": "2019-12-30T08:00:00Z",
	"HitRateInterval": {
		"DataModule": [
			{
				"TimeStamp": "2019-12-30T08:00:00Z",
				"Value": "74.82824427480917",
				"HttpsValue": 0
			},
			{
				"TimeStamp": "2019-12-30T08:05:00Z",
				"Value": "62.83283497081019",
				"HttpsValue": 100
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。