Use GetCheckProcess to query configuration check task progress - Security Center - Alibaba Cloud - Security Center

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the cloud service configuration check task to query. Note You can call the SubmitCheck operation to obtain this parameter.	5347c7b6-c85c-4070-846a-3029e08e****

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of assets to check.	113
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	D18B5DAD-BA97-5552-AE48-83F59D5F****
FinishCount	integer	The total number of assets that have been checked.	80
StatusCode	string	The status code of the Cloud Security Posture Management (CSPM) check task. Valid values: 0: The task is being initialized and the total number of tasks is being calculated. 1: The task is running. You can query the total number of tasks and the number of completed tasks. 2: The task is completed. 3: The task timed out. 4: The task is invalid. Check whether valid assets exist for detection. 5: No task record exists. Check whether the TaskId is correct.	1
TaskId	string	The ID of the cloud service configuration check task to query.	5347c7b6-c85c-4070-846a-3029e08e****

Examples

Success response

JSON format

{
  "TotalCount": 113,
  "RequestId": "D18B5DAD-BA97-5552-AE48-83F59D5F****",
  "FinishCount": 80,
  "StatusCode": "1",
  "TaskId": "5347c7b6-c85c-4070-846a-3029e08e****\n"
}

Error codes

HTTP status code	Error code	Error message	Description
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.