DescribeDomainStatusCodeList - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the statistics on HTTP status codes of a website.

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

yundun-ddoscoo:DescribeDomainStatusCodeList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group. For more information, see Create a resource group.	default
StartTime	integer	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1582992000
EndTime	integer	No	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1583683200
Interval	integer	Yes	The interval for returning statistics. Unit: seconds.	1000
Domain	string	No	The domain name of the website. Note You can call DescribeDomains to query all domain names of websites that are protected by Anti-DDoS Pro or Anti-DDoS Premium.	www.aliyun.com
QueryType	string	Yes	The source of the statistics. Valid values: gf: Anti-DDoS Pro or Anti-DDoS Premium response data. upstream: origin server response data.	gf

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	3B63C0DD-8AC5-44B2-95D6-064CA9296B9C
StatusCodeList	array	The statistics on response status codes.
	object
Index	integer	The index number of the returned data.	0
Status502	integer	The statistics value of the 502 status code.	0
Time	integer	The time when the data was collected. The value is a timestamp. Unit: seconds.	1582992000
Status405	integer	The statistics value of the 405 status code.	0
Status3XX	integer	The statistics value of the 3XX status codes.	0
Status503	integer	The statistics value of the 503 status code.	0
Status4XX	integer	The statistics value of the 4XX status codes.	4486
Status2XX	integer	The statistics value of the 2XX status codes.	15520
Status5XX	integer	The statistics value of the 5XX status codes.	0
Status504	integer	The statistics value of the 504 status code.	0
Status200	integer	The statistics value of the 200 status code.	15520
Status403	integer	The statistics value of the 403 status code.	0
Status404	integer	The statistics value of the 404 status code.	0
Status410	integer	The statistics value of the 410 status code.	0
Status499	integer	The statistics value of the 499 status code.	0
Status501	integer	The statistics value of the 501 status code.	0

Examples

Success response

JSON format

{
  "RequestId": "3B63C0DD-8AC5-44B2-95D6-064CA9296B9C",
  "StatusCodeList": [
    {
      "Index": 0,
      "Status502": 0,
      "Time": 1582992000,
      "Status405": 0,
      "Status3XX": 0,
      "Status503": 0,
      "Status4XX": 4486,
      "Status2XX": 15520,
      "Status5XX": 0,
      "Status504": 0,
      "Status200": 15520,
      "Status403": 0,
      "Status404": 0,
      "Status410": 0,
      "Status499": 0,
      "Status501": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.