All Products
Search
Document Center

Alibaba Cloud CDN:DescribeDomainsUsageByDay

Last Updated:Jan 30, 2023

Queries the monitoring data of an accelerated domain name. Data is collected every day. You can query data collected within the last 90 days.

Operation Description

Note
  • If you do not set StartTime or EndTime, data within the last 24 hours is queried. If you set both StartTime and EndTime, data within the specified time range is queried.
  • You can query the monitoring data of a specific accelerated domain name or all accelerated domain names that belong to your Alibaba Cloud account.
  • Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operateaccess levelResource typeconditional keywordAssociation operation
    cdn:DescribeDomainsUsageByDayREAD
    • CDN
      acs:cdn:*:{#accountId}:domain/{#DomainName}
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringNo

    The accelerated domain name. You can specify only one domain name.

    If you do not specify an accelerated domain name, the monitoring data of all accelerated domain names that belong to your account is queried.

    example.com
    StartTimestringNo

    The start 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+0.

    2019-12-22T08:00:00Z
    EndTimestringNo

    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+0.

    NoteThe end time must be later than the start time.
    2019-12-23T09:00:00Z

    Response parameters

    ParameterTypeDescriptionExample
    object
    EndTimestring

    The end of the time range that was queried.

    2019-12-23T09:00:00Z
    StartTimestring

    The start of the time range that was queried.

    2019-12-22T08:00:00Z
    RequestIdstring

    The ID of the request.

    C88EF8ED-72F0-45EA-9E86-95114E224FC5
    DomainNamestring

    The information about the accelerated domain name.

    example.com
    DataIntervalstring

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

    86400
    UsageTotalobject

    The summarized monitoring data.

    MaxSrcBpsTimestring

    The time when the bandwidth during back-to-origin routing reached the peak value.

    2019-12-23 11:45:00
    RequestHitRatestring

    The cache hit ratio that is calculated based on requests. The cache hit ratio is measured in percentage.

    69.92610837438424
    MaxBpsstring

    The peak bandwidth value. Unit: bit/s.

    1.0747912780000001E8
    TotalAccessstring

    The total number of requests.

    1319500
    BytesHitRatestring

    The cache hit ratio that is calculated based on bytes. The cache hit ratio is measured in percentage.

    97.03110726801242
    TotalTrafficstring

    The total amount of network traffic. Unit: bytes.

    1117711832100
    MaxBpsTimestring

    The time when the bandwidth reached the peak value.

    2019-12-23 10:55:00
    MaxSrcBpsstring

    The peak bandwidth value during back-to-origin routing. Unit: bit/s.

    72584.072
    UsageByDaysarray

    The monitoring data collected at each time interval.

    object
    MaxSrcBpsTimestring

    The time when the bandwidth during back-to-origin routing reached the peak value.

    2019-12-23 11:45:00
    Qpsstring

    The number of queries per second (QPS).

    7.466354166666667
    RequestHitRatestring

    The cache hit ratio that is calculated based on requests. The cache hit ratio is measured in percentage.

    70.24770071912111
    MaxBpsstring

    The peak bandwidth value. Unit: bit/s.

    306747.76
    TotalAccessstring

    The total amount of requests.

    645093
    TimeStampstring

    The timestamp of the data returned.

    2019-12-22
    BytesHitRatestring

    The cache hit ratio that is calculated based on bytes. The cache hit ratio is measured in percentage.

    97.46250599529726
    TotalTrafficstring

    The total amount of network traffic. Unit: bytes.

    564300099309
    MaxSrcBpsstring

    The peak bandwidth value during back-to-origin routing. Unit: bit/s.

    72584.072
    MaxBpsTimestring

    The time when the bandwidth reached the peak value.

    2019-12-23 10:55:00

    Example

    Normal return example

    JSONFormat

    {
      "EndTime": "2019-12-23T09:00:00Z",
      "StartTime": "2019-12-22T08:00:00Z",
      "RequestId": "C88EF8ED-72F0-45EA-9E86-95114E224FC5",
      "DomainName": "example.com",
      "DataInterval": "86400",
      "UsageTotal": {
        "MaxSrcBpsTime": "2019-12-23 11:45:00",
        "RequestHitRate": "69.92610837438424",
        "MaxBps": "1.0747912780000001E8",
        "TotalAccess": "1319500",
        "BytesHitRate": "97.03110726801242",
        "TotalTraffic": "1117711832100",
        "MaxBpsTime": "2019-12-23 10:55:00",
        "MaxSrcBps": "72584.072"
      },
      "UsageByDays": {
        "UsageByDay": [
          {
            "MaxSrcBpsTime": "2019-12-23 11:45:00",
            "Qps": "7.466354166666667",
            "RequestHitRate": "70.24770071912111",
            "MaxBps": "306747.76",
            "TotalAccess": "645093",
            "TimeStamp": "2019-12-22",
            "BytesHitRate": "97.46250599529726",
            "TotalTraffic": "564300099309",
            "MaxSrcBps": "72584.072",
            "MaxBpsTime": "2019-12-23 10:55:00"
          }
        ]
      }
    }

    Error codes

    Http codeError codeError messageDescription
    400InvalidStartTime.MalformedSpecified StartTime is malformed.The specified start time is invalid. For more information, see the API references.
    400InvalidEndTime.MalformedSpecified EndTime is malformed.The EndTime parameter is set in an invalid format. For more information, see the API references.
    400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.
    400InvalidEndTime.MismatchSpecified EndTime does not math the specified StartTime.-
    404InvalidDomain.NotFoundThe domain provided does not exist in our records.The specified domain name does not exist or does not belong to the current account. Check whether the domain name is valid, belongs to the current account, or has expired.

    For a list of error codes, visit the API error center.