# 创建布局字段 - CreateLayoutField #### 功能介绍 创建布局字段 #### 调用方法 请参见[如何调用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 /v2/{project_id}/workspaces/{workspace_id}/soc/layouts/fields 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 字段名称 | | field_key | 是 | String | 字段键 | | description | 否 | String | 字段描述 | | layout_id | 否 | String | 布局ID | | wizard_id | 否 | String | 字段绑定的页面id | | aopworkflow_id | 否 | String | 字段绑定的流程id | | aopworkflow_version_id | 否 | String | 字段绑定的流程版本id | | playbook_id | 否 | String | 字段绑定的剧本id | | playbook_version_id | 否 | String | 字段绑定的剧本版本id | | default_value | 否 | String | 默认值 | | display_type | 否 | String | 显示类型 | | field_type | 否 | String | 字段类型，如shorttext,radio,grid等 | | extra_json | 否 | String | 附加json | | field_tooltip | 否 | String | 工具提示 | | json_schema | 否 | String | json模式 | | readonly | 否 | Boolean | 只读模式，true只读，false非只读 | | required | 否 | Boolean | 是否必填，true必填，false非必填 | | searchable | 否 | Boolean | 可搜索，true可搜索，false非可搜索 | | visible | 否 | Boolean | 可见，true可见，false非可见 | | maintainable | 否 | Boolean | 可维护，true可维护，false非可维护 | | editable | 否 | Boolean | 可编辑，true可编辑，false非可编辑 | | creatable | 否 | Boolean | 可创建，true可创建，false非可创建 | | boa_version | 否 | String | BOA底座版本 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 字段ID | | cloud_pack_id | String | 订阅包id | | cloud_pack_name | String | 订阅包名称 | | dataclass_id | String | 数据类ID | | cloud_pack_version | String | 订阅包版本 | | field_key | String | 字段key | | name | String | 字段名称 | | description | String | 字段描述 | | en_description | String | 字段英文描述 | | default_value | String | 默认值 | | en_default_value | String | 字段英文默认值 | | field_type | String | 字段类型，如shorttext,radio,grid等 | | extra_json | String | 附加json | | field_tooltip | String | 工具提示 | | en_field_tooltip | String | 英文工具提示 | | json_schema | String | json模式 | | is_built_in | Boolean | 是否内置，true内置，false非内置 | | read_only | Boolean | 只读模式，true只读，false非只读 | | required | Boolean | 是否必填，true必填，false非必填 | | searchable | Boolean | 可搜索，true可搜索，false非可搜索 | | visible | Boolean | 可见，true可见，false非可见 | | maintainable | Boolean | 可维护，true可维护，false非可维护 | | editable | Boolean | 可编辑，true可编辑，false非可编辑 | | creatable | Boolean | 可创建，true可创建，false非可创建 | | creator_id | String | 创建者ID | | creator_name | String | 创建者名称 | | modifier_id | String | 修改者ID | | modifier_name | String | 修改者名称 | | create_time | String | 创建时间 | | update_time | String | 更新时间 | | wizard_id | String | 字段绑定的页面id | | aopworkflow_id | String | 字段绑定的流程id | | aopworkflow_version_id | String | 字段绑定的流程版本id | | playbook_id | String | 字段绑定的剧本id | | playbook_version_id | String | 字段绑定的剧本版本id | | boa_version | String | BOA底座版本 | | version | String | 安全云脑版本 | **状态码：400** 表6响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 创建布局字段请求 ``` { "layout_id" : "8f7b3080-e528-440b-99c6-44252f149643", "visible" : false, "editable" : false, "default_value" : "test", "creatable" : false, "required" : false, "searchable" : false, "display_type" : "treeInteract", "field_key" : "tree", "readonly" : false, "name" : "test_yRn2n", "extra_json" : "{\"name\":\"tree\",\"field_key\":\"tree\",\"editableInCurSpace\":false}", "maintainable" : false, "boa_version" : "v3" } ``` #### 响应示例 **状态码：200** 请求成功 ``` { "boa_version" : "v3", "creatable" : false, "create_time" : "2025-12-20T11:12:30Z+0800", "creator_id" : "7cdfd39950744fc1aff40555a94310f4", "creator_name" : "SCC_InfrastructureSecurityService", "default_value" : "test", "editable" : false, "extra_json" : "eyJuYW1lIjoi5qCRIiwiZmllbGRfa2V5IjoidHJlZSIsImVkaXRhYmxlSW5DdXJTcGFjZSI6ZmFsc2V9", "field_key" : "tree", "id" : "91c6674c-3e6e-422d-841e-036a0890801e", "is_built_in" : false, "maintainable" : false, "name" : "test_yRn2n", "required" : false, "searchable" : false, "update_time" : null, "visible" : false } ``` #### 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.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class CreateLayoutFieldSolution { 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(); CreateLayoutFieldRequest request = new CreateLayoutFieldRequest(); request.withWorkspaceId("{workspace_id}"); CreateLayoutFieldRequestBody body = new CreateLayoutFieldRequestBody(); body.withBoaVersion("v3"); body.withCreatable(false); body.withEditable(false); body.withMaintainable(false); body.withVisible(false); body.withSearchable(false); body.withRequired(false); body.withReadonly(false); body.withExtraJson("{"name":"tree","field_key":"tree","editableInCurSpace":false}"); body.withDisplayType("treeInteract"); body.withDefaultValue("test"); body.withLayoutId("8f7b3080-e528-440b-99c6-44252f149643"); body.withFieldKey("tree"); body.withName("test_yRn2n"); request.withBody(body); try { CreateLayoutFieldResponse response = client.createLayoutField(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.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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 = CreateLayoutFieldRequest() request.workspace_id = "{workspace_id}" request.body = CreateLayoutFieldRequestBody( boa_version="v3", creatable=False, editable=False, maintainable=False, visible=False, searchable=False, required=False, readonly=False, extra_json="{"name":"tree","field_key":"tree","editableInCurSpace":false}", display_type="treeInteract", default_value="test", layout_id="8f7b3080-e528-440b-99c6-44252f149643", field_key="tree", name="test_yRn2n" ) response = client.create_layout_field(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/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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.CreateLayoutFieldRequest{} request.WorkspaceId = "{workspace_id}" boaVersionCreateLayoutFieldRequestBody:= "v3" creatableCreateLayoutFieldRequestBody:= false editableCreateLayoutFieldRequestBody:= false maintainableCreateLayoutFieldRequestBody:= false visibleCreateLayoutFieldRequestBody:= false searchableCreateLayoutFieldRequestBody:= false requiredCreateLayoutFieldRequestBody:= false readonlyCreateLayoutFieldRequestBody:= false extraJsonCreateLayoutFieldRequestBody:= "{"name":"tree","field_key":"tree","editableInCurSpace":false}" displayTypeCreateLayoutFieldRequestBody:= "treeInteract" defaultValueCreateLayoutFieldRequestBody:= "test" layoutIdCreateLayoutFieldRequestBody:= "8f7b3080-e528-440b-99c6-44252f149643" request.Body = &model.CreateLayoutFieldRequestBody{ BoaVersion: &boaVersionCreateLayoutFieldRequestBody, Creatable: &creatableCreateLayoutFieldRequestBody, Editable: &editableCreateLayoutFieldRequestBody, Maintainable: &maintainableCreateLayoutFieldRequestBody, Visible: &visibleCreateLayoutFieldRequestBody, Searchable: &searchableCreateLayoutFieldRequestBody, Required: &requiredCreateLayoutFieldRequestBody, Readonly: &readonlyCreateLayoutFieldRequestBody, ExtraJson: &extraJsonCreateLayoutFieldRequestBody, DisplayType: &displayTypeCreateLayoutFieldRequestBody, DefaultValue: &defaultValueCreateLayoutFieldRequestBody, LayoutId: &layoutIdCreateLayoutFieldRequestBody, FieldKey: "tree", Name: "test_yRn2n", } response, err := client.CreateLayoutField(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=CreateLayoutField&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功 | | 400 | 失败响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。