更新时间:2025-09-29 GMT+08:00
分享

模板仓列表

功能介绍

模板仓列表

调试

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

URI

GET /v4/repository-templates

表1 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

platform

String

参数解释:

应用类型。

约束限制:

不涉及

取值范围:

  • Android。

  • Console。

  • HarmonyOS。

  • OTHERS。

  • REST API。

  • ServiceStage。

  • Web网站。

  • 图形用户界面。

默认取值:

不涉及

pipeline

String

参数解释:

是否支持自动创建流水线。

约束限制:

不涉及

取值范围:

  • SupportPipeline,支持自动创建流水线。

  • UnsupportedPipeline 不支持自动创建流水线。

默认取值:

不涉及

枚举值:

  • SupportPipeline

  • UnsupportedPipeline

type

String

参数解释:

自动创建流水线。

约束限制:

不涉及

取值范围:

  • SYSTEM,USER,个人和官方模板。

  • SYSTEM,官方模板。

  • USER,个人模板。

默认取值:

不涉及

枚举值:

  • SYSTEM,USER

  • SYSTEM

  • USER

search

String

参数解释:

查询关键字,按模板仓标题搜索。

约束限制:

不涉及

取值范围:

字符串长度0至50。

默认取值:

不涉及

enter_type

String

参数解释:

参赛类型。

约束限制:

不涉及

取值范围:

  • AI。

  • 大数据。

  • 小程序。

  • 微服务。

默认取值:

不涉及

date_order

String

参数解释:

按照模板仓的创建时间进行排序。

约束限制:

不涉及

取值范围:

  • up,升序。

  • down,降序。

默认取值:

不涉及

枚举值:

  • up

  • down

language

String

参数解释:

编程语言。

约束限制:

不涉及

取值范围:

  • ArkTS。

  • ASP.NET。

  • C。

  • C#。

  • C++。

  • Go。

  • Groovy。

  • HTML。

  • Java。

  • NodeJS。

  • OTHERS。

  • PHP。

  • Python。

默认取值:

不涉及

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

约束限制:

当该参数不为空时,仅返回当前项目下符合搜索条件的模板仓

取值范围:

字符串长度32。

取值范围:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-Total

String

当前请求的结果总条数

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of RepositoryTemplateDto objects

模板仓列表

表5 RepositoryTemplateDto

参数

参数类型

描述

repository_id

Integer

参数解释:

仓库Id。

取值范围:

1-2147483647

name

String

参数解释:

模板仓标题。

取值范围:

字符串长度1-50。

system

Boolean

参数解释:

是否是系统模板。

取值范围:

  • true,系统模板。

  • false,个人模板。

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

表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

参数解释:

错误信息。

请求示例

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" : "仓库不存在或仓库已被删除"
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codehub.v4.region.CodeHubRegion;
import com.huaweicloud.sdk.codehub.v4.*;
import com.huaweicloud.sdk.codehub.v4.model.*;


public class ListRepositoryTemplatesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeHubClient client = CodeHubClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeHubRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRepositoryTemplatesRequest request = new ListRepositoryTemplatesRequest();
        try {
            ListRepositoryTemplatesResponse response = client.listRepositoryTemplates(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodehub.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeHubClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRepositoryTemplatesRequest()
        response = client.list_repository_templates(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codehub.NewCodeHubClient(
        codehub.CodeHubClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListRepositoryTemplatesRequest{}
	response, err := client.ListRepositoryTemplates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

模板仓列表

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码

相关文档