1. API Description
Domain name for API request: yunjing.tencentcloudapi.com.
This API is used to get the status of a real-time port pulling task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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 value used for this API: DescribeOpenPortTaskStatus. |
| Version |
Yes |
String |
Common parameter. The value used for this API: 2018-02-28. |
| Region |
No |
String |
Common parameter. This parameter is not required for this API. |
| Uuid |
Yes |
String |
CWP agent Uuid. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Status |
String |
Task status. COMPLETE: completed (at this point, you can call the DescribeOpenPorts API to get the list of real-time processes) AGENT_OFFLINE: CWP agent is offlineCOLLECTING: getting portFAILED: failed to get processes |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Getting the status of real-time port pulling task
This example shows you how to get the status of a real-time port pulling task.
https:
&Uuid=6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1
&<Common request parameters>
Output Example
{
"Response": {
"Status": "COMPLETE",
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
}
}
5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| FailedOperation.AgentOffline |
The agent is offline. |
| FailedOperation.OpenPortTaskNotFound |
The real-time port pulling task does not exist. |
| InternalError |
Internal error. |
| InvalidParameter.InvalidFormat |
Incorrect parameter format. |
| ResourceNotFound |
The resource does not exist. |