tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeOriginData

Last updated: 2023-12-01 16:39:46

    1. API Description

    Domain name for API request: cdn.tencentcloudapi.com.

    This API 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.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: DescribeOriginData.
    Version Yes String Common Params. The value used for this API: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    StartTime Yes Timestamp Start time of the query, e.g., 2018-09-04 10:40:00.
    The specified start time will be rounded down based on the granularity parameter Interval. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00.
    The period between the start time and end time can be up to 90 days.
    EndTime Yes Timestamp End time of the query, e.g. 2018-09-04 10:40:00.
    The specified end time will be rounded down based on the granularity parameter Interval. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00.
    The period between the start time and end time can be up to 90 days.
    Metric Yes String Specifies the metric to query, 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 query. You can query up to 30 domain names at a time.
    Project No Integer Specifies the project ID to be queried. Check project ID in the console
    If the domain name is not specified, the specified project will be queried. Up to 30 acceleration domain names can be queried at a time.
    If the domain name information is specified, this parameter can be ignored.
    Interval No String Time granularity, which can be:
    min: Return data with 1-minute granularity. It’s available when the query period is within 24 hours and Area is mainland.
    5min: Return data with 5-minute granularity. It’s available when the query period is within 31 days.
    hour: Return data with 1-hour granularity. It’s available when the query period is within 31 days.
    day: Return data with 1-day granularity. It’s available when the query 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 the service region. If this value is left blank, it means to query CDN data within the Chinese mainland.
    mainland: Query CDN data in the Chinese mainland.
    overseas: Query CDN data outside the Chinese mainland.
    TimeZone No String Specifies a time zone to query. The default time zone is UTC+08:00.

    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. Example

    Example1 Querying CDN origin-pull data

    Input Example

    https://cdn.tencentcloudapi.com/?Action=DescribeOriginData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&Metric=flux
&Domains.0=www.test.com
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "123",
        "Data": [
            {
                "Resource": "www.test.com",
                "OriginData": [
                    {
                        "Metric": "flux",
                        "DetailData": [
                            {
                                "Time": "2018-09-03 00:00:00",
                                "Value": 10
                            },
                            {
                                "Time": "2018-09-03 00:05:00",
                                "Value": 20
                            }
                        ],
                        "SummarizedData": {
                            "Name": "sum",
                            "Value": 30
                        }
                    }
                ]
            }
        ],
        "Interval": 5
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. 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.CamSystemError Authentication system internal error.
    InternalError.CdnConfigError Failed to update the domain name configuration.
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.CdnQuerySystemError Internal error. Please try again or contact the customer service for assistance.
    InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
    InternalError.DataSystemError Error with the data query. Please submit a ticket for troubleshooting.
    InternalError.Error Service internal error. Please submit a ticket for troubleshooting.
    InternalError.InvalidErrorCode Service internal error. Please submit a ticket for troubleshooting.
    InternalError.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InternalError.RouteError Internal service error. Please submit a ticket for troubleshooting.
    InternalError.TagSystemError Tag internal error. 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.CdnInvalidParamMetric Parameter error: Metric. Please check and try again.
    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 Unable to find the domain name. Please make sure the domain name is correct.
    ResourceNotFound.CdnProjectNotExists The project does not exist. 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 domain names under the account has reached the upper limit. Please submit a ticket for assistance.
    UnauthorizedOperation.CdnAccountUnauthorized The sub-account is unauthorized to query full data.
    UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
    UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
    UnauthorizedOperation.CdnProjectUnauthorized The project is not authorized for the sub-account.
    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.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy