文档中心 主机安全 API 文档 资产管理相关接口 获取实时拉取进程任务状态

获取实时拉取进程任务状态

最近更新时间:2018-12-07 20:46:31

1. 接口描述

接口请求域名: yunjing.tencentcloudapi.com 。

本接口 (DescribeProcessTaskStatus) 用于获取实时拉取进程任务状态。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProcessTaskStatus
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,本接口不需要传递此参数。
Uuid String 云镜客户端唯一Uuid。

3. 输出参数

参数名称 类型 描述
Status String 任务状态。
  • COMPLETE:完成(此时可以调用DescribeProcesses接口获取实时进程列表)
  • AGENT_OFFLINE:云镜客户端离线
  • COLLECTING:进程获取中
  • FAILED:进程获取失败
  • RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取实时拉取进程任务状态

    输入示例

    https://yunjing.tencentcloudapi.com/?Action=DescribeProcessTaskStatus
    &Uuid=6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "Status": "COMPLETE"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    FailedOperation.ProcessTaskNotFound 拉取实时进程任务不存在。
    InternalError 内部错误
    InvalidParameter.IllegalRequest 非法请求。
    InvalidParameter.InvalidFormat 参数格式错误。
    InvalidParameter.ParsingError 参数解析错误。
    MissingParameter 缺少参数错误
    ResourceNotFound 资源不存在