根据条件分页获取脑图对象 - ShowMindmapByPage
功能介绍
根据查询条件分页获取脑图对象列表V3
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/mindmaps/page
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。 取值范围: 字符串长度32。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
params |
是 |
MindmapPageParam object |
参数解释: 脑图分页查询参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 |
|
limit |
否 |
Integer |
参数解释: 每页显示的条目数量,最大支持100条 |
|
name |
否 |
String |
参数解释: 脑图名称 取值范围: 大小写字母、数字、符号、中文。 长度限制1-500位 长度限制1-500位 |
|
id_collection |
否 |
Array of strings |
参数解释: ID集合 |
|
folder_id_collection |
否 |
Array of strings |
参数解释: 目录ID集合 |
|
project_id |
是 |
String |
参数解释: 项目ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
|
folder_root_id |
否 |
String |
参数解释: 所属目录的根目录ID 取值范围: 1.-1:特性目录其他目录 2.requirement_root_id:需求根目录 3.feature_root_id:特性根目录 |
|
branch_uri |
否 |
String |
参数解释: 分支uri 取值范围: 大小写字母、数字。 长度限制1-34位 |
|
iterator_uri |
否 |
String |
参数解释: 计划uri 取值范围: 大小写字母、数字。 长度限制0-34位 |
|
is_master |
否 |
Integer |
参数解释: 是否基线 取值范围:
|
|
creator_name_collection |
否 |
Array of strings |
参数解释: 创建者名称集合 |
|
updater_name_collection |
否 |
Array of strings |
参数解释: 更新人名称集合 |
|
confidentiality_code_collection |
否 |
Array of strings |
参数解释: 密级code码列表集合,用户密级开关打开场景下传入需要过滤的密级脑图code码,未打开密级开关场景下可不传该字段。 取值范围: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 接口调用错误码 取值范围: 大小写字母、数字。 长度限制0到20位 |
|
data |
BasePageInfoMindmap object |
参数解释: 脑图分页结果 |
|
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Long |
参数解释: 总数 |
|
list |
Array of Mindmap objects |
参数解释: 脑图列表 |
|
offset |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 |
|
limit |
Integer |
参数解释: 每页显示的条目数量,最大支持100条 |
|
pages |
Integer |
参数解释: 总页数量 |
|
size |
Integer |
参数解释: 列表个数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 脑图主键ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
|
mindmap |
String |
参数解释: 脑图JSON 取值范围: 大小写字母、数字、符号。 长度限制1-2000位 |
|
name |
String |
参数解释: 脑图名称 取值范围: 大小写字母、数字、符号、中文。 长度限制1-500位 |
|
privacy |
String |
参数解释: 是否私有 取值范围:
|
|
app |
String |
参数解释: 所属app 取值范围: 大小写字母、数字、符号。 长度限制1-255位 |
|
create_time |
String |
参数解释: 创建时间 |
|
creator_name |
String |
参数解释: 创建人名称。 取值范围: 大小写字母、数字、符号、中文。 长度限制1-255位 |
|
creator_num |
String |
参数解释: 创建者,用户在IAM中的ID。 取值范围: 大小写字母、数字。 长度限制固定32位 长度限制固定32位 |
|
update_name |
String |
参数解释: 更新人名称。 取值范围: 大小写字母、数字、符号、中文。 |
|
update_num |
String |
参数解释: 更新者,用户在IAM中的ID。 取值范围: 大小写字母、数字。 |
|
update_time |
String |
参数解释: 更新时间 取值范围: 格式固定为yyyy-MM-dd HH:mm:ss。 |
|
folder_id |
String |
目录ID 取值范围: 1.大小写字母、数字。 长度限制固定32位 2.-1:特性目录其他目录 3.requirement_root_id:需求根目录 4.feature_root_id:特性根目录 |
|
project_id |
String |
参数解释: 项目ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
|
folder_root_id |
String |
参数解释: 所属目录的根目录ID 取值范围: 1.-1:特性目录其他目录 2.requirement_root_id:需求根目录 3.feature_root_id:特性根目录 |
|
branch_uri |
String |
参数解释: 分支uri 取值范围: 大小写字母、数字。 长度限制1-34位 |
|
iterator_uri |
String |
参数解释: 计划uri 取值范围: 大小写字母、数字。 长度限制0-34位 |
|
is_master |
Integer |
参数解释: 是否基线 取值范围:
|
|
max_depth |
Integer |
参数解释: 脑图最大深度 取值范围: 值小于83 |
|
map_version |
String |
参数解释: 脑图版本。 取值范围: 大小写字母、数字、符号。 长度限制1-255位 |
|
confidentiality_code |
String |
参数解释: 密级code码,用户密级开关打开下返回具体密级code码,未打开返回null。 取值范围: 不涉及 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
|
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
|
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
|
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
|
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
请求示例
根据条件分页获取脑图对象
post https://{endpoint}/v3/b94c9a6947a44597891e0a7362e7383f/mindmaps/page
{
"params" : {
"folder_id_collection" : [ ],
"name" : "",
"project_id" : "b94c9a6947a44597891e0a7362e7383f",
"folder_root_id" : "feature_root_id",
"branch_uri" : "v92t00010a9h5c3e",
"iterator_uri" : "",
"is_master" : 1,
"offset" : 1,
"limit" : 10
}
}
响应示例
状态码:200
OK
{
"code" : "success",
"data" : {
"total" : 1,
"list" : [ {
"id" : "e0fd499609614f12b2fca889ada32162",
"mindmap" : null,
"name" : "思维导图",
"privacy" : null,
"app" : null,
"create_time" : "2024/05/22 07:38:58 GMT+08:00",
"creator_name" : "lwx1开发人员21",
"creator_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1",
"update_name" : "lwx1开发人员21",
"update_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1",
"update_time" : "2024/05/22 07:39:39 GMT+08:00",
"folder_id" : "feature_root_id",
"project_id" : "fb07002bf4ae4317a855b590a86a52e0",
"folder_root_id" : "feature_root_id",
"branch_uri" : "v91j0000viceusv6",
"iterator_uri" : "",
"is_master" : 1,
"max_depth" : null,
"map_version" : null,
"confidentiality_code" : null
} ],
"offset" : 1,
"limit" : 10,
"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
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 52 53 54 55 56 57 58 59 60 |
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.*; import java.util.List; import java.util.ArrayList; public class ShowMindmapByPageSolution { 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(); ShowMindmapByPageRequest request = new ShowMindmapByPageRequest(); request.withProjectId("{project_id}"); CommRequestMindmapPageParamV3 body = new CommRequestMindmapPageParamV3(); MindmapPageParamV3 paramsbody = new MindmapPageParamV3(); paramsbody.withFolderRootId("feature_root_id") .withOffset(1) .withLimit(10) .withName("") .withProjectId("b94c9a6947a44597891e0a7362e7383f") .withBranchUri("v92t00010a9h5c3e") .withIsMaster(1) .withIteratorUri(""); body.withParams(paramsbody); request.withBody(body); try { ShowMindmapByPageResponse response = client.showMindmapByPage(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 38 39 40 41 42 43 44 |
# 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 = ShowMindmapByPageRequest() request.project_id = "{project_id}" paramsbody = MindmapPageParamV3( folder_root_id="feature_root_id", offset=1, limit=10, name="", project_id="b94c9a6947a44597891e0a7362e7383f", branch_uri="v92t00010a9h5c3e", is_master=1, iterator_uri="" ) request.body = CommRequestMindmapPageParamV3( params=paramsbody ) response = client.show_mindmap_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 44 45 46 47 48 49 50 51 52 53 54 55 56 |
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.ShowMindmapByPageRequest{} request.ProjectId = "{project_id}" folderRootIdParams:= "feature_root_id" offsetParams:= int32(1) limitParams:= int32(10) nameParams:= "" branchUriParams:= "v92t00010a9h5c3e" isMasterParams:= int32(1) iteratorUriParams:= "" paramsbody := &model.MindmapPageParamV3{ FolderRootId: &folderRootIdParams, Offset: &offsetParams, Limit: &limitParams, Name: &nameParams, ProjectId: "b94c9a6947a44597891e0a7362e7383f", BranchUri: &branchUriParams, IsMaster: &isMasterParams, IteratorUri: &iteratorUriParams, } request.Body = &model.CommRequestMindmapPageParamV3{ Params: paramsbody, } response, err := client.ShowMindmapByPage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。