查询布局列表 - ListLayout
功能介绍
查询布局列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/search
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
布局名称 |
|
used_by |
否 |
String |
布局类型 |
|
binding_code |
否 |
String |
创建布局选择的数据类的business_code |
|
is_built_in |
否 |
Boolean |
是否为系统内置 |
|
is_template |
否 |
Boolean |
是否为模板 |
|
is_default |
否 |
Boolean |
是否为默认布局 |
|
layout_type |
否 |
String |
布局页面类型 |
|
offset |
否 |
Integer |
分页 |
|
limit |
否 |
Integer |
每页个数 |
|
sort_key |
否 |
String |
排序字段 |
|
sort_dir |
否 |
String |
升序或者降序排列 |
|
search_txt |
否 |
String |
搜索关键字 |
|
from_date |
否 |
String |
起始时间 |
|
to_date |
否 |
String |
结束时间 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
data |
Array of LayoutDetailInfo objects |
数据列表 |
|
message |
String |
响应信息 |
|
offset |
Integer |
分页 |
|
request_id |
String |
请求ID |
|
limit |
Integer |
每页个数 |
|
success |
Boolean |
是否响应成功 |
|
total |
Integer |
总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cloud_pack_id |
String |
订阅包id |
|
cloud_pack_name |
String |
订阅包名称 |
|
cloud_pack_version |
String |
订阅包版本 |
|
is_built_in |
Boolean |
是否内置,true内置,false非内置 |
|
is_template |
Boolean |
是否为模板 |
|
create_time |
String |
创建时间 |
|
creator_id |
String |
创建者ID |
|
parent_id |
String |
父布局ID |
|
creator_name |
String |
创建者名称 |
|
description |
String |
描述信息 |
|
en_description |
String |
英文描述信息 |
|
id |
String |
订阅包id |
|
name |
String |
名称 |
|
en_name |
String |
英文名称 |
|
layout_json |
String |
布局下的wizard id列表 |
|
project_id |
String |
租户ID |
|
update_time |
String |
更新时间 |
|
workspace_id |
String |
工作空间ID |
|
region_id |
String |
区域ID |
|
domain_id |
String |
用户ID |
|
thumbnail |
String |
模板缩略图,当布局为模板时不为空 |
|
used_by |
String |
被什么业务使用,DATACLASS/AOP_WORKFLOW/SECURITY_REPORT/DASHBOARD,及对应的字段 |
|
layout_cfg |
String |
前端根据该值绑定图标 |
|
layout_type |
String |
布局类型;used_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
binding_id |
String |
数据类ID或流程ID;used_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
binding_name |
String |
数据类名称或流程名称;used_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
binding_code |
String |
数据类或流程英文名称;used_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
fields_sum |
Integer |
字段总数;used_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
wizards_sum |
Integer |
页面总数;used_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
sections_sum |
Integer |
系统区块总数 |
|
modules_sum |
Integer |
系统模块总数 |
|
tabs_sum |
Integer |
自定义指标总数 |
|
version |
String |
安全云脑版本 |
|
boa_version |
String |
BOA底座版本 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询布局列表,偏移量为10,查询3条
{
"is_template" : false,
"limit" : 3,
"offset" : 10
}
响应示例
状态码:200
布局列表返回信息
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"message" : "Error message",
"total" : 41,
"limit" : 2,
"offset" : 1,
"success" : true,
"data" : [ {
"binding_code" : "Indicator",
"binding_id" : "8e6e880c-caba-3511-88f6-545cc9f2a5bd",
"binding_name" : "Indicator",
"boa_version" : "v3",
"create_time" : "2025-06-30T20:01:25Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"description" : "description",
"en_description" : "Built-in layout, indicator management - Domain",
"en_name" : "Domain",
"fields_sum" : 17,
"id" : "fc574642-7a4d-32bb-bb6f-ddcfb74624d9",
"is_built_in" : true,
"is_template" : false,
"layout_cfg" : "indicator",
"layout_json" : [ "28f87ba3-1146-4179-9799-5b5dbeee37ef" ],
"layout_type" : "Detail",
"modules_sum" : 0,
"name" : "domain",
"parent_id" : "144d0a96-db2c-3140-8a2f-ec30d8cee6c9",
"project_id" : "15645222e8744afa985c93dab6341da6",
"sections_sum" : 0,
"tabs_sum" : 0,
"update_time" : "2025-06-30T20:01:25Z+0800",
"used_by" : "DATACLASS",
"wizards_sum" : 1,
"workspace_id" : "7e0f8248-5799-465e-9d94-9ff07f4b800d"
} ]
}
SDK代码示例
SDK代码示例如下。
查询布局列表,偏移量为10,查询3条
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 |
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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class ListLayoutSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ListLayoutRequest request = new ListLayoutRequest(); request.withWorkspaceId("{workspace_id}"); LayoutSearch body = new LayoutSearch(); body.withLimit(3); body.withOffset(10); body.withIsTemplate(false); request.withBody(body); try { ListLayoutResponse response = client.listLayout(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()); } } } |
查询布局列表,偏移量为10,查询3条
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 huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListLayoutRequest() request.workspace_id = "{workspace_id}" request.body = LayoutSearch( limit=3, offset=10, is_template=False ) response = client.list_layout(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询布局列表,偏移量为10,查询3条
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListLayoutRequest{} request.WorkspaceId = "{workspace_id}" limitLayoutSearch:= int32(3) offsetLayoutSearch:= int32(10) isTemplateLayoutSearch:= false request.Body = &model.LayoutSearch{ Limit: &limitLayoutSearch, Offset: &offsetLayoutSearch, IsTemplate: &isTemplateLayoutSearch, } response, err := client.ListLayout(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
布局列表返回信息 |
|
400 |
错误响应 |
错误码
请参见错误码。