全部产品
Search
文档中心

CDN:DescribeDomainPathData - 按目录维度获取监控数据

更新时间:Mar 01, 2024

调用DescribeDomainPathData按目录维度获取监控数据,包括流量和访问次数。

接口说明

  • 该接口仅支持白名单用户(域名峰值带宽 10 Gbps 以上)调用,需要提交工单申请,符合条件的情况下将在后台进行配置。
  • 单用户调用频率:6000 次/分。
  • 目前仅支持对账号下的指定域名开启目录维度带宽统计,不支持对全部域名开启。
  • 域名下所有文件的平均大小需要大于 1 MB。
  • 每个域名的目录数量不超过 100 个,超过 100 个目录的情况下,数据的精度将会降低,查询的不准确。
  • 不指定 StartTime 和 EndTime 时,默认读取过去 24 小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。
  • 最多可获取最近 30 天的数据。

调试

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

授权信息

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

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

请求参数

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

取得第几页。从 1 开始。

1
PageSizeinteger

分页大小。 取值:1~1000 之间的任意整数。

20
Pathstring

路径,以正斜线(/)开头,不填表示查询所有路径。如果路径是目录,需要以正斜线(/)结尾。

说明 路径信息不支持模糊匹配,需要指定查询的目录深度,只能设置为一个固定值,例如设置一级目录/path/,表示数据统计时,固定统计一级目录的带宽。
/path/
StartTimestring

开始时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-DDThh:mm:ssZ。 例如:2016-10-20T04:00:00Z。

2016-10-20T04:00:00Z
EndTimestring

结束时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-DDThh:mm:ssZ。开始时间和结束时间,间隔小于 30 天。例如:2016-10-21T04:00:00Z。

2016-10-21T04:00:00Z
DomainNamestring

加速域名。

说明 仅支持单个域名查询。
example.com

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2017-09-30T17:00:00Z
StartTimestring

开始时间。

2017-09-30T16:00:00Z
PageSizeinteger

页面大小。

20
PageNumberinteger

当前页码,从 1 开始计数。

1
TotalCountinteger

路径带宽数据条数。

2
DomainNamestring

加速域名。

example.com
DataIntervalstring

时间间隔,单位:秒。

300
PathDataPerIntervalobject []

路径带宽数据列表。

Pathstring

路径。

/path/
Timestring

时间点。

2017-09-30T16:00:00Z
Accinteger

访问次数。

10
Trafficinteger

流量(B)。

346

示例

正常返回示例

JSON格式

{
  "EndTime": "2017-09-30T17:00:00Z",
  "StartTime": "2017-09-30T16:00:00Z",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 2,
  "DomainName": "example.com",
  "DataInterval": "300",
  "PathDataPerInterval": {
    "UsageData": [
      {
        "Path": "/path/",
        "Time": "2017-09-30T16:00:00Z",
        "Acc": 10,
        "Traffic": 346
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400InvalidPageSize.MalformedPageSize must be of type Integer
400InvalidPageSize.ExceedsMaximumPageSize should be less than or equal to 1000
400InvalidPageSize.ExceedsMinimumPageSize should be greater than or equal to 1
400InvalidPath.MalformedPath must be of type String
400InvalidStartTime.MalformedStartTime must be of type String
400InvalidEndTime.MalformedEndTime must be of type String
400InvalidDomainName.MalformedDomainName must be of type String
400MissingParameterDomainName is required
400InvalidDomainName.TooShortDomainName should be at least 1 chars long
400InvalidPageNumber.MalformedPageNumber must be of type Integer
400InvalidPageNumber.ExceedsMinimumPageNumber should be greater than or equal to 1
400InvalidTime.OverRangeSpecified StartTime or EndTime is over range

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