DescribeDcdnDomainIpaConnData - Edge Security Acceleration

Queries the number of IPA user connections.

Operation description

You can call this operation up to 10 times per second per user.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.
The minimum time granularity at which the data is queried is 5 minutes. The maximum time range for a single query is 31 days. The period within which historical data is available is 366 days. The data latency is no more than 10 minutes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The domain names accelerated by IPA. Separate multiple domain names with commas (,). Note If you do not specify this parameter, the merged data of all accelerated domain names is returned.	example1.com
StartTime	string	No	The start 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.	2015-02-21T07: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.	2015-02-22T7:00:00Z
SplitBy	string	No	Specifies how query results are grouped. By default, this parameter is empty. Valid values: domain: Query results are grouped by accelerated domain name. An empty string: Query results are not grouped.	domain

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2015-02-22T15:00:00Z
StartTime	string	The beginning of the time range during which data was queried.	2015-02-21T15:00:00Z
RequestId	string	The request ID.	A2A1EEF8-043E-43A1-807C-BEAC18EA1807
ConnectionDataPerInterval	array<object>	The number of user connections at each time interval.
DataModule	object
TimeStamp	string	The timestamp of the data returned.	2022-02-21T15:00:00+08:00
Domain	string	The accelerated domain name.	example1.com
Connections	long	The number of IPA user connections.	189095

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-02-22T15:00:00Z",
  "StartTime": "2015-02-21T15:00:00Z",
  "RequestId": "A2A1EEF8-043E-43A1-807C-BEAC18EA1807",
  "ConnectionDataPerInterval": {
    "DataModule": [
      {
        "TimeStamp": "2022-02-21T15:00:00+08:00",
        "Domain": "example1.com",
        "Connections": 189095
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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	InvalidTimeRange	The time span between the StartTime and the EndTime cannot exceed 31 days.	The different between the end time (EndTime) and start time (StartTime) cannot exceed 31 days.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

For a list of error codes, visit the Service error codes.