Queries one or more tracking tasks of operations reports.
Operation description
Note
You can call this operation up to 3 times per second per account.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DeliverId | long | No | The ID of the tracking task that you want to query. If you do not specify an ID, all tracking tasks are queried. | 3 |
Response parameters
Fields in the data parameter
Field | Type | Description |
---|---|---|
deliverId | Long | The ID of the tracking task. |
status | String | The status of the tracking task. Valid values: enable, disable |
createTime | String | The time when the tracking task was created. |
crontab | String | The period during which the tracking task runs. |
frequency | String | The interval at which the reports are sent. Valid values: h: hour, d: day, M: month |
name | String | The name of the tracking task. |
dmList | String[] | The domain names from which the tracking task collects data. |
reports | String[] | The information about the reports released by the tracking task, including:reportId: the ID of the report.conditions: the filter conditions, including the filter action, fields, and values. If no filter conditions are specified, this parameter does not carry a value. op: the filter action. Only in is supported. field: the filter fields. value: the filter values. |
deliver | String | The delivery module, including the subject and recipient of the email.email: indicates that reports are sent to specified email addresses.subject: the subject of the email.to: the recipient of the email.copy: the contacts to whom the email is copied. |
Fields in the reports parameter
Parameter | Type | Description |
---|---|---|
deliverId | Long | The ID of the tracking task. |
status | String | The status of the tracking task. Valid values: enable, disable |
Examples
Sample success responses
JSON
format
{
"Content": "\"data\": \\[{\"deliverId\": 1,\"status\": \"enable\",\"createTime\": \"2020-10-14T11:19:26Z\",\"crontab\": \"0 0 0 \\* \\* ?\",\"frequency\": \"d\",\"name\": \"The name of the tracking task\",\"dmList\": \\[\"www.example.com\"],\"reports\": \\[{\"reportId\": 1,\"conditions\": \\[{\"op\": \"in\",\"field\": \"prov\",\"value\": \\[\"Heilongjiang\",\"Beijing\"]}} },{\"reportId\": 2}],\"deliver\": {\"email\": {\"subject\": \"subject\",\"to\": \\[\"example@alibaba-inc.com\",\"example@alibaba-inc.com\"]}}}]}\n",
"RequestId": "12345"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | - |
400 | TimeParseFailed | Failed to parse the time parameter. | Failed to parse the time parameter. |
400 | SubscriptionAlreadyExists | The subscription already exists. | The subscription already exists. |
400 | SubscriptionNotFound | The subscription is not found. | The subscription is not found. |
400 | NameAlreadyExists | The name already exists. | The specified name already exists. |
400 | DeliverExceedLimit | The maximum number of subscribed tasks is exceeded. | The number of tracking tasks has reached the upper limit. |
For a list of error codes, visit the Service error codes.