文档首页/ 云运维中心 COC/ API参考/ API/ 作业管理/ 查询自定义作业列表
更新时间：2025-07-04 GMT+08:00
查看PDF
分享

查询自定义作业列表

功能介绍

查询自定义作业列表。

接口约束

只能查询本账号下的自定义作业。

调试

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

URI

GET /v1/documents

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

分页参数：每页返回记录个数限制。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

String

参数解释：

偏移量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name_like

否

String

参数解释：

作业名（模糊）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

creator

否

String

参数解释：

创建人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

document_type

否

String

参数解释：

执行的作业类型值。

约束限制：

  • 取值：PUBLIC/NORMAL

  • 默认值：NORMAL

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

total

Long

参数解释：

总条数。

取值范围：

不涉及。

data

Array of DocumentListVo objects

参数解释：

作业列表数据。

取值范围：

不涉及。
表3 DocumentListVo

参数

参数类型

描述

document_id

String

参数解释：

作业uuid。

取值范围：

不涉及。

name

String

参数解释：

作业名称。

取值范围：

不涉及。

create_time

String

参数解释：

创建时间。

取值范围：

不涉及。

update_time

String

参数解释：

更新时间。

取值范围：

不涉及。

version

String

参数解释：

作业版本，如v1。

取值范围：

不涉及。

creator

String

参数解释：

创建人。

取值范围：

不涉及。

modifier

String

参数解释：

修改人。

取值范围：

不涉及。

enterprise_project_id

String

参数解释：

企业项目id。

取值范围：

不涉及。

请求示例

查询自定义作业列表。

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

响应示例

状态码：200

成功查询自定义作业列表。

{
  "data" : [ {
    "document_id" : "DM2025063021170101xxxxx",
    "name" : "qweqwe",
    "create_time" : 1751289421846,
    "update_time" : 1751289421846,
    "version" : "v1",
    "creator" : "COC-xxxxx",
    "modifier" : null,
    "enterprise_project_id" : "0",
    "risk_level" : "HIGH"
  }, {
    "document_id" : "DM20250604143026019xxxxx",
    "name" : "cfm-job-new-0604001",
    "create_time" : 1749018626043,
    "update_time" : 1751075577067,
    "version" : "v3",
    "creator" : "COC-xxxxx",
    "modifier" : "COC-xxxxx",
    "enterprise_project_id" : "0",
    "risk_level" : "LOW"
  } ],
  "total" : 74
}

状态码

状态码

描述

200

成功查询自定义作业列表。

错误码

请参见错误码。

父主题： 作业管理

相关文档