文档

DescribeDomainQpsData - 查询QPS

更新时间:

调用DescribeDomainQpsData获取5分钟计算粒度加速域名的每秒访问次数QPS,支持获取最近90天的数据。

接口说明

  • 如果您不指定 StartTime 和 EndTime,该接口返回过去 24 小时的数据;指定 StartTime 和 EndTime,该接口返回指定时间段的数据。

支持查询的时间粒度

根据单次查询的最大时间跨度不同,请求参数 Interval 支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:

时间粒度单次查询的最大时间跨度可查询历史数据时间范围数据延迟
5 分钟3 天93 天15 分钟
1 小时31 天186 天一般延迟 3-4 小时
1 天366 天366 天一般延迟 4 小时,不超过 24 小时

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cdn:DescribeDomainQpsDataREAD
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

加速域名,多个域名用半角逗号(,)分隔,一次最多支持 500 个域名查询。

默认查询所有加速域名。

example.com
StartTimestring

获取数据起始时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为 yyyy-MM-ddTHH:mm:ssZ。

2019-11-30T05:33:00Z
EndTimestring

获取数据结束时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为 yyyy-MM-ddTHH:mm:ssZ。

结束时间需大于起始时间。

2019-11-30T05:40:00Z
Intervalstring

指定查询数据的时间粒度,单位:秒。

根据单次查询的最大时间跨度不同,该参数支持 300(5 分钟)、3600(1 小时)和 86400(1 天)取值,具体请参见接口说明中支持查询的时间粒度。

300
IspNameEnstring

运营商英文名,通过 DescribeCdnRegionAndIsp 接口获得,默认查询所有运营商。

unicom
LocationNameEnstring

地域英文名,通过 DescribeCdnRegionAndIsp 接口获得,默认查询所有地域。

beijing

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2019-11-30T05:40:00Z
StartTimestring

开始时间。

2019-11-30T05:33:00Z
RequestIdstring

请求 ID。

B8333EDB-4595-46E0-AFE9-29BAA290D0E0
DomainNamestring

加速域名信息。

example.com
DataIntervalstring

每条记录的时间间隔,单位:秒。

300
QpsDataIntervalarray<object>

每个时间间隔的 QPS 数据列表。

object
AccValuestring

总访问次数。

0
AccDomesticValuestring

中国内地访问次数。

0
AccOverseasValuestring

全球(不包含中国内地)访问次数。

0
HttpsValuestring

节点 HTTPS 的 QPS 值。

1
HttpsOverseasValuestring

节点 HTTPS 全球(不包含中国内地)QPS 值。

1
DomesticValuestring

中国内地 QPS。

0
HttpsAccOverseasValuestring

节点全球(不包含中国内地)HTTPS 请求数。

1
HttpsDomesticValuestring

节点 HTTPS 中国内地 QPS 值。

1
HttpsAccValuestring

节点 HTTPS 请求数。

1
Valuestring

总 QPS。

0
OverseasValuestring

全球(不包含中国内地)QPS。

0
TimeStampstring

时间片起始时刻。

2019-11-30T05:40:00Z
HttpsAccDomesticValuestring

节点中国内地 HTTPS 请求数。

1

示例

正常返回示例

JSON格式

{
  "EndTime": "2019-11-30T05:40:00Z",
  "StartTime": "2019-11-30T05:33:00Z",
  "RequestId": "B8333EDB-4595-46E0-AFE9-29BAA290D0E0",
  "DomainName": "example.com",
  "DataInterval": "300",
  "QpsDataInterval": {
    "DataModule": [
      {
        "AccValue": "0",
        "AccDomesticValue": "0",
        "AccOverseasValue": "0",
        "HttpsValue": "1",
        "HttpsOverseasValue": "1",
        "DomesticValue": "0",
        "HttpsAccOverseasValue": "1",
        "HttpsDomesticValue": "1",
        "HttpsAccValue": "1",
        "Value": "0",
        "OverseasValue": "0",
        "TimeStamp": "2019-11-30T05:40:00Z",
        "HttpsAccDomesticValue": "1"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingTimeParameterThe StartTime and EndTime must be both specified.请同时提供开始时间和结束时间。
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.开始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.参数EndTime格式错误。
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.指定的EndTime与StartTime不匹配,StartTime应早于EndTime。
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.开始时间设置错误,请检查更新后重试。

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

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 错误码发生变更查看变更详情