文档

DescribeCustomEventCount - 查询自定义事件的统计结果

更新时间:

调用DescribeCustomEventCount接口查询自定义事件的统计结果。

接口说明

说明 此 API 以产品为维度统计每个产品自定义事件的数量。

调试

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

授权信息

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

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

请求参数

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

事件名称。

BABEL_BUY
EventIdstring

事件 ID。

123
GroupIdstring

应用分组 ID。

12345
SearchKeywordsstring

搜索事件内容包含的关键字。

  • 如果您待搜索事件的内容中包括 A 和 B,则可以搜索 A 和 B。
  • 如果您待搜索事件的内容中包括 A 或 B,则可以搜索 A 或 B。
cms
StartTimestring

开始时间。

格式为 Unix 时间戳,即从 1970 年 1 月 1 日开始所经过的毫秒数。

1552209685596
EndTimestring

结束时间。

格式为 Unix 时间戳,即从 1970 年 1 月 1 日开始所经过的毫秒数。

1552220485596

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。当请求成功时,返回成功信息;当请求失败时,返回失败原因。

success
RequestIdstring

请求 ID。

60912C8D-B340-4253-ADE7-61ACDFD25CFC
Successboolean

操作是否成功。true 表示成功,false 表示失败。

true
CustomEventCountsobject []

自定义事件详情。

Timelong

事件发生的时间。

格式为 Unix 时间戳,即从 1970 年 1 月 1 日开始所经过的毫秒数。

1552267615000
Numinteger

事件数量。

20
Namestring

事件名称。

BABEL_BUY

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "success",
  "RequestId": "60912C8D-B340-4253-ADE7-61ACDFD25CFC",
  "Success": true,
  "CustomEventCounts": {
    "CustomEventCount": [
      {
        "Time": 1552267615000,
        "Num": 20,
        "Name": "BABEL_BUY"
      }
    ]
  }
}

JSON格式

{
  "Code": "200",
  "Message": "success",
  "RequestId": "60912C8D-B340-4253-ADE7-61ACDFD25CFC",
  "Success": true,
  "CustomEventCounts": {
    "CustomEventCount": [
      {
        "Time": 1552267615000,
        "Num": 20,
        "Name": "BABEL_BUY"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)