QueryTaskByParam - 查询任务_邮件推送(Direct Mail)-阿里云帮助中心

查询任务。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dm:QueryTaskByParam

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNo	integer	否	当前页码，默认为 1	1
PageSize	integer	否	每页大小，默认为 10	10
KeyWord	string	否	关键词，默认所有信息	mesh-notification-788717
Status	integer	否	状态，默认所有状态	0

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页大小	10
RequestId	string	请求 ID	10A1AD70-E48E-476D-98D9-39BD92193837
PageNumber	integer	当前页码	3
TotalCount	integer	总数量	15
data	object
task	array<object>	返回的结果
	object
ReceiversName	string	收件人名称	TKP000442-333
TagName	string	标签	202201
TaskStatus	string	任务状态，发送成功：1	1
CreateTime	string	创建时间	2022-04-18T10:36Z
RequestCount	string	请求数	1
AddressType	string	地址类型，发信地址：1；随机地址：0；	0
UtcCreateTime	integer	创建时间的 UTC 格式	1569734892
TemplateName	string	模板名称	Short Simple
TaskId	string	任务 ID	1054296
IpPoolId	string	独立 IP 地址池 ID。	xxx
IpPoolName	string	独立 IP 地址池名称。	测试专属IP地址池1
ConfigSetId	string	配置集 ID。	xxx
ConfigSetName	string	配置集名称。	xxx

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNumber": 3,
  "TotalCount": 15,
  "data": {
    "task": [
      {
        "ReceiversName": "TKP000442-333",
        "TagName": "202201",
        "TaskStatus": "1",
        "CreateTime": "2022-04-18T10:36Z",
        "RequestCount": "1",
        "AddressType": "0",
        "UtcCreateTime": 1569734892,
        "TemplateName": "Short Simple",
        "TaskId": "1054296",
        "IpPoolId": "xxx",
        "IpPoolName": "测试专属IP地址池1",
        "ConfigSetId": "xxx",
        "ConfigSetName": "xxx"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	InvalidKeyword.Malformed	The specified keyword is wrongly formed.
400	InvalidStatus.Malformed	The specified status is wrongly formed.
500	InternalError	The request processing has failed due to some unknown error.

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

变更历史

更多信息，参考变更详情。