All Products
Search
Document Center

Security Center:GetCheckProcess

Last Updated:Nov 25, 2024

Queries the progress of a configuration check task on cloud services.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:GetCheckProcessget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringNo

The ID of the task.

Note You can call the SubmitCheck operation to query the ID.
5347c7b6-c85c-4070-846a-3029e08e****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of assets on which the task is performed.

113
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

D18B5DAD-BA97-5552-AE48-83F59D5F****
FinishCountinteger

The total number of assets on which the task is complete.

80
StatusCodestring

The status code of the Cloud Security Posture Management (CSPM) task. Valid values:

  • 0: The task is being initialized. The system is calculating the total number of subtasks.
  • 1: The task is being executed. You can query the total number of tasks and the number of completed tasks.
  • 2: The task is successful.
  • 3: The task times out.
  • 4: The task is invalid. Check whether assets exist.
  • 5: No task record is found. Check whether the TaskId parameter is valid.
1
TaskIdstring

The ID of the task.

5347c7b6-c85c-4070-846a-3029e08e****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-26The response structure of the API has changedView Change Details
2023-01-11API Description Update. The API operation is not deprecated.View Change Details