Queries the total number and proportions of the returned HTTP status codes for accelerated domain names that have WebSocket enabled. Data is collected at intervals of at least 5 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 software development kits (SDKs).

Request parameters

Parameter Type Required Example Description
Action String No DescribeDcdnDomainWebsocketHttpCodeData

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

DomainName String Yes example.com

The accelerated domain names. 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 unit of time in which data is collected: seconds.

The value varies based on the values of the StartTime and EndTime parameters. Valid values:

  • If the time range between StartTime and EndTime is less than 3 days, valid values are 300, 3600, and 86400. Default value: 300.
  • If the time range between StartTime and EndTime is from 3 to 31 days (31 days excluded), valid values are 3600 and 86400. Default value: 3600.
  • If the time range between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.
IspNameEn String No unicom

The name of the Internet service provider (ISP).

If you do not set this parameter, all ISPs are queried. You can call the DescribeDcdnRegionAndIsp operation to query ISP names.

LocationNameEn String No beijing

The name of the region.

If you do not set this parameter, all regions are queried. You can call the DescribeDcdnRegionAndIsp operation to query region names.

Response parameters

Parameter Type Example Description
DataInterval String 3600

The interval at which data is collected. Unit: seconds.

DataPerInterval Array of DataModule

The proportions of HTTP status codes at each interval.

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

The timestamp of the data entry.

WebsocketHttpCodeDataPerInterval Array of HttpCodeDataModule

The proportions of each HTTP status code type.

HttpCodeDataModule
Code Integer 404

The HTTP status code.

Count Float 16

The total number of HTTP status codes returned.

Proportion Float 100

The proportion of the HTTP status code returned.

DomainName String example.com

The information about the accelerated domain name.

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

The end time.

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

The ID of the request.

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

The start time.

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainWebsocketHttpCodeData
&DomainName=example.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

HttpCode 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 set.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The error message returned because the format of the specified end time is invalid. Specify the time in the ISO 8601 standard in 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 end time is earlier than the start time.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the specified start time is not supported. Specify a valid value.

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