DescribeDcdnDeliverList - 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:DescribeDcdnDeliverList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DeliverId	integer	No	The ID of the tracking task that you want to query. If you do not specify this parameter, all tracking tasks are returned.	92

Response parameters

Parameter	Type	Description	Example
	object
Content	string	The data of the tracking task list.	"data": \[{"deliverId": 1,"status": "enable","createTime": "2021-06-14T11:19:26Z","crontab": "0 0 0 \* \* ?","frequency": "d","name": "Domain name report","dmList": \["www.example.com"],"reports": \[{"reportId": 1,"conditions": \[{"op": "in","field": "prov","value": \["Heilongjiang","Beijing"]}]},{"reportId": 2}],"deliver": {"email": {"subject": "subject","to": \["username@example.com","username@example.org"],"copy":\["username@example.com","username@example.org"]}}}]}
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Description of the Content parameter

Parameter	Type	Description
deliverId	Long	The ID of the tracking task.
status	String	The status of the tracking task. Valid values: enable: The task is enabled. disable: The task is disabled.
createTime	String	The time when the tracking task was created.
crontab	String	The execution schedule of the tracking task.
frequency	String	The execution frequency. Valid values: h: hour d: day M: month
name	String	The name of the tracking task.
dmList	String[]	The list of domain names for the tracking task.
reports	String[]	The list of subscribed reports. This parameter contains the following subparameters: reportId: The ID of the report. conditions: The filter conditions for the report. This parameter is empty if no filter conditions are specified. A filter condition consists of the following parts: op (the filter operator, only in is supported), field (the filter field), and value (the filter value).
deliver	String	The delivery module, which contains information such as the email subject and recipients. email: The email delivery details. subject: The email subject. to: The list of recipients. copy: The list of CC recipients.

Examples

Success response

JSON format

{
  "Content": "\"data\": \\[{\"deliverId\": 1,\"status\": \"enable\",\"createTime\": \"2021-06-14T11:19:26Z\",\"crontab\": \"0 0 0 \\* \\* ?\",\"frequency\": \"d\",\"name\": \"Domain name report\",\"dmList\": \\[\"www.example.com\"],\"reports\": \\[{\"reportId\": 1,\"conditions\": \\[{\"op\": \"in\",\"field\": \"prov\",\"value\": \\[\"Heilongjiang\",\"Beijing\"]}]},{\"reportId\": 2}],\"deliver\": {\"email\": {\"subject\": \"subject\",\"to\": \\[\"username@example.com\",\"username@example.org\"],\"copy\":\\[\"username@example.com\",\"username@example.org\"]}}}]}\n",
  "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	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 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.