All Products
Search
Document Center

DescribeVodDomainBpsData

Last Updated: Jul 11, 2019

Description

You can call this operation to obtain the network bandwidth monitoring data for CDN domain names. The unit is bit/s.

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 DescribeVodDomainBpsData.
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.
LocationNameEn String The name of the region. If you do not set this parameter, the data of all regions is returned by default.
IspNameEn String The name of the ISP. If you do not set this parameter, the data of all ISPs is returned by default.
BpsDataPerInterval DataModule[] The network bandwidth data that was collected during each query interval.

DataModule

Parameter Type Description
TimeStamp String The start time of the query interval.
Value String The bandwidth. Unit: bit/s.
DomesticValue String The bandwidth in China. Unit: bit/s. The value is left blank when you query data by regional ISP.
OverseasValue String The bandwidth outside China. Unit: bit/s. The value is left blank when you query data by regional ISP.
HttpsValue String The HTTPS bandwidth of the CDN L1 cache node. Unit: bit/s.
HttpsDomesticValue String The HTTPS bandwidth of the CDN L1 cache node in China. The value is left blank when you query data by regional ISP.
HttpsOverseasValue String The HTTPS bandwidth of the CDN L1 cache node outside China. The value is left blank when you query data by regional ISP.

API examples

Sample request

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

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

Sample response

JSON format

{
    "BpsDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2015-12-10T20:00:00Z",
                "Value": "11288111",
                "DomesticValue": "11286111",
                "OverseasValue": "2000",
                "HttpsValue": "11288111",
                "HttpsDomesticValue": "11286111",
                "HttpsOverseasValue": "2000"
            },
            {
                "TimeStamp": "2015-12-10T20:05:00Z",
                "Value": "12124821",
                "DomesticValue": "12112821",
                "OverseasValue": "12000",
                "HttpsValue": "11288111",
                "HttpsDomesticValue": "11286111",
                "HttpsOverseasValue": "2000"
            }
        ]
    },
    "DomainName": "example.com",
    "DataInterval": "300",
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
    "StartTime": "2015-12-10T20:00:00Z",
    "EndTime": "2015-12-10T21:00:00Z"
}

Error codes

Error code Error message HTTP status code Description
InvalidStartTime.Malformed Specified StartTime is malformed. 400 The error message returned because the format of the specified StartTime parameter is invalid.
InvalidEndTime.Malformed Specified EndTime is malformed. 400 The error message returned because the format of the specified EndTime parameter is invalid.
InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. 400 The error message returned because the duration specified by the StartTime and EndTime parameters exceeds 90 days.
nvalidEndTime.Mismatch Specified EndTime does not match the specified StartTime. 400 The error message returned because the specified end time is earlier than the start time.