All Products
Search
Document Center

DescribeVodDomainTrafficData

Last Updated: Jul 11, 2019

Description

You can call this operation to obtain the network traffic monitoring data for CDN domain names. The unit is bytes.

Note:

  • You can specify multiple domain names. Separate them with commas (,).
  • If you set neither the StartTime parameter nor the EndTime parameter, the data in the last 24 hours is queried by default.
  • Alternatively, you can set both the StartTime and EndTime parameters to query data generated in the specified duration. You can obtain data for the last 90 days at most.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set this parameter to DescribeVodDomainTrafficData.
DomainName String No The domain name to be queried. If you do not set this parameter, the merged data of all your CDN domain names is returned by default. You can specify multiple domain names. Separate them with commas (,).
StartTime String No The beginning of the time range where the data is queried.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
  • [DO NOT TRANSLATE]
  • The minimum query interval is 5 minutes. If you do not set this parameter, the data in the last 24 hours is queried by default.
EndTime String No The end of the time range where the data is queried. The end time must be later than the start time.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
  • [DO NOT TRANSLATE]
Interval String No The query interval. Unit: seconds. Valid values:
  • For a query duration of less than 3 days: 300 (default), 3600, and 86400.
  • For a query duration of 3 to 31 (exclusive) days: 3600 (default) and 86400.
  • For a query duration of 31 to 90 days: 86400 (default). If you do not set this parameter or if you specify an invalid value, the default value is used.
LocationNameEn String No The name of the region. If you do not set this parameter, the data of all regions is returned by default.
IspNameEn String No The name of the Internet service provider (ISP). If you do not set this parameter, the data of all ISPs is returned by default.

Response parameters

Parameter Type Description
RequestId String The ID of the request.
DomainName String The CDN domain name.
DataInterval String The query interval. Unit: seconds.
StartTime DateTime The beginning of the time range where the data is queried.
EndTime DateTime The end of the time range where the data is queried.
TrafficDataPerInterval DataModule[] The network traffic data that was collected during each query interval.

DataModule

Parameter Type Description
TimeStamp String The start time of the query interval.
Value String The total traffic volume.
DomesticValue String The traffic volume in China.
OverseasValue String The traffic volume outside China.
HttpsValue String The total HTTPS traffic volume of the L1 nodes.
HttpsDomesticValue String The HTTPS traffic volume of the L1 nodes in China.
HttpsOverseasValue String The HTTPS traffic volume of the L1 nodes outside China.

API examples

Sample request

http://vod.cn-shanghai.aliyuncs.com/?Action=DescribeVodDomainTrafficData&Format=JSON&<Common request parameters>

Note: For more information about common request parameters, see Common parameters.

Sample response

JSON format

{
    "RequestId":"D94E471F-1A27-442E-8755-D4D2000CB492",
    "EndTime":"2019-01-20T15:59:58Z",
    "TrafficDataPerInterval":{
        "DataModule":[
            {
                "OverseasValue":0,
                "HttpsValue":0,
                "Value":0,
                "HttpsDomesticValue":0,
                "HttpsOverseasValue":0,
                "TimeStamp":"2019-01-15T18:00:00Z",
                "DomesticValue":0
            },
            {
                "OverseasValue":0,
                "HttpsValue":0,
                "Value":0,
                "HttpsDomesticValue":0,
                "HttpsOverseasValue":0,
                "TimeStamp":"2019-01-15T19:00:00Z",
                "DomesticValue":0
            }
        ]
    },
    "DomainName":"example.com",
    "DataInterval":3600,
    "StartTime":"2019-01-15T15:59:59Z"
}

Error codes

Error code Error message HTTP status code Description
Throttling Request was denied due to request throttling. 503 The error message returned because the request is denied due to throttling.
IllegalOperation Illegal domain, operation is not permitted. 403 The error message returned because the specified domain name is invalid.
OperationDenied Your account does not open CDN service yet. 403 The error message returned because CDN has not been activated for your account.
OperationDenied Your CDN service is suspended. 403 The error message returned because CDN has been deactivated for your account.
InvalidDomain.NotFound The domain provided does not belong to you. 404 The error message returned because the specified domain name does not exist or does not belong to you.
InvalidDomain.Offline The domain provided is offline. 404 The error message returned because the specified domain name has been discontinued.
ServiceBusy The specified Domain is configuring, please retry later. 403 The error message returned because the specified domain name is being configured. Try again later.
InvalidDomain.Configure_failed Failed to configure the provided domain. 500 The error message returned because the system failed to configure the specified domain name.
MissingParameter StartTime and EndTime can not be single. 400 The error message returned because you have set only one of the StartTime and EndTime parameters.
InvalidStartTime.Malformed Specified start time is malformed. 400 The error message returned because the format of the specified StartTime parameter is invalid.
InvalidEndTime.Malformed Specified end time is malformed. 400 The error message returned because the format of the specified EndTime parameter is invalid.
InvalidEndTime.Mismatch Specified end time does not match the specified start time. 400 The error message returned because the specified end time is earlier than the start time.
InvalidStartTime.ValueNotSupported Specified end time does not match the specified start time. 400 The error message returned because the duration specified by the StartTime and EndTime parameters exceeds 90 days.