Creates a tracking task. After you create a tracking task, the system periodically sends operations reports to you by email.
Operation description
**
**You can call this operation up to three times per second.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dcdn:CreateDcdnDeliverTask | create | *DeliverTask acs:dcdn:*:{#accountId}:domain/{#domainName} |
| none |
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\\":2,\\"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.
| example.com,example.org |
| 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 of the Reports parameter
| Field | Type | Required | Description |
|---|---|---|---|
| reportId | String | Yes | The ID of the operations report. |
| conditions | ConDatas[] | No | The filter conditions for the report. |
Fields of the conditions parameter
| Field | 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
| Field | Type | Required | Description |
|---|---|---|---|
| subject | String | No | The email subject. |
| to | String[] | Yes | The email addresses to which operations reports are sent. |
Fields of 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 | The period during which the operations reports are tracked. |
| 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 and disable. |
| 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
JSONformat
{
"DeliverId": "92",
"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 | 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 |
|---|