tencent cloud

该页面目前只支持英文,你浏览的语言正在准备中。
关闭
全部产品文档
主机安全
DescribeProcessTaskStatus
最后更新时间:2020-07-31 11:18:58
DescribeProcessTaskStatus
最后更新时间: 2020-07-31 11:18:58

1. API Description

Domain name for API request: yunjing.tencentcloudapi.com.

This API is used to get the status of a real-time process 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.

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 value used for this API: DescribeProcessTaskStatus.
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 DescribeProcesses API to get the list of real-time processes)
  • AGENT_OFFLINE: CWP agent is offline
  • COLLECTING: getting process
  • FAILED: 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 process pulling task

    This example shows you how to get the status of a real-time process pulling 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. 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.ProcessTaskNotFound The real-time process pulling task does not exist.
    InternalError Internal error.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.ParsingError Parameter parsing error.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    本页内容是否解决了您的问题?
    您也可以 联系销售 提交工单 以寻求帮助。

    文档反馈

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持
    中国香港
    +852 800 906 020 (免费)
    美国
    +1 844 606 0804 (免费)
    英国
    +44 808 196 4551 (免费)
    加拿大
    +1 888 605 7930 (免费)
    澳大利亚
    +61 1300 986 386 (免费)
    EdgeOne 热线
    +852 300 80699
    更多本地服务热线陆续新增中