Querying the Layout List
Function
This API is used to query the layout list.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/search
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A |
|
content-type |
Yes |
String |
Definition Content type. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
Layout name. |
|
used_by |
No |
String |
Layout type. |
|
binding_code |
No |
String |
business_code of the data class selected for creating a layout. |
|
is_built_in |
No |
Boolean |
Whether to search for built-in layouts. |
|
is_template |
No |
Boolean |
Whether to search for layout templates. |
|
is_default |
No |
Boolean |
Whether to search for default layouts. |
|
layout_type |
No |
String |
Layout page type. |
|
offset |
No |
Integer |
Pagination. |
|
limit |
No |
Integer |
Number of records on each page. |
|
sort_key |
No |
String |
Sorting field. |
|
sort_dir |
No |
String |
Sorting in ascending or descending order. |
|
search_txt |
No |
String |
Keyword. |
|
from_date |
No |
String |
Start time. |
|
to_date |
No |
String |
End time. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
data |
Array of LayoutDetailInfo objects |
Data list. |
|
message |
String |
Response information. |
|
offset |
Integer |
Pagination. |
|
request_id |
String |
Request ID. |
|
limit |
Integer |
Number of records on each page. |
|
success |
Boolean |
Whether the response is successful. |
|
total |
Integer |
Total number. |
|
Parameter |
Type |
Description |
|---|---|---|
|
cloud_pack_id |
String |
Subscription ID. |
|
cloud_pack_name |
String |
Subscription package name. |
|
cloud_pack_version |
String |
Subscription package version. |
|
is_built_in |
Boolean |
Built-in or not. true: Built-in; false: Custom. |
|
is_template |
Boolean |
Layout template. |
|
create_time |
String |
Creation time. |
|
creator_id |
String |
Creator ID. |
|
parent_id |
String |
Parent layout ID. |
|
creator_name |
String |
Creator name. |
|
description |
String |
Description. |
|
en_description |
String |
Description. |
|
id |
String |
Subscription ID. |
|
name |
String |
Name. |
|
en_name |
String |
Name in English. |
|
layout_json |
String |
Wizard ID list in the layout. |
|
project_id |
String |
Tenant ID. |
|
update_time |
String |
Update time. |
|
workspace_id |
String |
Workspace ID. |
|
region_id |
String |
Region ID. |
|
domain_id |
String |
User ID. |
|
thumbnail |
String |
Template thumbnail. This parameter cannot be empty when the layout is a template. |
|
used_by |
String |
Services that use the template (DATACLASS, AOP_WORKFLOW, SECURITY_REPORT, DASHBOARD) and the corresponding fields. |
|
layout_cfg |
String |
The parameter specifies which icon is used. |
|
layout_type |
String |
Layout type. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD. |
|
binding_id |
String |
Data class ID or workflow ID. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD. |
|
binding_name |
String |
Data class name or workflow name. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD. |
|
binding_code |
String |
Data class name or workflow name. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD. |
|
fields_sum |
Integer |
Total number of fields. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD. |
|
wizards_sum |
Integer |
Total number of pages. This parameter is not returned when used_by is SECURITY_REPORT or DASHBOARD. |
|
sections_sum |
Integer |
Total number of system modules. |
|
modules_sum |
Integer |
Total number of system modules. |
|
tabs_sum |
Integer |
Total number of custom indicators. |
|
version |
String |
SecMaster edition. |
|
boa_version |
String |
BOA base version. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Query the layout list. Offset: 10. Quantity: 3.
{
"is_template" : false,
"limit" : 3,
"offset" : 10
}
Example Responses
Status code: 200
Queried layout list.
{
"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 Sample Code
The SDK sample code is as follows.
Query the layout list. Offset: 10. Quantity: 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()); } } } |
Query the layout list. Offset: 10. Quantity: 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) |
Query the layout list. Offset: 10. Quantity: 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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Queried layout list. |
|
400 |
Error response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot