分页查询推送记录,并提供一些简单的筛选能力。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mpush:QueryPushRecords | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppKey | long | 是 | AppKey 信息。 | 333526247 |
StartTime | string | 是 | 查询的起始时间,UTC 时间,ISO-8601 格式,格式为 YYYY-MM-DDThh:mm:ssZ。 | 2021-09-15T02:05:24Z |
EndTime | string | 是 | 查询的结束时间,UTC 时间,ISO-8601 格式,格式为 YYYY-MM-DDThh:mm:ssZ。 | 2021-09-29T06:24:58Z |
PushType | string | 否 | 推送类型。取值:
| NOTICE |
Target | string | 否 | 推送目标:
| DEVICE |
Source | string | 否 | 推送来源。可取值:
| API |
Keyword | string | 否 | 查询关键字,根据 MessageId、Title、Body 字段进行查询。系统对推送的 title 和 body 进行了中文分词,使用分词进行查询,非子字符串匹配查询。 | 统计数据测试通知805 |
NextToken | string | 否 | 废弃参数,不再使用。 | FFPpkmhCPm*****************xjk= |
PageSize | integer | 否 | 每页的条目数量,默认值为 20, 最大为 100。 | 10 |
Page | integer | 否 | 推送记录的当前页数, 默认为 1,最大 10000。 | 8 |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "i91D***********kXIh/dVBEQ==",
"PageSize": 20,
"RequestId": "9B24B396-249D-55E4-8CA1-66C9B50BB734",
"Total": 193,
"Page": 11,
"PushInfos": {
"PushInfo": [
{
"Status": "SENT",
"MessageId": "510431",
"AppKey": 333526247,
"DeviceType": "ANDROID",
"PushType": "NOTICE",
"Body": "abcd",
"Title": "sssss",
"Source": "DEVICE",
"PushTime": "2021-09-15T02:05:24Z",
"Target": "DEVICE"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | AccountDisabled | Your account is not enabled. | 功能未启用。 |
500 | InternalError | The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket. | 服务端错误,建议重试,仍然失败则提工单 |
500 | Timeout | The request processing is timeout. | 请求处理超时。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-01-25 | OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |