# 新建布局页面 - CreateLayoutWizard #### 功能介绍 创建页面 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/{layout_id}/wizards 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | layout_id | 是 | String | 布局ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 页面ID | | name | 否 | String | 页面名称 | | description | 否 | String | 描述 | | layout_id | 否 | String | 布局ID | | project_id | 否 | String | 租户ID | | workspace_id | 否 | String | 工作空间ID | | wizard_json | 否 | String | 布局页面相关信息 | | is_binding | 否 | Boolean | 是否已绑定按钮 | | binding_button | 否 | Array of [binding_button] objects | 绑定按钮 | | boa_version | 否 | String | BOA底座版本 | | wizard_key | 否 | String | 页面标识 | | wizard_type | 否 | String | 页面类型 | 表4binding_button | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | button_id | 是 | String | 按钮id | | button_name | 否 | String | 按钮名称 | #### 响应参数 **状态码：200** 表5响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | request_id | String | 请求ID | | success | Boolean | 请求结果 | | data | [WizardDetailInfo] object | 页面详情 | 表7WizardDetailInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | String | 创建时间 | | creator_id | String | 创建者ID | | description | String | 描述信息 | | en_description | String | 英文描述 | | id | String | 页面ID | | wizard_json | String | 布局页面相关信息 | | name | String | 页面名称 | | en_name | String | 英文名称 | | update_time | String | 更新时间 | | project_id | String | 租户ID | | workspace_id | String | 工作空间ID | | is_binding | Boolean | 是否已绑定按钮 | | binding_button | Array of [binding_button] objects | 绑定按钮 | | is_built_in | Boolean | 是否为系统页面 | | boa_version | String | BOA底座版本 | | version | String | 安全云脑版本 | | wizard_key | String | 页面标识 | | wizard_type | String | 页面类型 | 表8binding_button | 参数 | 参数类型 | 描述 | |:---|:---|:---| | button_id | String | 按钮id | | button_name | String | 按钮名称 | **状态码：400** 表9响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 创建页面请求体 ``` { "name" : "test", "description" : "test", "boa_version" : "v3" } ``` #### 响应示例 **状态码：200** 创建页面成功响应 ``` { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "success" : true, "data" : { "boa_version" : "v3", "create_time" : "2025-06-30T20:01:25Z+0800", "creator_id" : "system", "description" : "domain", "en_description" : "Built-in,Domain", "en_name" : "Domain", "id" : "fc574642-7a4d-32bb-bb6f-ddcfb74624d9", "is_binding" : true, "project_id" : "25895222e8744afa985c93dab6341da6", "update_time" : "2025-06-30T20:01:25Z+0800", "version" : "25.2.0", "wizard_json" : "test", "workspace_id" : "7e0f8248-5799-465e-9d94-9ff07f4b800d" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 创建页面请求体 ``` 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 CreateLayoutWizardSolution { 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("")) .build(); CreateLayoutWizardRequest request = new CreateLayoutWizardRequest(); request.withWorkspaceId("{workspace_id}"); request.withLayoutId("{layout_id}"); WizardCreateRequestPojo body = new WizardCreateRequestPojo(); body.withBoaVersion("v3"); body.withDescription("test"); body.withName("test"); request.withBody(body); try { CreateLayoutWizardResponse response = client.createLayoutWizard(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] 创建页面请求体 ``` # 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("")) \ .build() try: request = CreateLayoutWizardRequest() request.workspace_id = "{workspace_id}" request.layout_id = "{layout_id}" request.body = WizardCreateRequestPojo( boa_version="v3", description="test", name="test" ) response = client.create_layout_wizard(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] 创建页面请求体 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.CreateLayoutWizardRequest{} request.WorkspaceId = "{workspace_id}" request.LayoutId = "{layout_id}" boaVersionWizardCreateRequestPojo:= "v3" descriptionWizardCreateRequestPojo:= "test" nameWizardCreateRequestPojo:= "test" request.Body = &model.WizardCreateRequestPojo{ BoaVersion: &boaVersionWizardCreateRequestPojo, Description: &descriptionWizardCreateRequestPojo, Name: &nameWizardCreateRequestPojo, } response, err := client.CreateLayoutWizard(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=CreateLayoutWizard&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建页面成功响应 | | 400 | 错误响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。