更新时间:2025-07-25 GMT+08:00
分享

获取默认模板

功能介绍

获取默认模板

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/templates/templates-default

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

params

GetDefaultTemplateParam object

参数解释:

请求体

表4 GetDefaultTemplateParam

参数

是否必选

参数类型

描述

name

String

参数解释:

脑图模板名称

取值范围:

大小写字母、数字、中文、符号。

长度限制128位

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

大小写字母、数字。

长度限制0到20位

data

BasePageInfoTemplate object

参数解释:

返回体

message

String

参数解释:

错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

表6 BasePageInfoTemplate

参数

参数类型

描述

limit

Integer

参数解释:

每页显示的条目数量,最大支持200条

list

Array of Template objects

参数解释:

返回体

offset

Integer

参数解释:

起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000

pages

Integer

参数解释:

总页数量

size

Integer

参数解释:

列表个数

total

Long

参数解释:

总数

表7 Template

参数

参数类型

描述

create_time

String

参数解释:

创建时间

creator_name

String

参数解释:

创建人名称。

取值范围:

大小写字母、数字、符号、中文。

creator_num

String

参数解释:

创建者,用户在IAM中的ID。

取值范围:

大小写字母、数字。

长度限制固定32位

description

String

参数解释:

描述

id

String

参数解释:

id 主键

is_default

String

参数解释:

是否默认

mindmap

String

参数解释:

脑图json

name

String

参数解释:

名称

update_time

String

参数解释:

更新时间

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

接口调用错误码。

取值范围:

大小写字母、数字。

长度限制0到20位

data

String

参数解释:

接口调用返回体

取值范围:

不涉及

message

String

参数解释:

接口调用错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

状态码:401

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

接口调用错误码。

取值范围:

大小写字母、数字。

长度限制0到20位

data

String

参数解释:

接口调用返回体

取值范围:

不涉及

message

String

参数解释:

接口调用错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

请求示例

获取默认模板

post https://{endpoint}/v2/b94c9a6947a44597891e0a7362e7383f/templates/templates-default

{
  "params" : {
    "name" : ""
  }
}

响应示例

状态码:200

OK

{
  "code" : "success",
  "data" : {
    "total" : 0,
    "list" : [ ],
    "offset" : 1,
    "limit" : 10,
    "pages" : 0,
    "size" : 0
  },
  "message" : null
}

状态码:400

Bad Request

{
  "error_code" : "TESTMIND.00021882",
  "error_msg" : "分支、计划id长度不合法,请稍后重试"
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "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
46
47
48
49
50
51
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;


public class ShowDefaultTemplateByPageSolution {

    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);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDefaultTemplateByPageRequest request = new ShowDefaultTemplateByPageRequest();
        request.withProjectId("{project_id}");
        CommRequestGetDefaultTemplateParam body = new CommRequestGetDefaultTemplateParam();
        GetDefaultTemplateParam paramsbody = new GetDefaultTemplateParam();
        paramsbody.withName("");
        body.withParams(paramsbody);
        request.withBody(body);
        try {
            ShowDefaultTemplateByPageResponse response = client.showDefaultTemplateByPage(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
31
32
33
34
35
36
37
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.v1 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 = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDefaultTemplateByPageRequest()
        request.project_id = "{project_id}"
        paramsbody = GetDefaultTemplateParam(
            name=""
        )
        request.body = CommRequestGetDefaultTemplateParam(
            params=paramsbody
        )
        response = client.show_default_template_by_page(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
36
37
38
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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 := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDefaultTemplateByPageRequest{}
	request.ProjectId = "{project_id}"
	nameParams:= ""
	paramsbody := &model.GetDefaultTemplateParam{
		Name: &nameParams,
	}
	request.Body = &model.CommRequestGetDefaultTemplateParam{
		Params: paramsbody,
	}
	response, err := client.ShowDefaultTemplateByPage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档