CreateEcdReportTask-阿里云帮助中心

Creates a task to export a data report.

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

ecd:CreateEcdReportTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskType	string	Yes	The type of the report task. Valid values: RESOURCE_REPORT : A resource report.	RESOURCE_REPORT
SubType	string	Yes	The subtype of the report task. Valid values: DESKTOP : A cloud computer report.	DESKTOP
FilterList	array<object>	No	The filter conditions for the query. The conditions are joined by the logical AND operator. Each condition contains a `FilterKey` and its corresponding `FilterValues`.
	object	No	The filter condition object.
FilterKey	string	No	The filter key. When `SubType` is set to `DESKTOP` (for a cloud computer report), the following filter keys are available: * KeyWord: a keyword for the cloud computer (automatically recognizes multiple resource attributes) * RegionId: the region ID * DesktopId: the cloud computer ID * DesktopName: the cloud computer name (supports fuzzy search) * OfficeSiteId: the office network ID * OfficeSiteName: the office network name (supports fuzzy search) * Status: the status of the cloud computer * DesktopType: the desktop type * DesktopIP: the IP address of the cloud computer * SubPayType: the billing method * EndUserId: the user name (supports fuzzy search) * ExpireTime: the expiration time in the `yyyy-MM-dd'T'HH:mm:ss'Z'` format * IncludeAssignedUser: whether to include cloud computers that are assigned to users. Valid values: `true` and `false`. * ResourceGroupId: the resource group ID * PolicyId: the policy ID * Tag:<TagKey>: a tag of the cloud computer. Replace `<TagKey>` with your tag key. To filter by multiple tags, use a separate filter object for each.	Tag:TestKey
FilterValues	array	No	An array of values for the specified filter key. For the following `FilterKey` values, only the first value in the array is used: * KeyWord * DesktopName * OfficeSiteName * DesktopIP * EndUserId * ExpireTime * IncludeAssignedUser
	string	No	A value for the specified filter key.	测试云电脑名称
ReportFileName	string	No	The report file name.	测试报表名称
LangType	string	No	The language of the report. Valid values: zh-CN : Simplified Chinese en-GB : English	zh-CN

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Success	boolean	Indicates whether the operation was successful.	True
Code	string	The result code of the operation. A value of `success` indicates a successful request. Otherwise, an error code is returned.	success
Message	string	The error message. This parameter is not returned when `Code` is `success`.	success
TaskId	string	The report task ID.	ret-g67ip******

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Success": true,
  "Code": "success",
  "Message": "success",
  "TaskId": "ret-g67ip******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.