# DescribeOriginTraffic

## 1. API Description

This interface (DescribeOriginTraffic) is used to query CDN origin traffic, data aggregation internval is 5 minutes.

## 2. Request Parameters

The following request parameter list includes only those required by the interface:

| Parameter Name | Required | Type   | Description                                                                                                                                                                                                                         |
| -------------- | -------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. For example, 2024-08-22T00:00:00Z.                                                 |
| 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. For example, 2024-08-22T00:10:00Z. 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.                                                                                                                      |

## 3. Output Parameters

| Parameter Name | Type                                                                                                                | Description                                                                         |
| -------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| dataSet        | Array of [BandwithData](https://docs.console.zenlayer.com/test/ci-develop-en/networking/datastructure#bandwithdata) | Origin traffic(Unit MB)                                                             |
| requestId      | String                                                                                                              | Unique request ID returned with each request. Provide this ID when locating issues. |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}

1. **Query CDN origin traffic.**

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

Request:
{
  "startTime": "2022-06-14T00:00:00Z", 
  "endTime": "2022-06-14T00:10:00Z"
}

Response:
{
  "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
  "response": {
    "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
    "dataSet": [{
      "data": [{
        "time": "2022-06-14T00:00:00Z",
        "value": 101
      },
      {
        "time": "2022-06-14T00:05:00Z",
        "value": 142
      }],
      "domain": "www.ddd123.com"
    }]
  }
}

```

{% endtab %}
{% endtabs %}

## 5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see [Common Error Codes](https://docs.console.zenlayer.com/test/ci-develop-en/api-introduction/instruction/commonerrorcode).
