DescribeDcdnDomainHitRateData - API Reference| Alibaba Cloud Documentation Center

Before you call this operation, pay attention to the following considerations:

If you do not specify the StartTime and EndTime parameters, the data within the last 24 hours is queried by default. If you specify the StartTime and EndTime parameters, the data within the specified time range is queried.
You can specify multiple domain names and separate them with commas (,).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDcdnDomainHitRateData	The operation that you want to perform. Set the value to DescribeDcdnDomainHitRateData.
DomainName	String	No	example.com	The name of the accelerated domain. You can specify only one domain name. By default, all the accelerated domains are queried.
StartTime	String	No	2018-03-02T12:00:00Z	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
EndTime	String	No	2018-03-02T15:00:00Z	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time.
Interval	String	No	300	The data collection interval. Unit: second. The value varies based on the values of the StartTime and EndTime parameters. Valid values: If the time span between StartTime and EndTime is less than 3 days, valid values are 300, 3600, and 86400. Default value: 300. If the time span between StartTime and EndTime is from 3 days to 30 days, valid values are 3600 and 86400. Default value: 3600. If the time span between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.

Response parameters


Parameter	Type	Example	Description
DataInterval	String	3600	The data collection interval. Unit: second.
DomainName	String	example.com	The name of the accelerated domain for which the data was returned.
EndTime	String	2018-03-02T15:00:00Z	The end of the time range during which the data was collected.
HitRatePerInterval	Array		The cache hit ratio at each specified interval.
DataModule
ByteHitRate	Float	0	The byte hit ratio during each interval.
ReqHitRate	Float	0	The request hit ratio.
TimeStamp	String	2018-03-02T13:00:00Z	The timestamp of the data returned.
RequestId	String	4D07ABFE-4737-4834-B1B9-A661308C47B4	The ID of the request.
StartTime	String	2018-03-02T12:00:00Z	The beginning of the time range during which the data was collected.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=DescribeDcdnDomainHitRateData
&DomainName=example.com
&StartTime=2018-03-02T12:00:00Z
&EndTime=2018-03-02T15:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnDomainHitRateDataResponse>
      <DomainName>test.com</DomainName>
      <DataInterval>3600</DataInterval>
      <HitRatePerInterval>
            <DataModule>
                  <ByteHitRate>0</ByteHitRate>
                  <TimeStamp>2018-03-02T15:00:00Z</TimeStamp>
                  <ReqHitRate>0</ReqHitRate>
            </DataModule>
            <DataModule>
                  <ByteHitRate>0</ByteHitRate>
                  <TimeStamp>2018-03-02T14:00:00Z</TimeStamp>
                  <ReqHitRate>0</ReqHitRate>
            </DataModule>
            <DataModule>
                  <ByteHitRate>0</ByteHitRate>
                  <TimeStamp>2018-03-02T13:00:00Z</TimeStamp>
                  <ReqHitRate>0</ReqHitRate>
            </DataModule>
            <DataModule>
                  <ByteHitRate>0</ByteHitRate>
                  <TimeStamp>2018-03-02T12:00:00Z</TimeStamp>
                  <ReqHitRate>0</ReqHitRate>
            </DataModule>
      </HitRatePerInterval>
      <RequestId>4D07ABFE-4737-4834-B1B9-A661308C47B4</RequestId>
      <EndTime>2018-03-02T15:00:00Z</EndTime>
      <StartTime>2018-03-02T12:00:00Z</StartTime>
</DescribeDcdnDomainHitRateDataResponse>

JSON format

{
    "DomainName": "test.com",
    "DataInterval": 3600,
    "HitRatePerInterval": {
        "DataModule": [
            {
                "ByteHitRate": 0,
                "TimeStamp": "2018-03-02T15:00:00Z",
                "ReqHitRate": 0
            },
            {
                "ByteHitRate": 0,
                "TimeStamp": "2018-03-02T14:00:00Z",
                "ReqHitRate": 0
            },
            {
                "ByteHitRate": 0,
                "TimeStamp": "2018-03-02T13:00:00Z",
                "ReqHitRate": 0
            },
            {
                "ByteHitRate": 0,
                "TimeStamp": "2018-03-02T12:00:00Z",
                "ReqHitRate": 0
            }
        ]
    },
    "RequestId": "4D07ABFE-4737-4834-B1B9-A661308C47B4",
    "EndTime": "2018-03-02T15:00:00Z",
    "StartTime": "2018-03-02T12:00:00Z"
}

Error codes


HttpCode	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	The error message returned because the StartTime and EndTime parameters must be specified together.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The error message returned because the format of the specified EndTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The error message returned because the end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The error message returned because the specified start time is invalid.

For a list of error codes, visit the API Error Center.