文档首页/云运维中心 COC/API参考/API/作业管理/查询作业工单列表 - ListExecutions
更新时间：2025-11-03 GMT+08:00
查看PDF
分享

查询作业工单列表 - ListExecutions

功能介绍

查询用户作业工单列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    coc:execution:list

    List

    -

    -

    -

    -

URI

GET /v1/executions

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

分页参数。

约束限制：

每页返回记录个数限制，不传默认第一页查10个。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Long

参数解释：

分页参数。

约束限制：

从offset指定的下一条数据开始查询，不传默认0。

取值范围：

不涉及。

默认取值：

不涉及。

creator

否

String

参数解释：

创建人，模糊查询。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

start_time

否

Long

参数解释：

开始时间，大于。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

否

Long

参数解释：

结束时间，小于。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

document_name

否

String

参数解释：

作业名称，模糊查询。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

document_id

否

String

参数解释：

作业id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

tags

否

String

参数解释：

标签过滤条件，例：？tags=key1=value1，key2=value2。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

exclude_child_executions

否

Boolean

参数解释：

列表查询不返回子工单。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

data

Array of data objects

参数解释：

返回数据。

取值范围：

不涉及。

total

Long

参数解释：

总数。

取值范围：

不涉及。

表3 data

参数

参数类型

描述

id

String

参数解释：

id。

取值范围：

不涉及。

execution_id

String

参数解释：

工单唯一id。

取值范围：

不涉及。

document_name

String

参数解释：

作业名称。

取值范围：

不涉及。

document_id

String

参数解释：

作业id。

取值范围：

不涉及。

document_version_id

String

参数解释：

作业版本id。

取值范围：

不涉及。

document_version

String

参数解释：

作业版本号。

取值范围：

不涉及。

start_time

Long

参数解释：

工单执行开始时间。

取值范围：

不涉及。

end_time

Long

参数解释：

工单执行结束时间。

取值范围：

不涉及。

update_time

Long

参数解释：

工单更新时间。

取值范围：

不涉及。

creator

String

参数解释：

工单创建时间。

取值范围：

不涉及。

status

String

参数解释：

工单状态。

取值范围：

  • Pending：暂停。

  • Running：运行中。

  • Succeed：成功。

  • Canceling：取消中。

  • Canceled：取消。

  • Failed：失败。

  • Timeout：超时。

description

String

参数解释：

工单执行描述。

取值范围：

不涉及。

parameters

Array of parameters objects

参数解释：

工单执行全局参数。

取值范围：

不涉及。

sys_tags

Array of sys_tags objects

参数解释：

系统标签列表。

取值范围：

不涉及。

tags

Array of tags objects

参数解释：

自定义标签列表。

取值范围：

不涉及。

type

String

参数解释：

工单类型。

  • BATCH：分批模式。

  • RATE_CONTROL：速率控制模式。

  • NORMAL：正常模式。

取值范围：

  • BATCH：分批模式。

  • RATE_CONTROL：速率控制模式。

  • NORMAL：正常模式。

target_parameter_name

String

参数解释：

速率模式执行指定参数。

取值范围：

不涉及。

targets

Array of Target objects

参数解释：

速率模式执行指定元素。

取值范围：

不涉及。

表4 parameters

参数

参数类型

描述

key

String

参数解释：

参数名。

取值范围：

不涉及。

value

String

参数解释：

参数值。

取值范围：

不涉及。

表5 sys_tags

参数

参数类型

描述

key

String

参数解释：

标签的key。

取值范围：

不涉及，用户定义。

value

String

参数解释：

标签的value。

取值范围：

不涉及。

表6 tags

参数

参数类型

描述

key

String

参数解释：

标签的key。

取值范围：

不涉及。

value

String

参数解释：

标签的value。

取值范围：

不涉及。

表7 Target

参数

参数类型

描述

key

String

参数解释：

速率模式执行类型，InstanceValues。

取值范围：

  • InstanceValues：实例模式。

  • BatchValues：批次模式。

values

Array of objects

参数解释：

速率模式执行元素，目前只支持cmdb资源。

取值范围：

不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

参见错误码章节。

error_msg

String

参数解释：

错误描述。

取值范围：

参见错误码章节。

请求示例

查询作业工单列表。

GET https://{Endpoint}/v1/executions?offset=0&limit=2

响应示例

状态码：200

请求成功。

{
  "data" : [ {
    "id" : 3025,
    "execution_id" : "EX2025070121014xxxxxxx",
    "type" : "NORMAL",
    "document_name" : "test_document",
    "document_id" : "DM202507011802390xxxxxxx",
    "document_version_id" : "573634e7-5e69-4b4b-b4a1-b7xxxxxxx",
    "document_version" : "v2",
    "start_time" : 1751374905000,
    "end_time" : null,
    "update_time" : 1751374905000,
    "status" : "Pending",
    "description" : null,
    "parameters" : [ ],
    "target_parameter_name" : null,
    "targets" : null,
    "creator" : "COC-Script",
    "tags" : [ ],
    "sys_tags" : [ ]
  }, {
    "id" : 3024,
    "execution_id" : "EX2025063021172xxxxxxx",
    "type" : "NORMAL",
    "document_name" : "qweqwe",
    "document_id" : "DM202506302117010xxxxxxx",
    "document_version_id" : "6b3a059d-2cca-4bb0-82c0-e9xxxxxxx",
    "document_version" : "v1",
    "start_time" : 1751289441000,
    "end_time" : 1751289511000,
    "update_time" : 1751289512000,
    "status" : "Succeeded",
    "description" : null,
    "parameters" : [ {
      "key" : "aaa",
      "value" : "[\"qwe\",\"rew\"]"
    } ],
    "target_parameter_name" : null,
    "targets" : null,
    "creator" : "COC-Script",
    "tags" : [ ],
    "sys_tags" : [ ]
  } ],
  "total" : 718
}

状态码

状态码

描述

200

请求成功。

400

包含错误信息。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题：作业管理

相关文档