DescribeDcdnDomainWebsocketHttpCodeData - Edge Security Acceleration

You can call the DescribeDcdnDomainWebsocketHttpCodeData operation to query the total number and proportions of HTTP return codes for the WebSocket protocol for one or more domain names.

Operation description

The call frequency for a single user is limited to 100 calls per second.

Supported query time granularity

The time granularity that you can specify for the Interval parameter depends on the maximum time span of a single query. The following table describes the supported time granularities, the queryable time range for historical data, and the data latency.

Time granularity	Maximum time span per query	Queryable historical data range	Data latency
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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnDomainWebsocketHttpCodeData

get

*Domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify multiple domain names. Separate them with commas (,).	example.com
StartTime	string	No	The beginning of the time range to query. The date is in the ISO 8601 standard. Use Coordinated Universal Time (UTC) in the yyyy-MM-ddTHH:mm:ssZ format.	2018-03-01T05:00:00Z
EndTime	string	No	The end of the time range to query. The date is in the ISO 8601 standard. Use UTC in the yyyy-MM-ddTHH:mm:ssZ format. Note The end time must be later than the start time.	2018-03-01T06:00:00Z
Interval	string	No	The time granularity of the data to query. Unit: seconds. The value of this parameter varies based on the time range specified by the StartTime and EndTime parameters. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see the table in the Limits section.	300
IspNameEn	string	No	The English name of the carrier. You can call the DescribeDcdnRegionAndIsp operation to query the English name. If you do not set this parameter, data for all carriers is queried.	unicom
LocationNameEn	string	No	The English name of the region. You can call the DescribeDcdnRegionAndIsp operation to query the English name. If you do not set this parameter, data for all regions is queried.	beijing

Response elements

Parameter	Type	Description	Example
	object	The response parameters.
EndTime	string	The end of the time range.	2018-03-01T13:00:00Z
StartTime	string	The beginning of the time range.	2018-03-01T05:00:00Z
RequestId	string	The request ID.	91FC2D9D-B042-4634-8A5C-7B8E7482C22D
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between data entries. Unit: seconds.	3600
HttpCodeDataPerInterval	object
DataModule	array<object>	A list of data entries, each corresponding to a time interval.
	object	The data for a time interval.
TimeStamp	string	The timestamp of the data.	2018-03-01T13:00:00Z
WebsocketHttpCode	object
HttpCodeDataModule	array<object>	A list of proportions for each return code.
	object	The details of the proportions for each return code.
Code	integer	The HTTP return code.	404
Proportion	number	The percentage of requests that correspond to the HTTP status code.	100
Count	number	The total number of times the return code was returned.	16

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.