CreateDcdnDeliverTask - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

The throttling limit for a single user is 3 calls 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

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	A list of reports to which you want to subscribe. The value must be a JSON-escaped string.	\[{\\"reportId\\":2,\\"conditions\\":\[{\\"field\\":\\"prov\\",\\"op\\":\\"in\\",\\"value\\":\[\\"Heilongjiang\\",\\"Beijing\\"]}]}]
DomainName	string	No	The domain names for the subscription. Separate multiple domain names with commas (,). The maximum number of domain names for a subscription is 500. To subscribe to more than 500 domain names, submit a ticket. Note If you do not specify this parameter, reports for all domain names that are associated with your account are delivered by default.	example.com,example.org
Deliver	string	Yes	The method used to send reports. Only email is supported. The value must be a JSON-escaped string.	{"email":{"subject":"the email subject","to":\["username@example.com","username@example.org"]}}
Schedule	string	Yes	The parameters for the subscription cycle. The value must be a JSON-escaped string.	{"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"}

Reports

Parameter	Type	Required	Description
reportId	String	Yes	The report ID.
conditions	ConDatas[]	No	The filter conditions for the report.

Conditions

Parameter	Type	Required	Description
field	String	No	The filter field.
op	String	No	The filter operator. Only in is supported.
value	String[]	No	An array of field values.

Deliver

Parameter	Type	Required	Description
subject	String	No	The subject of the subscription email.
to	String[]	Yes	An array of recipient email addresses.

Schedule

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 execution cycle of the tracking task.
frequency	String	Yes	The execution frequency. Valid values: h: hour d: day w: week
status	String	No	The status of the tracking task. Valid values: enable: The task is enabled. disable: The task is disabled.
effectiveFrom	String	No	The start time of the delivery task.
effectiveEnd	String	No	The end time of the delivery task.

Response parameters

Parameter	Type	Description	Example
	object
DeliverId	string	The ID of the tracking task.	92
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.