DescribeDcdnDomainWebsocketTrafficData - Edge Security Acceleration

Operation description

You can call this operation up to 100 times per second per account.
If you do not specify the StartTime and EndTime parameters, data for the last 24 hours is returned. If you specify both the StartTime and EndTime parameters, data for the specified time range is returned.

Supported time granularities

The supported time granularity for a query depends on the maximum time range that you can specify. The queryable historical data range and data latency also vary. The following table provides more details.

Time granularity	Maximum time range per query	Queryable historical data range	Data latency
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Typically 3 to 4 hours
1 day	366 days	366 days	Typically 4 hours, not exceeding 24 hours

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:DescribeDcdnDomainWebsocketTrafficData

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. To query data for multiple domain names, separate them with commas (,). By default, this operation queries data for all accelerated domain names.	example.com
StartTime	string	No	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.	2017-12-10T20:00:00Z
EndTime	string	No	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.	2017-12-10T21:00:00Z
Interval	string	No	The time granularity for the query, in seconds. Valid values are 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). The supported time granularity varies based on the maximum time range per query. For more information, see the Supported time granularities section in this topic.	300
IspNameEn	string	No	The name of the carrier in English. You can call the DescribeDcdnRegionAndIsp operation to obtain the name. By default, data for all carriers is queried.	unicom
LocationNameEn	string	No	The name of the region in English. You can call the DescribeDcdnRegionAndIsp operation to obtain the name. By default, data for all regions is queried.	beijing

Response elements

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range.	2017-12-10T21:00:00Z
StartTime	string	The start of the time range.	2017-12-10T20:00:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between data records, in seconds.	300
TrafficDataPerInterval	object
DataModule	array<object>	The traffic data at each time interval. Unit: byte.
	object
WebsocketTraffic	number	The total traffic.	423304182
TimeStamp	string	The start of the time slice.	2017-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "WebsocketTraffic": 423304182,
        "TimeStamp": "2017-12-10T20:00:00Z"
      }
    ]
  }
}

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.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time 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 format of the specified end time 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 end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.