Tenant Cloud Security Cloud Workload Protection Platform Vulnerability Management APIs DescribeScanSchedule

DescribeScanSchedule

Last Updated At: 2026-08-02 00:05:05

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to query the check progress of a task based on a task ID.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-05-20 15:13:13.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeScanSchedule
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
TaskId Yes No Uint64 Task ID.
Example: 1

3. Output Parameters

Parameter name Type Description
Schedule Uint64 Check progress.
Example: 1
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InternalError Internal error.
InvalidParameter.ParsingError Parameter parsing error.
InvalidParameter.MissingParameter Missing parameter.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.