DescribeDcdnDomainWebsocketHttpCodeData-阿里云帮助中心

Queries the total count and proportions of HTTP status codes for the WebSocket protocol of a domain name.

Operation description

Invoke frequency per user: 100 times per second.

Supported time granularities

Based on the maximum time span of a single query, the request parameter Interval supports different data timestamp granularities. The corresponding time range of queryable historical data and data delay are as follows:

Time granularity	Maximum time span per query	Queryable historical data range	Data delay
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. Separate multiple domain names with commas (,).	example.com
StartTime	string	No	The start time of the data to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2018-03-01T05:00:00Z
EndTime	string	No	The end time of the data 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.	2018-03-01T06:00:00Z
Interval	string	No	The time granularity of the data to query. Unit: seconds. This parameter supports the values 300 (5 minutes), 3600 (1 hour), and 86400 (1 day) based on the maximum time span of a single query. For more information, see the supported time granularities in Usage notes.	300
IspNameEn	string	No	The English name of the Internet service provider (ISP). You can call the DescribeDcdnRegionAndIsp operation to query ISPs. By default, all ISPs are queried.	unicom
LocationNameEn	string	No	The English name of the region. You can call the DescribeDcdnRegionAndIsp operation to query regions. By default, all regions are queried.	beijing

Response elements

Element	Type	Description	Example
	object	The parameter descriptions.
EndTime	string	The end time. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2018-03-01T13:00:00Z
StartTime	string	The start time. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2018-03-01T05:00:00Z
RequestId	string	The request ID.	91FC2D9D-B042-4634-8A5C-7B8E7482C22D
DomainName	string	The information about the accelerated domain name.	example.com
DataInterval	string	The time interval of each record. Unit: seconds.	3600
HttpCodeDataPerInterval	object
DataModule	array<object>	The HTTP status codes.
	array<object>	The HTTP status codes.
TimeStamp	string	The start time of the time interval. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2018-03-01T13:00:00Z
WebsocketHttpCode	object
HttpCodeDataModule	array<object>	The list of proportions and usage data for each HTTP status code.
	object	The proportions and usage data for each HTTP status code.
Code	integer	The HTTP status code.	404
Proportion	number	The proportion.	100
Count	number	The total count.	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.