文档

DescribeVsTopDomainsByFlow - 获取顶级域名

更新时间:

获取用户按流量排名的域名 不指定StartTime和EndTime时,默认读取当月的数据,同时支持按指定的起止时间查询,两者需要同时指定。 * 最多可获取90天的数据。

调试

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

授权信息

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

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

请求参数

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

获取数据起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。
格式为:YYYY-MM-DDThh:mm:ssZ
最小数据粒度为 5 分钟
不写默认读取当月数据

2021-12-12T10:00:00Z
EndTimestring

结束时间需大于起始时间;获日期格式按照 ISO8601 表示法,并使用 UTC 时间。
格式为:YYYY-MM-DDThh:mm:ssZ

2018-12-10T18:00:00Z
Limitlong

域名获取数量限制,默认为 20,取值支持 1~100

3

返回参数

名称类型描述示例值
object
DomainOnlineCountlong

账户下正在运行的域名总数。

12
EndTimestring

按结束时间查询。

2018-12-10T18:00:00Z
StartTimestring

按开始时间查询。

2021-12-10T10:00:00Z
RequestIdstring

本次操作请求 ID

BEA5625F-8FCF-48F4-851B-CA63946DA664
DomainCountlong

账号下的域名总数。

20
TopDomainsarray<object>

域名列表。

object

排名域名列表。

MaxBpslong

带宽峰值。

100
Ranklong

排名。

1
TotalAccesslong

访问次数。

100
TrafficPercentstring

流量占比。

30.64191989360235
DomainNamestring

域名。

example.aliyundoc.com
TotalTrafficstring

总流量。

100
MaxBpsTimestring

带宽峰值时刻。

1457111400

示例

正常返回示例

JSON格式

{
  "DomainOnlineCount": 12,
  "EndTime": "2018-12-10T18:00:00Z",
  "StartTime": "2021-12-10T10:00:00Z",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "DomainCount": 20,
  "TopDomains": {
    "TopDomain": [
      {
        "MaxBps": 100,
        "Rank": 1,
        "TotalAccess": 100,
        "TrafficPercent": "30.64191989360235",
        "DomainName": "example.aliyundoc.com",
        "TotalTraffic": "100",
        "MaxBpsTime": "1457111400"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedThe format of the specified StartTime is invalid.开始时间格式不对
400InvalidEndTime.MalformedThe format of the specified EndTime is invalid.截止时间格式不对
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.不支持该开始时间

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