DescribeOnceTask - 查询客户端任务列表 - 云安全中心

查询客户端任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeOnceTask	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
TaskType	string	否	任务类型。取值： CLIENT_PROBLEM_CHECK：客户端任务 CLIENT_DEV_OPS：云运维任务 ASSET_SECURITY_CHECK：资产采集任务说明 TaskType 和 RootTaskId 不能同时为空	CLIENT_PROBLEM_CHECK
RootTaskId	string	否	根任务 ID。说明 TaskType 和 RootTaskId 不能同时为空	bb5d657479bba5e1d308b6c9e85c9174
StartTimeQuery	long	否	根任务开始的时间戳。单位为毫秒。	1651737301000
EndTimeQuery	long	否	根任务结束的时间戳。单位为毫秒。	1651766520000
CurrentPage	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
PageSize	integer	否	设置分页查询时，每页包含的客户端任务的数量。默认值为 20，表示每页包含 20 个客户端任务。	20
Source	string	否	任务来源。取值包括但不限于： schedule：漏洞扫描自动调度 console：漏洞扫描控制台一键检测	console
TaskId	string	否	任务 ID。	d7b2acf8d362742123e4a84e1bf8****

返回参数

名称	类型	描述	示例值
	object	客户端任务返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	7E0618A9-D5EF-4220-9471-C42B5E92719F
PageInfo	object	分页信息。
CurrentPage	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，每页包含的客户端任务的数量。默认值为 20，表示每页包含 20 个客户端任务。	20
TotalCount	integer	查询到的客户端任务的总条数。	100
Count	integer	分页查询时，当前页面显示的客户端任务条数。	2
TaskManageResponseList	array<object>	客户端任务查询的返回信息列表。
TaskManageResponse	object	客户端任务查询的返回信息。
TaskType	string	任务类型。取值： CLIENT_PROBLEM_CHECK：客户端任务 CLIENT_DEV_OPS：云运维任务 ASSET_SECURITY_CHECK：资产采集任务	CLIENT_PROBLEM_CHECK
Progress	string	任务进度，单位为百分比。	10%
TaskStatus	integer	任务状态。取值： 1：已启动。 2：已完成。 3：已失败。 4：已超时。	1
DetailData	string	任务执行详情。该参数为 JSON 格式。 causeCode：排查原因返回码。 causeMsg：排查原因返回信息。 resCode：排查返回码。 resMsg：排查返回信息。 problemType：问题类型。 dispatchType：任务下发方式。 uuid：服务器 UUID。 instanceId：服务器实例的 ID。 internetIp：服务器外网 IP。 intranetIp：服务器的私网 IP 地址。 instanceName：服务器实例的名称。 url：排查日志下载链接。	[ { "dispatchType": "manual", "causeMsg": [], "causeCode": [], "resCode": [ "1003" ], "resMsg": [ "powershell -executionpolicy bypass -c \"(New-Object Net.WebClient).DownloadFile('http://aegis.alicdn.com/download/aegis_client_self_check/win32/aegis_checker.exe', $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath('.\\\\aegis_checker.exe'))\"; \"./aegis_checker.exe -b eyJtb2RlIjoxLCJqc3J2X2RvbWFpbiI6W10sImlzc3VlIjoib2ZmbGluZSIsInVwZGF0ZV9kb21haW4iOltdLCJ1dWlkIjoiaW5ldC1lYWUwNDg2Ny0wMDJmLTQyM2QtYWYwMC1jNzJjZDYyOWIyNDgiLCJjbWRfaWR4IjoiNDRjZThiZWI3ZGYyYTQxMjQ1NGM4ZDc5OTE1ODI1MzMifQ==\"" ], "problemType": "offline", "uuid": "inet-eae04867-002f-423d-af00-c72cd629****" } ]
TaskStatusText	string	任务状态的文本对象。取值： INIT：待启动。 START：已启动。 DISPATCH：自检命令已下发。 SUCCESS：自检完成。 FAIL：执行失败。 TIMEOUT：已超时。	INIT
TaskName	string	任务名称。	CLIENT_PROBLEM_CHECK
TaskStartTime	long	任务实际开始的时间戳。单位为毫秒。	1649732012000
TaskEndTime	long	任务实际结束的时间戳。单位为毫秒。	1650267989000
TaskId	string	任务 ID。	e900f528f5a6229bb640ca27cb44c98e
SuccessCount	integer	执行成功的任务数。	7
FailCount	integer	执行失败的任务数。	2
ResultInfo	string	任务执行结果。	successful

示例

正常返回示例

JSON格式

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 2
  },
  "TaskManageResponseList": [
    {
      "TaskType": "CLIENT_PROBLEM_CHECK",
      "Progress": "10%",
      "TaskStatus": 1,
      "DetailData": "[\n      {\n            \"dispatchType\": \"manual\",\n            \"causeMsg\": [],\n            \"causeCode\": [],\n            \"resCode\": [\n                  \"1003\"\n            ],\n            \"resMsg\": [\n                  \"powershell -executionpolicy bypass -c \\\"(New-Object Net.WebClient).DownloadFile('http://aegis.alicdn.com/download/aegis_client_self_check/win32/aegis_checker.exe', $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath('.\\\\\\\\aegis_checker.exe'))\\\"; \\\"./aegis_checker.exe -b eyJtb2RlIjoxLCJqc3J2X2RvbWFpbiI6W10sImlzc3VlIjoib2ZmbGluZSIsInVwZGF0ZV9kb21haW4iOltdLCJ1dWlkIjoiaW5ldC1lYWUwNDg2Ny0wMDJmLTQyM2QtYWYwMC1jNzJjZDYyOWIyNDgiLCJjbWRfaWR4IjoiNDRjZThiZWI3ZGYyYTQxMjQ1NGM4ZDc5OTE1ODI1MzMifQ==\\\"\"\n            ],\n            \"problemType\": \"offline\",\n            \"uuid\": \"inet-eae04867-002f-423d-af00-c72cd629****\"\n      }\n]",
      "TaskStatusText": "INIT",
      "TaskName": "CLIENT_PROBLEM_CHECK",
      "TaskStartTime": 1649732012000,
      "TaskEndTime": 1650267989000,
      "TaskId": "e900f528f5a6229bb640ca27cb44c98e",
      "SuccessCount": 7,
      "FailCount": 2,
      "ResultInfo": "successful"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-08	OpenAPI 入参发生变更	查看变更详情