QueryTaskByParam - Direct Mail - Alibaba Cloud Documentation Center

Queries tasks based on specified parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dm:QueryTaskByParam

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries per page. The default value is 10.	10
KeyWord	string	No	The keyword. By default, all information is returned.	mesh-notification-788717
Status	integer	No	The status. By default, tasks in all states are returned.	0

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	10A1AD70-E48E-476D-98D9-39BD92193837
PageNumber	integer	The page number.	3
TotalCount	integer	The total number of entries.	15
data	object
task	array<object>	The returned result.
	object
ReceiversName	string	The recipient name.	TKP000442-333
TagName	string	The tag.	202201
TaskStatus	string	The task status. A value of 1 indicates that the email is sent.	1
CreateTime	string	The time when the task was created.	2022-04-18T10:36Z
RequestCount	string	The number of requests.	1
AddressType	string	The address type. A value of 1 indicates a sender address. A value of 0 indicates a random address.	0
UtcCreateTime	integer	The time when the task was created, in UTC format.	1569734892
TemplateName	string	The template name.	Short Simple
TaskId	string	The task ID.	1054296
IpPoolId	string	The ID of the dedicated IP address pool.	xxx
IpPoolName	string	The name of the dedicated IP address pool.	测试专属IP地址池1
ConfigSetId	string	The configuration set ID.	xxx
ConfigSetName	string	The configuration set name.	xxx

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.