文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 脚本/ 查询脚本任务列表
更新时间：2025-01-03 GMT+08:00
查看PDF
分享

查询脚本任务列表

功能介绍

查询脚本任务列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/script-execution-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询的偏移量。

limit

否

Integer

单次查询的大小[1-100]。

resource_group_id

否

Array of strings

执行脚本的资源组ID。

script_id

否

String

脚本ID。

script_name

否

String

脚本名。

status

否

String

执行情况。

resource_group_type

否

String

资源组类型。

task_id

否

Array of strings

执行脚本的任务ID。

task_type

否

String

任务类型(SCRIPT/COMMAND)。

execute_time_start

否

String

按执行时间查询的起始时间。指定该参数后，返回的结果为此时间之后的所有任务记录。时间格式如：“2021-10-01T12:00:00Z”。

execute_time_end

否

String

按执行时间查询的终止时间。指定该参数后，返回的结果为此时间之前的所有任务记录。时间格式如：“2021-10-01T12:00:00Z”。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

script_tasks

Array of ScriptTaskInfo objects

脚本任务列表。
表5 ScriptTaskInfo

参数

参数类型

描述

id

String

脚本任务ID。

task_scripts

Array of task_scripts objects

脚本列表。

resource_type

String

资源类型，如DESKTOP。

resource_ids

Array of strings

执行脚本的资源ID列表。

gray_resource_ids

Array of strings

灰度批次执行资源ID列表。

success_num

Integer

task中成功的执行记录数量。

failed_num

Integer

task中失败的执行记录数量。

skip_num

Integer

task中跳过的执行记录数量。

start_time

String

脚本执行开始时间。

end_time

String

脚本执行结束时间。

status

String

任务结果。
表6 task_scripts

参数

参数类型

描述

id

String

脚本ID。

name

String

脚本名称。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码： 200

成功响应。

{
  "count" : 0,
  "script_tasks" : [ {
    "id" : "sawafaw12414214awfa",
    "task_scripts" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "command_content" : "string",
    "command_type" : "string",
    "resource_type" : "string",
    "resource_group_id" : "string",
    "resource_group_type" : "string",
    "resource_ids" : [ "string" ],
    "gray_resource_ids" : [ "string" ],
    "pre_start" : "string",
    "post_finish" : "string",
    "success_num" : 0,
    "failed_num" : 0,
    "skip_num" : 0,
    "start_time" : "2024-12-25T07:11:02.540Z",
    "end_time" : "2024-12-25T07:11:02.540Z",
    "status" : "string"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 脚本