文档首页/ DevStar/ API参考/ API/ 应用管理/ 流水线模板列表查询
更新时间:2024-07-04 GMT+08:00
分享

流水线模板列表查询

功能介绍

流水线模板列表查询

调试

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

URI

GET /v1/pipeline-templates

表1 Query参数

参数

是否必选

参数类型

描述

region_id

String

区域id

offset

Integer

偏移量,表示从此偏移量开始查询,默认0

limit

Integer

每页显示的条目数量,默认10

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

X-Language

String

语言类型 中文:zh-cn 英文:en-us

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

templates

Array of PipelineTemplate objects

模板列表

count

Integer

模板总数

表4 PipelineTemplate

参数

参数类型

描述

name

String

模板名称

id

String

模板id

description

String

描述信息

region_id

String

区域id

url

String

预览链接

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

请求示例

请求uri示例

GET https://{endpoint}/v1/pipeline-templates?offset=0&limit=10&region_id=cn-north-4

响应示例

状态码: 400

Bad Request

{
  "error_code" : "DEVSTAR.1001",
  "error_msg" : "region_id : 非法参数"
}

状态码: 401

Unauthorized

{
  "error_code" : "DEV.00000001",
  "error_msg" : "未识别到用户认证信息"
}

状态码: 403

Forbidden

{
  "error_code" : "DEVSTAR.1034",
  "error_msg" : "无操作权限"
}

状态码: 404

Not Found

{
  "error_code" : "DEVSTAR.1037",
  "error_msg" : "模板不存在"
}

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档