# 根据条件分页获取模板V3 - ShowTemplateByPage #### 功能介绍 根据查询条件分页获取模板列表V3 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v3/{project_id}/templates/page 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目的32位uuid，项目唯一标识，通过[获取CodeArts项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4005.html)接口查询项目列表获取。 **取值范围：** 字符串长度32。 **默认取值：** 无。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 无。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | params | 否 | [TemplatePageParam] object | **参数解释：** 模板分页参数 | 表4TemplatePageParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | creator_num | 否 | String | **参数解释：** 创建者，用户在IAM中的ID。 **取值范围：** 大小写字母、数字。 长度限制固定32位 **默认取值：** 无 **获取方法：** 在页面任意位置打开开发者工具，搜索"me"接口中返回值的id或userId字段 | | offset | 是 | Integer | **参数解释：** 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 | | limit | 是 | Integer | **参数解释：** 每页显示的条目数量，最大支持100条 | | name | 否 | String | **参数解释：** 脑图名称。 **取值范围：** 大小写字母、数字、符号、中文。 长度限制128位 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码 **取值范围：** 大小写字母、数字。 长度限制0到20位 | | data | [BasePageInfoTemplateV2] object | **参数解释：** 返回体 **取值范围：** 不涉及 | | message | String | **参数解释：** 错误信息 **取值范围：** 大小写字母、数字、符号、中文。 长度限制0到1000位 | 表6BasePageInfoTemplateV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | limit | Integer | **参数解释：** 每页显示的条目数量，最大支持100条 **取值范围：** 数字，范围1-100 | | list | Array of [TemplateV2] objects | **参数解释：** 返回体 **取值范围：** 不涉及 | | offset | Integer | **参数解释：** 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 **取值范围：** 数字，范围0-100000 | | pages | Integer | **参数解释：** 总页数量 **取值范围：** 数字，范围1-100 | | size | Integer | **参数解释：** 列表个数 **取值范围：** 数字，范围1-200 | | total | Long | **参数解释：** 总数 **取值范围：** 数字 | 表7TemplateV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | String | **参数解释：** 创建时间 **取值范围：** 固定日期格式yyyy-MM-dd HH:mm:ss | | 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 | **参数解释：** 更新时间 **取值范围：** 固定日期格式yyyy-MM-dd HH:mm:ss | | editPermission | Boolean | **参数解释：** 编辑权限 **取值范围：** 布尔值，true\|false | | deletePermission | Boolean | **参数解释：** 删除权限 **取值范围：** 布尔值，true\|false | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 接口调用错误码。 **取值范围：** 大小写字母a-z、A-Z和数字0-9 长度限制0到20位字符 | | data | String | **参数解释：** 接口调用返回体 **取值范围：** JSON字符串格式 | | message | String | **参数解释：** 接口调用错误信息 **取值范围：** 大小写字母、数字、符号、中文。 长度限制0到1000位字符 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 接口调用错误码。 **取值范围：** 大小写字母a-z、A-Z和数字0-9 长度限制0到20位字符 | | data | String | **参数解释：** 接口调用返回体 **取值范围：** JSON字符串格式 | | message | String | **参数解释：** 接口调用错误信息 **取值范围：** 大小写字母、数字、符号、中文。 长度限制0到1000位字符 | #### 请求示例 根据条件分页获取模板V3 ``` post https://{endpoint}/v3/b94c9a6947a44597891e0a7362e7383f/templates/page { "params" : { "creator_num" : "", "name" : "", "limit" : 9, "offset" : 1 } } ``` #### 响应示例 **状态码：200** OK ``` { "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "66053737cb7d4cedb1b848f2dfa37f0c", "description" : "", "mindmap" : null, "name" : "1", "editPermission" : true, "deletePermission" : true, "is_default" : null, "create_time" : "2025/01/10 10:43:56 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : null } ], "offset" : 1, "limit" : 9, "pages" : 1, "size" : 1 }, "message" : null } ``` **状态码：400** Bad Request ``` { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } ``` **状态码：401** Unauthorized ``` { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 根据条件分页获取模板V3 ``` 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 ShowTemplateByPageSolution { 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("")) .build(); ShowTemplateByPageRequest request = new ShowTemplateByPageRequest(); request.withProjectId("{project_id}"); CommRequestTemplatePageParam body = new CommRequestTemplatePageParam(); TemplatePageParam paramsbody = new TemplatePageParam(); paramsbody.withCreatorNum("") .withOffset(1) .withLimit(9) .withName(""); body.withParams(paramsbody); request.withBody(body); try { ShowTemplateByPageResponse response = client.showTemplateByPage(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 根据条件分页获取模板V3 ``` # 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("")) \ .build() try: request = ShowTemplateByPageRequest() request.project_id = "{project_id}" paramsbody = TemplatePageParam( creator_num="", offset=1, limit=9, name="" ) request.body = CommRequestTemplatePageParam( params=paramsbody ) response = client.show_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 根据条件分页获取模板V3 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cloudtest.NewCloudtestClient(hcClient) request := &model.ShowTemplateByPageRequest{} request.ProjectId = "{project_id}" creatorNumParams:= "" offsetParams:= int32(1) limitParams:= int32(9) nameParams:= "" paramsbody := &model.TemplatePageParam{ CreatorNum: &creatorNumParams, Offset: &offsetParams, Limit: &limitParams, Name: &nameParams, } request.Body = &model.CommRequestTemplatePageParam{ Params: paramsbody, } response, err := client.ShowTemplateByPage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudTest/sdk?api=ShowTemplateByPage)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。