You can call this operation to query the total number and proportions of the returned HTTP status codes for accelerated domains that have WebSocket enabled. The minimum data granularity is five minutes.

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
DomainName String Yes example.com

The name of the accelerated domain. You can separate multiple accelerated domain names with commas (,).

Action String No DescribeDcdnDomainWebsocketHttpCodeData

The operation that you want to perform. Set the value to DescribeDcdnDomainWebsocketHttpCodeData.

EndTime String No 2018-03-01T06:00:00Z

The end of the time range to query.

  • The end time must be later than the start time.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
Interval String No 300

The data sampling interval. Unit: seconds. The value varies based on the values specified in the StartTime and EndTime parameters. If you do not specify this parameter or the specified value is invalid, the default value is used. Valid values:

  • Less than 3 days: 300, 3600, and 86400. Default value: 300.
  • 3 to 31 days (excluding 31 days): 3600 and 86400. Default value: 3600.
  • No less than 31 days: 86400. Default value: 86400.
IspNameEn String No unicom

The name of the ISP. You can call the DescribeCdnRegionAndIsp operation to query providers. If you do not specify this parameter, all providers are queried.

LocationNameEn String No beijing

The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not specify this parameter, all regions are queried.

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.
  • The data granularity is five minutes.
  • If you do not specify this parameter, the data within the last 24 hours is queried.

Response parameters

Parameter Type Example Description
DataInterval String 3600

The data sampling interval. Unit: seconds.

DataPerInterval Array

The proportions of HTTP status codes at each data sampling interval.

DataModule

The proportions of HTTP status codes at each data sampling interval.

TimeStamp String 2018-03-01T11:00:00

The timestamp of the data returned.

WebsocketHttpCodeDataPerInterval Array

The proportions of HTTP status codes.

HttpCodeDataModule

The proportions of HTTP status codes.

Code Integer 9

The HTTP status code.

Count Float 50

The total number of the HTTP status codes returned.

Proportion Float 43

The proportion of the HTTP status code returned.

DomainName String example.com

The name of the accelerated domain returned.

EndTime String 2018-03-01T13:00:00Z

The end of the time range during which the data was queried.

RequestId String 91FC2D9D-B042-4634-8A5C-7B8E7482C22D

The ID of the request.

StartTime String 2018-03-01T05:00:00Z

The beginning of the time range during which the data was queried.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=DescribeDcdnDomainWebsocketHttpCodeData
&DomainName="example.com,example1.com"
&StartTime=2018-03-01T05:00:00Z
&EndTime=2018-03-01T13:00:00Z
&<Common request parameters>

Sample success responses

XML format

<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

{
	"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 the StartTime and EndTime parameters must be specified together.
400 InvalidStartTime.Malformed The specified StartTime is invalid. The error message returned because the specified StartTime 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.Malformed The specified EndTime is invalid. The error message returned because 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 specified EndTime parameter is earlier than the specified StartTime parameter.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the specified start time is not supported.

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