DescribeDcdnSubList - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

By default, this operation returns all customized reports. However, only one customized report task is returned in each response.
The call frequency for a single user is limited to 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:DescribeDcdnSubList

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Parameter	Type	Description	Example
	object
Content	string	The customized report task.	"data": [{"subId": 336,"reportId": [6,8],"createTime": "2021-07-05T06:18:46Z","domains": ["example.com"],"effectiveFrom": "2021-07-05T06:18:46Z","effectiveEnd": "2021-10-05T06:18:46Z","status": "enable"}]
RequestId	string	The request ID.	3250A51D-C11D-46BA-B6B3-95348EEDE652

Content data

Parameter	Type	Description
subId	Long	The ID of the subscription task.
reportId	Long[]	The list of report IDs.
createTime	String	The time when the report was created.
domains	String[]	The list of domain names for the customized report.
effectiveFrom	String	The start time of the customized task.
effectiveEnd	String	The end time of the customized task.
status	String	The status of the customized task. Valid values: enable: The task is enabled. disable: The task is shut down.

Examples

Success response

JSON format

{
  "Content": "\"data\": [{\"subId\": 336,\"reportId\": [6,8],\"createTime\": \"2021-07-05T06:18:46Z\",\"domains\": [\"example.com\"],\"effectiveFrom\": \"2021-07-05T06:18:46Z\",\"effectiveEnd\": \"2021-10-05T06:18:46Z\",\"status\": \"enable\"}]",
  "RequestId": "3250A51D-C11D-46BA-B6B3-95348EEDE652"
}

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.