Contents：
1. API Description
Domain name for API request: cdn.tencentcloudapi.com.
This API (DescribeOriginData) is used to query CDN real-time origin-pull monitoring data and supports the following metrics:
- Origin-pull traffic (in bytes)
- Origin-pull bandwidth (in bps)
- Number of origin-pull requests
- Number of failed origin-pull requests
- Origin-pull failure rate (in % with two decimal digits)
- Aggregate list of 2xx origin-pull status codes and the details of origin-pull status codes starting with 2 (in entries)
- Aggregate list of 3xx origin-pull status codes and the details of origin-pull status codes starting with 3 (in entries)
- Aggregate list of 4xx origin-pull status codes and the details of origin-pull status codes starting with 4 (in entries)
- Aggregate list of 5xx origin-pull status codes and the details of origin-pull status codes starting with 5 (in entries)
A maximum of 20 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeOriginData. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-06-06. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| StartTime | Yes | Timestamp | Query start time, such as 2018-09-04 10:40:00; the returned result is later than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the first returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days. |
| EndTime | Yes | Timestamp | Query end time, such as 2018-09-04 10:40:00; the returned result is earlier than or equal to the specified time. According to the specified time granularity, forward rounding is applied; for example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1 hour, the time for the last returned entry will be 2018-09-04 10:00:00. The gap between the start time and end time should be less than or equal to 90 days. |
| Metric | Yes | String | Specifies the query metric, which can be: flux: origin-pull traffic (in bytes) bandwidth: origin-pull bandwidth (in bps) request: number of origin-pull requests failRequest: number of failed origin-pull requests failRate: origin-pull failure rate (in %) statusCode: origin-pull status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx origin-pull status codes will be returned (in entries) 2xx: Returns the aggregate list of 2xx origin-pull status codes and the data for origin-pull status codes starting with 2 (in entries) 3xx: Returns the aggregate list of 3xx origin-pull status codes and the data for origin-pull status codes starting with 3 (in entries) 4xx: Returns the aggregate list of 4xx origin-pull status codes and the data for origin-pull status codes starting with 4 (in entries) 5xx: Returns the aggregate list of 5xx origin-pull status codes and the data for origin-pull status codes starting with 5 (in entries) It is supported to specify a status code for query. The return will be empty if the status code has never been generated. |
| Domains.N | No | Array of String | Specifies the list of domain names to be queried; up to 30 domain names can be queried at a time. |
| Project | No | Integer | Specifies the project ID to be queried, which can be viewed here Please note that if domain names are specified, this parameter will be ignored. |
| Interval | No | String | Time granularity; valid values:min: data with 1-minute granularity is returned when the queried period is no longer than 24 hours. This value is not supported if the service region you want to query is outside Mainland China;5min: data with 5-minute granularity is returned when the queried period is no longer than 31 days;hour: data with 1-hour granularity is returned when the queried period is no longer than 31 days;day: data with 1-day granularity is returned when the queried period is longer than 31 days. |
| Detail | No | Boolean | The aggregate data for multiple domain names is returned by default (false) when multiple Domains are passed in.You can set it to true to return the details for each Domain (the statusCode metric is currently not supported) |
| Area | No | String | Specifies a service region. If this value is left blank, CDN data within Mainland China will be queried.mainland: specifies to query CDN data within Mainland China;overseas: specifies to query CDN data outside Mainland China. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Interval | String | Time granularity of data statistics, which supports min (1 minute), 5min (5 minutes), hour (1 hour), and day (1 day). |
| Data | Array of ResourceOriginData | Origin-pull data details of each resource. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
Command Line Interface
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InternalError.DataSystemError | Error with the data query. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnHostInvalidMiddleConfig | Incorrect intermediate server configuration. |
| InvalidParameter.CdnHostInvalidParam | Invalid domain name format. Please check and try again. |
| InvalidParameter.CdnInterfaceError | Internal API error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnParamError | Parameter error. Please see the sample parameters in the documentation. |
| InvalidParameter.CdnStatInvalidDate | Invalid date. Please see the sample date in the documentation. |
| InvalidParameter.CdnStatInvalidMetric | Invalid statistical type. Please see the sample statistical analysis in the documentation. |
| InvalidParameter.CdnStatInvalidProjectId | Incorrect project ID. Please check and try again. |
| InvalidParameter.CdnStatTooManyDomains | The number of queried domain names reached the limit. |
| LimitExceeded.CdnHostOpTooOften | Domain name operations are too frequent. |
| ResourceNotFound.CdnHostNotExists | This domain name does not exist under the account. Please check and try again. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| ResourceNotFound.CdnUserTooManyHosts | The number of accessed domain names reached the limit. |
| UnauthorizedOperation.CdnAccountUnauthorized | The sub-account is unauthorized to query full data. |
| UnauthorizedOperation.CdnUserIsSuspended | The CDN service has been suspended. Please restart it and try again. |
| UnauthorizedOperation.CdnUserNoWhitelist | You are not in the beta whitelist and thus have no permission to use this function. |
