DescribeVodDomainBpsData - 查询加速域名的网络带宽 - 视频点播

调用DescribeVodDomainBpsData获取加速域名的网络带宽监控数据。

接口说明

说明不指定StartTime和EndTime时，默认读取过去24小时的数据。也可以按指定的起止时间查询，必须同时指定StartTime和EndTime，最多可获取近90天的数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	要查询的域名。若为空，则默认返回所有加速域名的合并数据。支持批量查询，多个用半角逗号（,）分隔。	example.com
StartTime	string	否	获取数据起始时间点。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明最小数据粒度为5分钟，若为空，则默认读取最近24小时的数据。	2015-12-10T13:00:00Z
EndTime	string	否	结束时间，需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2015-12-10T14:00:00Z
Interval	string	否	查询数据的时间粒度。单位：秒。支持300、3600和86400。 3天以内（不包含3天整）支持：300（默认）、3600、86400。 3-31天（不包含31天整）支持：3600（默认）和86400。 31天以上支持：86400（默认）。	300
IspNameEn	string	否	运营商英文名。不传入该参数，默认查询所有运营商。	Alibaba
LocationNameEn	string	否	地域英文名。不传入该参数，默认查询所有地域。目前仅支持上海地域。	cn-shanghai

返回参数

名称	类型	描述	示例值
	object
EndTime	string	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2015-12-10T14:00:00Z
StartTime	string	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2015-12-10T13:00:00Z
RequestId	string	请求ID。	3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F
IspNameEn	string	运营商英文名。默认为所有运营商。	Alibaba
LocationNameEn	string	地域英文名。默认为所有地域。	cn-shanghai
DomainName	string	加速域名信息。	example.com
DataInterval	string	每条记录的时间间隔。单位：秒。	300
BpsDataPerInterval	array	每个时间间隔的网络带宽数据。
	object
HttpsDomesticValue	string	L1节点HTTPS中国内地带宽。单位：bit/second。当按区域运营商查询时，此值为空。	11286111
Value	string	bps数据值。单位：bit/second。	11288111
OverseasValue	string	海外带宽。单位：bit/second。当按区域运营商查询时，此值为空。	2000
HttpsValue	string	L1节点HTTPS的带宽数据值。单位：bit/second。	11288111
HttpsOverseasValue	string	L1节点海外HTTPS带宽。单位：bit/second。当按区域运营商查询时，此值为空。	2000
TimeStamp	string	时间片起始时刻。使用UTC时间，格式：YYYY-MM-DDThh:mm:ssZ。	2015-12-10T13:00:00Z
DomesticValue	string	中国内地带宽。单位：bit/second。当按区域运营商查询时，此值为空。	11286111

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=DescribeVodDomainBpsData
&<公共请求参数>

正常返回示例

JSON格式

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

XML格式

<DescribeVodDomainBpsDataResponse>
    <BpsDataPerInterval>
        <DataModule>
            <TimeStamp>2015-12-10T13:00:00Z</TimeStamp>
            <Value>11288111</Value>
            <DomesticValue>11286111</DomesticValue>
            <OverseasValue>2000</OverseasValue>
            <HttpsValue>11288111</HttpsValue>
            <HttpsDomesticValue>11286111</HttpsDomesticValue>
            <HttpsOverseasValue>2000</HttpsOverseasValue>
        </DataModule>
        <DataModule>
            <TimeStamp>2015-12-10T13:05:00Z</TimeStamp>
            <Value>12124821</Value>
            <DomesticValue>12112821</DomesticValue>
            <OverseasValue>12000</OverseasValue>
            <HttpsValue>11288111</HttpsValue>
            <HttpsDomesticValue>11286111</HttpsDomesticValue>
            <HttpsOverseasValue>2000</HttpsOverseasValue>
        </DataModule>
    </BpsDataPerInterval>
    <DomainName>example.com</DomainName>
    <DataInterval>300</DataInterval>
    <RequestId>3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F</RequestId>
    <StartTime>2015-12-10T13:00:00Z</StartTime>
    <EndTime>2015-12-10T14:00:00Z</EndTime>
</DescribeVodDomainBpsDataResponse>

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码	错误信息	HTTP 状态码	说明
InvalidStartTime.Malformed	Specified StartTime is malformed.	400	StartTime格式错误。
InvalidEndTime.Malformed	Specified EndTime is malformed.	400	EndTime格式错误。
InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	400	EndTime和StartTime差值超过90天。
InvalidEndTime.Mismatch	Specified EndTime does not math the specified StartTime.	400	EndTime小于StartTime。