DescribeStatusCode

1. API Description

This API (DescribeStatusCode) is used to query CDN status codes.

Preparation

2. Request Parameters

The following table lists the required request parameters for the API:

Parameter NameRequiredTypeDescription

startTime

Yes

String

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.

endTime

Yes

String

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.

domain

No

String

domain, use commas(,) to separate multiple domain names. By default, all acceleration domains will be queried.

continent

No

String

Continent

country

No

String

Country/Region

group

No

String

3. Output Parameterss

Parameter NameTypeDescription

dataSet

Collection of status codes.

requestId

String

Unique request ID, which is returned with every request. This request ID is needed to locate issues.

4. Code Example

  1. Query CDN Status Codes.

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-TC-Action: DescribeStatusCode
<Common Request Params>

Request:
{
    "startTime": "2024-08-22T00:00:00Z",
    "endTime": "2024-08-22T00:02:00Z"
}

Response:
{
  "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
  "response": {
    "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
    "dataSet": [{
      "data": [{
        "detail": [{
          "code": "200",
          "count": 286
        }, {
          "code": "404",
          "count": 1
        }],
        "time": "2024-08-22T00:00:00Z"
      }],
      "domain": "*"
    }]
  }
}

5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see Common Error Codes.

Last updated