Help & DocumentationHost SecurityAPI documentationAsset Management-Related APIsDescribeProcessTaskStatus
Contents:
1. API Description
Domain name for API request: yunjing.tencentcloudapi.com.
This API (DescribeProcessTaskStatus) is used to obtain the status of the real-time pull process task.
Default request rate limit: 20/sec.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter. The valueused for this API: DescribeProcessTaskStatus |
Version | Yes | String | Common parameter. The value used for this API: 2/28/2018 |
Region | No | String | Common parameter. This parameter is not required for this API. |
Uuid | Yes | String | Unique Uuid of the HS client. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
Status | String | Task status. |
RequestId | String | The unique ID of a request, which is required for each troubleshooting case. |
4. Example
Example 1 Obtain the status of the real-time pull process task
Input example
https://yunjing.tencentcloudapi.com/?Action=DescribeProcessTaskStatus
&Uuid=6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1
&<Common request parameters>
Output example
{
"Response": {
"Status": "COMPLETE",
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
}
}
5. Resources for Developers
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using cloud APIs.
6. Error Codes
The following only lists the error codes related to this API. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.ProcessTaskNotFound | The task to pull real-time processes does not exist. |
InternalError | Internal error. |
InvalidParameter.IllegalRequest | Invalid request. |
InvalidParameter.InvalidFormat | Incorrect parameter format. |
InvalidParameter.ParsingError | Parameter parsing error. |
MissingParameter | A parameter is missing. |
ResourceNotFound | Resource does not exist. |