DescribeDcdnDomainHttpCodeDataByLayer - Edge Security Acceleration

Queries HTTP status codes by protocol.

Operation description

You can call this operation up to 20 times per second per account.
You cannot query the distribution of HTTP status codes by IP protocol.
If you do not specify the StartTime or EndTime parameter, the data that is collected within the last 24 hours is collected. If you specify both the StartTime and EndTime parameters, the data that is collected within the time range that you specify is collected.

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 granularity	Maximum time range per query	Historical data available	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	366 days	366 days	04:00 on the next day

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify multiple domain names and separate them with commas (,). You can specify up to 500 domain names in each request. The query results of multiple domain names are aggregated. If you do not specify this parameter, data of all accelerated domain names under your account is queried.	example.com
StartTime	string	No	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 needs to be in UTC. The minimum data granularity is 5 minutes. If you do not set this parameter, data in the last 24 hours is queried.	2015-12-10T20:00:00Z
EndTime	string	No	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 needs to be in UTC. Note The end time needs to be later than the start time.	2015-12-10T21:00:00Z
Interval	string	No	The time interval between 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
IspNameEn	string	No	The name of the Internet service provider (ISP). You can call the DescribeDcdnRegionAndIsp operation to query the ISP name. If you do not specify a value for this parameter, all ISPs are queried.	telecom
LocationNameEn	string	No	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query the region name. If you do not specify a value for this parameter, all regions are queried.	hangzhou
Layer	string	No	The layer at which you want to query the bandwidth data. 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

Parameter	Type	Description	Example
	object
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
RequestId	string	The ID of the request.	BEA5625F-8FCF-48F4-851B-CA63946DA664
HttpCodeDataInterval	array<object>	The distribution of HTTP status codes at each time interval.
DataModule	object
Value	object	The number of times that the HTTP status code was returned.	{"200": 10,"206": 100}
TimeStamp	string	The timestamp of the returned data.	2015-12-10T21:00:00Z
TotalValue	string	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-10T21:00:00Z",
        "TotalValue": "110"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time 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.Malformed	The specified EndTime is invalid.	The format of the specified end time 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 end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

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