文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 获取公开示例模板列表
更新时间：2024-11-18 GMT+08:00
查看PDF
分享

获取公开示例模板列表

功能介绍

获取公开示例模板列表

调试

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

URI

GET /v2/repositories/repository-templates

表1 Query参数

参数

是否必选

参数类型

描述

platform

否

String

模板平台类型

language

否

String

语言类型

pipeline

否

String

是否支持流水线

enter_type

否

String

模板分类

search

否

String

模板名称

date_order

否

String

模板日期排序

used_time_order

否

String

模板引用次数排序

type

否

String

模板公开类型

region

否

String

大区名称

page_no

是

Integer

分页页数

page_size

是

Integer

每页数据数

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

TemplateRepositoryList object

响应结果

status

String

响应状态
表4 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表5 TemplateRepositoryList

参数

参数类型

描述

projects

Array of TemplateRepository objects

模板列表

total

Integer

模板总数
表6 TemplateRepository

参数

参数类型

描述

id

Integer

模板唯一标识

name

String

模板名称

template_name

String

模板关联仓库名称

tags

Array of strings

模板标签

description

String

模板描述

brief_introduction

String

模板简介

auto_pending_pipelines

Integer

是否自动创建流水线

language

String

模板语言分类

created_at

String

模板创建时间

used_times

Integer

模板引用次数

liked_times

Integer

模板被点赞次数

creator_name

String

模板创建人

https_url

String

模板https链接

请求示例

GET https://{endpoint}/v2/repositories/repository-templates?page_no=1&page_size=10

响应示例

状态码： 200

OK

{
  "result" : {
    "projects" : [ {
      "id" : 453613,
      "name" : "javaMavenDemo",
      "template_name" : "javaMavenDemo",
      "tags" : [ "UnsupportedPipeline", "OTHERS", "鲲鹏 ARM64" ],
      "description" : "javaMavenDemo",
      "brief_introduction" : "javaMavenDemo",
      "auto_pending_pipelines" : 0,
      "language" : "OTHERS",
      "created_at" : "Sep 25, 2019 4:03:31 PM",
      "used_times" : 58,
      "liked_times" : 1,
      "creator_name" : "repo",
      "https_url" : "https://repo.alpha.devcloud.inhuawei.com/chentest00001/javaMavenDemo.git"
    } ],
    "total" : 100
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档