All Products
Search
Document Center

CDN:DescribeDomainHttpCodeDataByLayer

Last Updated:Jul 05, 2024

Queries HTTP status codes by protocol.

Operation description

  • You can call this operation up to 20 times per second per account.
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both these parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days366 days04:00 on the next day

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,).

If you do not specify this parameter, data of all accelerated domain names under your account is queried.

example.com
StartTimestringNo

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.

2020-07-05T22:00:00Z
EndTimestringNo

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.

Note The end time must be later than the start time.
2020-07-06T22:00:00Z
IntervalstringNo

The time granularity of the data entries. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

300
IspNameEnstringNo

The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISP names.

If you do not specify an ISP, data of all ISPs is queried.

telecom
LocationNameEnstringNo

The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions.

If you do not specify a region, data in all regions is queried.

hangzhou
LayerstringNo

The protocol by which you want to query HTTP status codes. The network layer supports IPv4 and IPv6. The application layer supports http, https, and quic. You can also set the value to all.

Default value: all

all

Response parameters

ParameterTypeDescriptionExample
object
DataIntervalstring

The time interval between the data entries returned. Unit: seconds.

300
RequestIdstring

The ID of the request.

BEA5625F-8FCF-48F4-851B-CA63946DA664
HttpCodeDataIntervalarray<object>

The statistics of HTTP status codes returned at each time interval.

object
Valuestring

The number of times that the HTTP status code was returned.

{ "200": 10, "206": 100}
TimeStampstring

The timestamp of the data returned.

2015-12-10T20:35:00Z
TotalValuestring

The total number of times that HTTP status codes were returned.

110

Examples

Sample success responses

JSONformat

{
  "DataInterval": "300",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "HttpCodeDataInterval": {
    "DataModule": [
      {
        "Value": "{ \"200\": 10, \"206\": 100}",
        "TimeStamp": "2015-12-10T20:35:00Z",
        "TotalValue": "110"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.The specified start time is invalid. For more information, see the help documentation of this operation.
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.The specified EndTime parameter is invalid.
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedView Change Details