Creates a tracking task. After you create a tracking task, the system sends operations reports to you by email on a regular basis.
Operation description
Each account can call this operation up to three times per second.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
Yes |
The name of the tracking task. |
Domain name report |
| Reports |
string |
Yes |
The operations reports that are tracked by the task. The data must be escaped in JSON. |
\[{\\"reportId\\":1,\\"conditions\\":\[{\\"field\\":\\"prov\\",\\"op\\":\\"in\\",\\"value\\":\[\\"Heilongjiang\\",\\"Beijing\\"]}]}] |
| DomainName |
string |
No |
The domain names to be tracked. Separate multiple domain names with commas (,). You can specify up to 500 domain names. If you want to specify more than 500 domain names, submit a ticket. Note
If you do not specify a domain name, the tracking task is created for all domain names that belong to your Alibaba Cloud account. |
www.example1.com,www.example2.com |
| Deliver |
string |
Yes |
The method that is used to send operations reports. Operations reports are sent to you only by email. The settings must be escaped in JSON. |
{"email":{"subject":"the email subject","to":\["username@example.com","username@example.org"]}} |
| Schedule |
string |
Yes |
The parameters that specify the time interval at which the tracking task sends operations reports. The settings must be escaped in JSON. |
{\\"schedName\\":\\"The name of the tracking task\\",\\"description\\":\\"The description\\",\\"crontab\\":\\"000\*\*?\\",\\"frequency\\":\\"d\\",\\"status\\":\\"enable\\",\\"effectiveFrom\\":\\"2020-09-17T00:00:00Z\\",\\"effectiveEnd\\":\\"2020-11-17T00:00:00Z\\"}" |
Fields in the ReDatas parameter
| Field | Type | Required | Description |
| reportId | String | Yes | The ID of the operations report. |
| conditions | ConDatas[] | No | The filter conditions for the report. |
Fields in the ConDatas parameter
| Field | Type | Required | Description |
| field | String | No | The filter field. |
| op | String | No | The filter operation. |
| value | String[] | No | The array of field values. |
Fields in the email parameter
| Field | Type | Required | Description |
| subject | String | Yes | The email subject. |
| to | String[] | Yes | The email addresses to which operations reports are sent. |
Fields in the Deliver parameter
| Field | Type | Required | Description |
| subject | String | No | The email subject. |
| to | String[] | Yes | The email addresses to which operations reports are sent. |
Fields in the Schedule parameter
| Field | Type | Required | Description |
| schedName | String | No | The name of the tracking task. |
| description | String | No | The description of the tracking task. |
| crontab | String | Yes | Specifies when the tracking task is scheduled to run. |
| frequency | String | Yes | The interval at which the reports are sent. Valid values: h: by hour d: by day w: by week |
| status | String | No | The status of the tracking task. Valid values : enable disable |
| effectiveFrom | String | No | The start time of the tracking task. |
| effectiveEnd | String | No | The end time of the tracking task. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| DeliverId |
string |
The ID of the tracking task. |
1025 |
| RequestId |
string |
The ID of the request. |
04F0F334-1335-436C-A1D7-6C044FE73368 |
Examples
Success response
JSON format
{
"DeliverId": "1025",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}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 | 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. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.