DescribeDcdnDomainWebsocketHttpCodeData - API Reference| Alibaba Cloud Documentation Center

Description

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

Time granularity

The time granularity supported by the Interval parameter varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.


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

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	DescribeDcdnDomainWebsocketHttpCodeData	The operation that you want to perform. Set the value to DescribeDcdnDomainWebsocketHttpCodeData.
DomainName	String	Yes	example.com	The accelerated domain name. Separate multiple accelerated domain names with commas (,).
StartTime	String	No	2018-03-01T05: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-01T06: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. Note The end time must be later than the start time.
Interval	String	No	300	The time interval between the data entries to return. 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 Description.
IspNameEn	String	No	unicom	The name of the Internet service provider (ISP). You can call the DescribeDcdnRegionAndIsp operation to query ISPs.
LocationNameEn	String	No	beijing	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query regions.

Response parameters


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

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainWebsocketHttpCodeData
&DomainName=example.com
&StartTime=2018-03-01T05:00:00Z
&EndTime=2018-03-01T06:00:00Z
&Interval=300
&IspNameEn=unicom
&LocationNameEn=beijing
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnDomainWebsocketHttpCodeDataResponse>
	<DataInterval>3600</DataInterval>
	<RequestId>91FC2D9D-B042-4634-8A5C-7B8E7482C22D</RequestId>
	<EndTime>2018-03-01T13:00:00Z</EndTime>
	<StartTime>2018-03-01T05:00:00Z</StartTime>
	<HttpCodeDataPerInterval>
		<DataModule>
			<TimeStamp>2018-03-01T13:00:00Z</TimeStamp>
			<WebsocketHttpCode></WebsocketHttpCode>
		</DataModule>
		<DataModule>
			<TimeStamp>2018-03-01T12:00:00Z</TimeStamp>
			<WebsocketHttpCode>
				<HttpCodeDataModule>
					<Count>16</Count>
					<Proportion>100</Proportion>
					<Code>404</Code>
				</HttpCodeDataModule>
			</WebsocketHttpCode>
		</DataModule>
		<DataModule>
			<TimeStamp>2018-03-01T11:00:00Z</TimeStamp>
			<WebsocketHttpCode>
				<HttpCodeDataModule>
					<Count>9</Count>
					<Proportion>50</Proportion>
					<Code>403</Code>
				</HttpCodeDataModule>
				<HttpCodeDataModule>
					<Count>9</Count>
					<Proportion>50</Proportion>
					<Code>504</Code>
				</HttpCodeDataModule>
			</WebsocketHttpCode>
		</DataModule>
	</HttpCodeDataPerInterval>
</DescribeDcdnDomainWebsocketHttpCodeDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DataInterval" : 3600,
  "RequestId" : "91FC2D9D-B042-4634-8A5C-7B8E7482C22D",
  "EndTime" : "2018-03-01T13:00:00Z",
  "StartTime" : "2018-03-01T05:00:00Z",
  "HttpCodeDataPerInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2018-03-01T13:00:00Z",
      "WebsocketHttpCode" : {
        "HttpCodeDataModule" : [ ]
      }
    }, {
      "TimeStamp" : "2018-03-01T12:00:00Z",
      "WebsocketHttpCode" : {
        "HttpCodeDataModule" : [ {
          "Count" : 16,
          "Proportion" : 100,
          "Code" : 404
        } ]
      }
    }, {
      "TimeStamp" : "2018-03-01T11:00:00Z",
      "WebsocketHttpCode" : {
        "HttpCodeDataModule" : [ {
          "Count" : 9,
          "Proportion" : 50,
          "Code" : 403
        }, {
          "Count" : 9,
          "Proportion" : 50,
          "Code" : 504
        } ]
      }
    } ]
  }
}

Error codes


HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	The error message returned because no value is specified for the StartTime or EndTime parameter.

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