文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 构建API/ 根据组件名称获取构建任务列表
更新时间：2024-10-11 GMT+08:00
查看PDF
分享

根据组件名称获取构建任务列表

功能介绍

此API用于根据组件名称获取构建任务列表。

URI

GET /assembling/v1/jobs?page={page}&per_page={per_page}&job_name={job_name}

参数说明见表1。

表1 路径参数

参数

是否必选

参数类型

描述

page

是

Integer

分页索引，表示从第几页开始。

per_page

是

Integer

分页大小，表示一页包含几条记录。

job_name

否

String

构建任务名称，和用户定义的组件名称相同。获取方法，请参考获取应用所有组件。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息

表3 响应参数

参数

参数类型

描述

list

Array of object

构建阶段结构体，请参考表4。

total

Integer

构建阶段数量。

page

Integer

分页大小，表示一页包含几条记录。

per_page

Integer

分页索引，表示从第几页开始。
表4 list

参数

参数类型

描述

job_id

String

构建任务标识。

job_name

String

构建任务名称，和用户定义的组件名称相同。

请求示例

无

响应示例

{
    "total": 12,
    "per_page": 6,
    "page": 1,
    "list": [
        {
            "job_id": "swpfk3wtzdjnlyely4rf40k52zyuq5s4lha9ch8f",
            "job_name": "test1"
        }
    ]
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

错误码

错误码格式为：SVCSTG.CPE.[Error_ID]，例如：SVCSTG.CPE.5004401。错误码说明请参考ServiceStage错误码。

父主题： 构建API

相关文档