Creates a tracking task that generates operations reports. The tracking task sends operations reports to a specified email address based on a specified schedule.
Operation Description
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All resourcesis used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
| Operate | access level | Resource type | conditional keyword | Association operation |
|---|---|---|---|---|
| cdn:CreateCdnDeliverTask | Read |
|
| without |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | string | Yes | The name of the tracking task. | Daily |
| Reports | string | Yes | The operations reports that are tracked by the task. The data must be escaped in JSON. | [{\"reportId\":1},{\"reportId\":13}] |
| 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. NoteIf you do not specify a domain name, the custom operations reports are 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\":{\"to\":[\"lyx@32hike.com\"]}} |
| 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. | {\"crontab\":\"00 00 08 * * ?\",\"frequency\":\"d\"} |
Fields of the ReDatas parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportId | String | Yes | The ID of the operations report. |
| conditions | ConDatas[] | No | The filter conditions for the operations report. |
Fields of the ConDatas parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| field | String | No | The filter field. |
| op | String | No | The filter operation. |
| value | String[] | No | The array of field values. |
Fields of the email parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| subject | String | Yes | The email subject. |
| to | String[] | Yes | The email addresses to which operations reports are sent. |
Fields of the Deliver parameter
| Parameter | 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
| 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 | The period during which the operations reports are tracked. |
| frequency | String | Yes | The interval at which the reports are sent. Valid values: h: every hour d: every day w: every 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
Example
Normal return example
JSONFormat
{
"DeliverId": "1025",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}Error codes
| Http 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. |
For a list of error codes, visit the API error center.