All Products
Search
Document Center

Dynamic Content Delivery Network:CreateDcdnDeliverTask

Last Updated:Mar 01, 2024

Creates a tracking task. After you create a tracking task, the system periodically sends operations reports to you by email.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:CreateDcdnDeliverTaskWrite
  • DeliverTask
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

The name of the tracking task.

Domain name report
ReportsstringYes

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"]}]}]
DomainNamestringNo

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
DeliverstringYes

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"]}}
SchedulestringYes

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 Reports parameter

FieldTypeRequiredDescription
reportIdStringYesThe ID of the operations report.
conditionsConDatas[]NoThe filter conditions for the report.

Fields in the conditions parameter

FieldTypeRequiredDescription
fieldStringNoThe filter field.
opStringNoThe filter action. Only in is supported.
valueString[]NoThe array of field values.

Fields in the Deliver parameter

FieldTypeRequiredDescription
subjectStringNoThe email subject.
toString[]YesThe email addresses to which operations reports are sent.

Fields in the Schedule parameter

FieldTypeRequiredDescription
schedNameStringNoThe name of the tracking task.
descriptionStringNoThe description of the tracking task.
crontabStringYesSpecifies when the tracking task is scheduled to run.
frequencyStringYesThe interval at which the reports are sent. Valid values:h: by hourd: by dayw: by week
statusStringNoThe status of the tracking task. Valid values:enabledisable
effectiveFromStringNoThe start time of the tracking task.
effectiveEndStringNoThe end time of the tracking task.

Response parameters

ParameterTypeDescriptionExample
object
DeliverIdstring

The ID of the tracking task.

92
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

{
  "DeliverId": "92",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.A parameter is set to an invalid value.
400TimeParseFailedFailed to parse the time parameter.Failed to parse the time parameter.
400SubscriptionNotFoundThe subscription is not found.The subscription is not found.
400NameAlreadyExistsThe name already exists.The name already exists.
400DeliverExceedLimitThe 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 timeSummary of changesOperation
No change history