模板仓列表
功能介绍
模板仓列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repository-templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
platform |
否 |
String |
参数解释: 应用类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
pipeline |
否 |
String |
参数解释: 是否支持自动创建流水线。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 枚举值:
|
type |
是 |
String |
参数解释: 自动创建流水线。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 枚举值:
|
search |
否 |
String |
参数解释: 查询关键字,按模板仓标题搜索。 约束限制: 不涉及 取值范围: 字符串长度0至50。 默认取值: 不涉及 |
enter_type |
否 |
String |
参数解释: 参赛类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
date_order |
否 |
String |
参数解释: 按照模板仓的创建时间进行排序。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 枚举值:
|
language |
否 |
String |
参数解释: 编程语言。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
project_id |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 约束限制: 当该参数不为空时,仅返回当前项目下符合搜索条件的模版仓 取值范围: 字符串长度32。 取值范围: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
当前请求的结果总条数 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of RepositoryTemplateDto objects |
模板仓列表 |
参数 |
参数类型 |
描述 |
---|---|---|
repository_id |
Integer |
参数解释: 仓库Id。 取值范围: 1-2147483647 |
name |
String |
参数解释: 模板仓标题。 取值范围: 字符串长度1-50。 |
system |
Boolean |
参数解释: 是否是系统模版。 取值范围:
|
tags |
Array of strings |
参数解释: 标签列表。 取值范围: 不涉及。 |
description |
String |
参数解释: 仓库描述信息。 取值范围: 字符串长度0-2000。 |
language |
String |
参数解释: 编程语言。 取值范围: 字符串长度0-32。 |
repository_name |
String |
参数解释: 模板仓的仓库名称。 取值范围: 字符串长度0-255。 |
brief_introduction |
String |
参数解释: 模板仓的简介。 取值范围: 字符串长度0-32。 |
created_at |
String |
参数解释: 创建时间。 |
used_times |
Integer |
参数解释: 模板仓被使用的次数。 取值范围: 0-2147483647 |
liked_times |
Integer |
参数解释: 模板仓被点赞的次数。 取值范围: 0-2147483647 |
creator_name |
String |
参数解释: 作者。 取值范围: 字符串长度0-128。 |
https_url |
String |
参数解释: 代码仓https协议的git地址。 取值范围: 字符串最大长度512。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/repository-templates
响应示例
状态码:200
模板仓列表
[ { "repository_id" : 10015, "name" : "Java Web Demo", "system" : true, "description" : "A Hello World applet compiled based on Spring boot", "language" : "Java", "tags" : [ "Java", "Web网站", "SupportPipeline" ], "repository_name" : "javaWebDemo", "brief_introduction" : "A Hello World applet compiled based on Spring boot", "created_at" : "2021-06-07T13:18:38.000Z", "used_times" : 2976, "liked_times" : 0, "creator_name" : "华为云CodeArts", "https_url" : "https://example.com/demo_group_name/javaWebDemo.git" } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码:404
Not Found
{ "error_code" : "DEV-23-50527", "error_msg" : "仓库不存在或仓库已被删除" }
状态码
状态码 |
描述 |
---|---|
200 |
模板仓列表 |
401 |
Unauthorized |
403 |
Bad Request |
404 |
Not Found |
错误码
请参见错误码。