Updates a tracking task by task ID.
Operation description
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DeliverId | long | Yes | The ID of the tracking task that you want to update. | 92 |
Name | string | No | The name of the tracking task. | Domain name report |
Reports | string | No | The operations reports that are tracked by the task. The data needs to be escaped in JSON. | \[{\\"reportId\\":2,\\"conditions\\":\[{\\"field\\":\\"prov\\",\\"op\\":\\"in\\",\\"value\\":\[\\"Heilongjiang\\",\\"Beijing\\"]}]}] |
DomainName | string | No | The domain names from which the tracking task collects data. Separate domain names with commas (,). If you do not specify a domain name, the task collects data from all domain names that belong to your Alibaba Cloud account. | www.example.com |
Deliver | string | No | The method that is used to send operations reports. Operations reports are sent to you only by email. The settings need to be escaped in JSON. | {"email":{"subject":"the email subject","to":\["username@example.com","username@example.com"]}} |
Schedule | string | No | The parameters that specify the time interval at which the tracking task sends operations reports. The settings need to 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 of the Reports parameter |Parameter|Type|Required|Description |--------|------------------| |reportId|String|Yes|The ID of the report. | |conditions|ConDatas[]|No|The filter conditions for the report. |
Fields of the conditions parameter |Parameter|Type|Required|Description |--------|------------------| |field|String|No|The filter field. | |op|String|No|The filter action. Only in is supported. | |value|String[]|No|The array of field values. |
Fields of the Deliver parameter |Parameter|Type|Required|Description |--------|------------------| |subject|String|No|The email addresses to which operations reports are sent. | |to|String[]|Yes|The email addresses to which operations reports are sent. |
Fields of the Schedule parameter |Parameter|Type|Required|Description |--------|------------------| |schedName|String|No|The name of the tracking task. | |description|String|No|The description of the tracking task. | |crontab|String|Yes|Indicates when the tracking task is scheduled to run. | |frequency|String|Yes|The interval at which the reports are sent. Value:
h: hour
d: day
w: week| |status|String|No|The status of the tracking task. Valid values:
enable: enabled
disable: disabled | |effectiveFrom|String|No|The start time of the tracking task. | |effectiveEnd|String|No|The end time of the tracking task. |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | A parameter is set to an invalid value. |
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 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.
Change history
Change time | Summary of changes | Operation |
---|