All Products
Search
Document Center

CDN:DescribeDomainSrcHttpCodeData

Last Updated:Aug 06, 2024

Queries the proportions of HTTP status codes that are returned during back-to-origin routing.

Operation description

  • You can call this operation up to 100 times per second per account.
  • 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 these parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days366 days04:00 on the next day

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeDomainSrcHttpCodeDatanone
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,).

example.com,example.org
StartTimestringNo

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.

2019-11-30T05:33:00Z
EndTimestringNo

The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in the ISO 8601 standard. The time is displayed in UTC.

Note The end time must be later than the start time.
2019-11-30T05:40:00Z
IntervalstringNo

The time interval between the data entries to return. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Description.

300

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2015-11-30T05:40:00Z
StartTimestring

The start of the time range during which data was queried.

2015-11-30T05:33:00Z
RequestIdstring

The ID of the request.

BC858082-736F-4A25-867B-E5B67C85ACF7
DomainNamestring

The accelerated domain name.

example.com,example.org
DataIntervalstring

The time interval between the data entries returned. Unit: seconds.

300
HttpCodeDataarray<object>

The proportions of HTTP status codes at each time interval.

object
TimeStampstring

The timestamp of the returned data.

2015-11-30T05:30:00Z
Valuearray<object>

The proportions of the HTTP status codes.

object
Codestring

The HTTP status code returned.

200
Proportionstring

The proportion of the HTTP status code.

67.1458998935037
Countstring

The total number of entries.

2300

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-11-30T05:40:00Z",
  "StartTime": "2015-11-30T05:33:00Z",
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7",
  "DomainName": "example.com,example.org",
  "DataInterval": "300",
  "HttpCodeData": {
    "UsageData": [
      {
        "TimeStamp": "2015-11-30T05:30:00Z",
        "Value": {
          "CodeProportionData": [
            {
              "Code": "200",
              "Proportion": "67.1458998935037",
              "Count": "2300"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.The specified start time is invalid. For more information, see the help documentation of this operation.
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.The specified EndTime parameter is invalid.
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.

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

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedView Change Details