Use UpdateCdnDeliverTask to update a tracking task - CDN

Operation description

Note

Each account can call this operation up to three times per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:UpdateCdnDeliverTask

update

*DeliverTask

acs:cdn:*:{#accountId}:delivertask/{#DeliverId}

None

Request parameters

Parameter	Type	Required	Description	Example
DeliverId	integer	Yes	The ID of the tracking task that you want to update.	3
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 must be escaped in JSON.	\[{\\"reportId\\":1,\\"conditions\\":\[{\\"field\\":\\"prov\\",\\"op\\":\\"in\\",\\"value\\":\[\\"Heilongjiang\\",\\"Beijing\\"]}]}]
DomainName	string	No	The domain name that you want to track. You can specify up to 500 domain names in each request. Separate multiple 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 must be escaped in JSON.	{\\"email\\":{\\"subject\\":\\"The email subject\\",\\"to\\":\[\\"songmingyuan@alibaba-inc.com\\",\\"songmingyuan@alibaba-inc.com\\"]}}"
Schedule	string	No	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 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 the cycle in which 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
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.