ListOperationProcess API Reference - Security Center - Alibaba Cloud - Security Center

Queries a list of operation tasks.

Operation description

Currently, only check operation task queries are supported.

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

yundun-sas:ListOperationProcess

list

*OperationProcess

acs:yundun-sas:{#regionId}:{#accountId}:operationprocess/{#TaskId}

None

Request parameters

Parameter	Type	Required	Description	Example
TaskTypes	array	No	The task type. Valid values: CHECK_ALL: full check. CHECK_POLICY: check performed based on check items in the configured policy. CHECK_SCHEDULE: scheduled check. CHECK_ITEM: check performed based on specified check items. CHECK_INSTANCE: check performed based on specified check items and instances.
	string	No	The task type.	CHECK_POLICY
CurrentPage	integer	No	The page number of the current page to display in a paged query. This parameter is used for paging.	1
PageSize	integer	No	The number of entries per page.	20
StatusCodes	array	No	The list of task status codes.
	integer	No	The check task status code. Valid values: 0: not started. 1: checking. 2: check completed. 3: timed out.	0
StartTime	integer	No	The start time of the query based on the task creation time. Unit: milliseconds.	1680919232000
EndTime	integer	No	The end time of the query based on the task completion time. Unit: milliseconds.	1635575219000
TaskIds	array	No	The list of task IDs.
	string	No	The task ID.	3d7a1b68-599f-4e16-9b45-e920a183b***
TaskSources	array	No	The list of task sources.
	string	No	The task source. Valid values: YAO_CHI: ApsaraDB console.	YAO_CHI

Response elements

Element	Type	Description	Example
	object	ListOperationProcessResponse
Processes	array<object>	The list of operation task information.
	object	The operation task information.
TotalCount	integer	The total number of entries returned.	337
FinishCount	integer	The number of completed items.	197
TaskId	string	The ID of the operation task.	3d7a1b68-599f-4e16-9b45-e920a183b***
StatusCode	integer	The check task status code. Valid values: 0: not started. 1: checking. 2: check completed. 3: timed out.	1
TaskType	string	The task type. Valid values: CHECK_ALL: full check. CHECK_POLICY: check performed based on check items in the configured policy. CHECK_SCHEDULE: scheduled check. CHECK_ITEM: check performed based on specified check items. CHECK_INSTANCE: check performed based on specified check items and instances.	CHECK_POLICY
StartTime	integer	The start time of the task. Unit: milliseconds.	1705457102000
EndTime	integer	The end time of the task. Unit: milliseconds.	1705467559000
CreateTime	integer	The creation time of the task. Unit: milliseconds.	1674388824000
TaskSource	string	The task source. Valid values: YAO_CHI: ApsaraDB.	YAO_CHI
DetailTaskTotalCount	integer	The total number of subtasks.	10
DetailTaskReadyCount	integer	The number of completed subtasks.	5
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page to display in a paged query. This parameter is used for paging.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	263
Count	integer	The number of entries on the current page.	4
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.	F8B6F758-BCD4-597A-8A2C-DA5A552C****

Examples

Success response

JSON format

{
  "Processes": [
    {
      "TotalCount": 337,
      "FinishCount": 197,
      "TaskId": "3d7a1b68-599f-4e16-9b45-e920a183b***\n",
      "StatusCode": 1,
      "TaskType": "CHECK_POLICY",
      "StartTime": 1705457102000,
      "EndTime": 1705467559000,
      "CreateTime": 1674388824000,
      "TaskSource": "YAO_CHI",
      "DetailTaskTotalCount": 10,
      "DetailTaskReadyCount": 5
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 263,
    "Count": 4
  },
  "RequestId": "F8B6F758-BCD4-597A-8A2C-DA5A552C****"
}

Error codes

HTTP status code	Error code	Error message
400	CspmParamIllegal	The parameter is not legal. %s.
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.