查询与取消定时推送任务-移动开发平台mPaaS-阿里云

查询定时推送任务列表

查询已创建的定时推送任务列表，包括定时推送任务和循环推送任务。

请求参数

参数名称	类型	是否必填	示例	描述
appId	String	是	ONEX570DA89211721	mPaaS App ID
workspaceId	String	是	test	mPaaS 工作空间
startTime	long	是	1619798400000	触发定时推送的开始时间戳，并非定时推送任务的创建时间。
endtTime	long	是	1630425600000	触发定时推送的结束时间戳。
type	int	否	0	推送方式，其中： 0 - 极简推送 1 - 模板推送 2 - 批量推送 3 - 群发推送
uniqueId	String	否	49ec0ed5a2a642bcbe139a2d7a419d6d	定时推送任务的唯一 ID。若传主任务 ID，则返回主任务下的所有子任务的信息；若传子任务 ID，则返回子任务的信息。
pageNumber	int	否	1	页码，默认为 1。
pageSize	int	否	10	分页大小，默认为 500。

返回参数

参数名称	类型	示例	描述
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	请求 ID
ResultCode	String	OK	请求结果码
ResultMessage	String	param is invalid	请求错误描述
ResultContent	JSON		响应内容
data	JSON		响应内容。该参数值包含在 `ResultContent` JSON 字符串中。
totalCount	int	10	总数
list	JSONArray		任务数组
uniqueId	String	56918166720e46e1bcc40195c9ca71db	定时推送任务的唯一 ID。若 `strategyType` 值为 1，表示定时推送任务主 ID。若 `strategyType` 值为 2，表示循环任务子 ID。
parentId	String	56918166720e46e1bcc40195c9ca71db	定时推送任务主 ID。若 `strategyType` 值为 1，表示定时推送任务主 ID；若 `strategyType` 值为 2，表示循环任务主 ID。
pushTime	Date	1630486972000	预计推送时间
pushTitle	String	测试标题	通知标题
pushContent	String	测试正文	通知内容
type	int	0	推送方式，其中： 0 - 极简推送 1 - 模板推送 2 - 批量推送 3 - 群发推送
deliveryType	int	1	推送类型，其中： 1 - Android 2 - iOS 3 - UserId 7 - HarmonyOS
strategyType	int	1	推送策略类型，其中： 1 - 定时 2 - 循环
executedStatus	int	0	是否执行，其中： 0 - 未执行 1 - 已执行
createType	int	0	创建方式，其中： 0 - API 1 - 控制台
gmtCreate	Date	1629971346000	创建时间

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.QueryPushSchedulerListRequest;
import com.aliyun.mpaas20201028.models.QueryPushSchedulerListResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填，您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填，您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    QueryPushSchedulerListRequest request = new QueryPushSchedulerListRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setStartTime(Long.valueOf("1764864000000"));
    request.setEndTime(Long.valueOf("1764950219999"));
    request.setType(0);
    request.setUniqueId("49ec0ed5a2a642bcbe139a2d7a419d6d");
    request.setPageNumber(1);
    request.setPageSize(10);
    QueryPushSchedulerListResponse queryPushSchedulerListResponse = client.queryPushSchedulerList(request);
    System.out.println("response==>"+ JSON.toJSONString(queryPushSchedulerListResponse));
}

取消定时推送任务

取消未执行的定时推送任务（包括循环推送任务），支持批量取消。

请求参数

参数名称	类型	是否必填	示例	描述
appId	String	是	ONEX570DA89211721	mPaaS App ID
workspaceId	String	是	test	mPaaS 工作空间
type	int	否	0	定时推送任务 ID 类型，默认为 0。 0 - 主任务 ID，对应 `parentId` 1 - 子任务 ID，对应`uniqueId`
uniqueIds	String	是	714613eb,714613ec,714613ed	定时推送任务的唯一 ID，多个 ID 以“,”分隔，上限为 30 个。

返回参数

参数名称	类型	示例	描述
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	请求 ID
ResultCode	String	OK	请求结果码
ResultMessage	String	param is invalid	请求错误描述
ResultContent	String	{714613eb=1,714613ed=0}	取消结果，1 表示成功，0 表示失败。

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.CancelPushSchedulerRequest;
import com.aliyun.mpaas20201028.models.CancelPushSchedulerResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填，您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填，您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    CancelPushSchedulerRequest request = new CancelPushSchedulerRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setUniqueIds("49ec0ed5a2a642bcbe139a2d7a419d6d, 49ec0ed5a2a642bcbe139a2d7a419d6c");
    CancelPushSchedulerResponse cancelPushSchedulerResponse = client.cancelPushScheduler(request);
    System.out.println("response==>"+ JSON.toJSONString(cancelPushSchedulerResponse));
}