DescribeDcdnDomainWebsocketHttpCodeData - Edge Security Acceleration

The total number and proportions of HTTP status codes returned from one or more accelerated domain names for which WebSocket is enabled are queried. Data can be collected at minimum intervals of 5 minutes.

Operation description

You can call this operation up to 100 times per second per account.

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 time range to 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	Yes	The accelerated domain name. You can specify multiple accelerated domain names and separate them with commas (,).	example.com
StartTime	string	No	The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-03-01T05:00:00Z
EndTime	string	No	The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note The end time must be later than the start time.	2018-03-01T06:00:00Z
Interval	string	No	The time granularity for a query. 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 ISPs.	unicom
LocationNameEn	string	No	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query regions.	beijing

Response parameters

Parameter	Type	Description	Example
	object	The description of the parameter.
EndTime	string	The end of the time range during which data was queried.	2018-03-01T13:00:00Z
StartTime	string	The start of the time range during which data was queried.	2018-03-01T05:00:00Z
RequestId	string	The ID of the request.	91FC2D9D-B042-4634-8A5C-7B8E7482C22D
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	3600
HttpCodeDataPerInterval	array<object>	The HTTP status code.
DataModule	object	The HTTP status code.
TimeStamp	string	The timestamp of the returned data.	2018-03-01T13:00:00Z
WebsocketHttpCode	array<object>	The proportions of the HTTP status codes.
HttpCodeDataModule	object	The information about the HTTP status codes.
Code	integer	The HTTP status code returned.	404
Proportion	float	The proportion of the HTTP status code.	100
Count	float	The total number of entries returned.	16

Examples

Sample success responses

JSONformat

{
  "EndTime": "2018-03-01T13:00:00Z",
  "StartTime": "2018-03-01T05:00:00Z",
  "RequestId": "91FC2D9D-B042-4634-8A5C-7B8E7482C22D",
  "DomainName": "example.com",
  "DataInterval": "3600",
  "HttpCodeDataPerInterval": {
    "DataModule": [
      {
        "TimeStamp": "2018-03-01T13:00:00Z",
        "WebsocketHttpCode": {
          "HttpCodeDataModule": [
            {
              "Code": 404,
              "Proportion": 100,
              "Count": 16
            }
          ]
        }
      }
    ]
  }
}

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.

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