# 创建评论 - CreateNote #### 功能介绍 创建评论 #### 调用方法 请参见[如何调用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/notes 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | war_room_id | 否 | String | **参数解释:** 评论的对象ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | type | 是 | String | **参数解释:** 评论的类型 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: textMessage | | content | 是 | String | **参数解释:** 评论的内容 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | note_type | 否 | String | **参数解释:** 评论的动作类型 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: note | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释:** 错误码 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | message | String | **参数解释:** 错误描述 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | success | Boolean | **参数解释:** 是否请求成功 **约束限制**: 不涉及 **取值范围**: true - 请求成功 false - 请求失败 **默认取值**: 不涉及 | | data | [NotesDetail] object | **参数解释:** 评论详情对象 **约束限制**: 不涉及 | 表5NotesDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | String | **参数解释:** 创建时间 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | update_time | String | **参数解释:** 更新时间 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | data | [data] object | **参数解释:** 评论内容体 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | id | String | **参数解释:** 评论唯一UUID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | is_deleted | Boolean | **参数解释:** 是否已删除 **约束限制**: 不涉及 **取值范围**: true: 已删除 false: 未删除 **默认取值**: false | | marked_note | Boolean | **参数解释:** 标识是否是评论 **约束限制**: 不涉及 **取值范围**: true: 是评论 false: 不是评论 **默认取值**: false | | note_type | String | **参数解释:** 评论的动作类型 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | project_id | String | **参数解释:** 项目ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | type | String | **参数解释:** 评论的类型 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | user | [user] object | **参数解释:** 用户信息 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | war_room_id | String | **参数解释:** 评论的对象ID **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | workspace_id | String | **参数解释:** 空间id **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | content | Object | **参数解释:** 评论详情信息 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | 表6data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | content | String | **参数解释:** 评论的内容 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | 表7user | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释:** 用户id **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | name | String | **参数解释:** 用户名称 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | message | String | **参数解释**: 错误描述 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | #### 请求示例 给ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象创建一条评论，评论内容为test_note ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/notes { "war_room_id" : "771b4a74-6f59-4b47-89ac-c8e4d6c13032", "type" : "textMessage", "content" : "test_note", "note_type" : "note" } ``` #### 响应示例 **状态码：200** 创建评论响应 ``` { "code" : "00000000", "message" : "message", "success" : true, "data" : { "create_time" : "2025-11-20T15:41:37.959Z+0800", "update_time" : "2025-11-20T15:41:37.959Z+0800", "data" : { "content" : "note test" }, "id" : "d235cdb7-3664-474b-9ab5-7f7a9356d5e3", "is_deleted" : false, "marked_note" : true, "note_type" : "note", "project_id" : "15645222e8744afa985c93dab6341da6", "type" : "textMessage", "user" : { "id" : "demo_user", "name" : "demo_user" }, "war_room_id" : "771b4a74-6f59-4b47-89ac-c8e4d6c13032", "workspace_id" : "2b6b8a42-fd71-437f-8f3b-81160bf21418", "content" : { "come_from" : "demo_user", "occurred_time" : "2025-11-21T16:04:32.946Z+0800", "value" : "

note test

" } } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 给ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象创建一条评论，评论内容为test_note ``` 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 CreateNoteSolution { 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(); CreateNoteRequest request = new CreateNoteRequest(); request.withWorkspaceId("{workspace_id}"); CreateNoteRequestBody body = new CreateNoteRequestBody(); body.withNoteType("note"); body.withContent("test_note"); body.withType("textMessage"); body.withWarRoomId("771b4a74-6f59-4b47-89ac-c8e4d6c13032"); request.withBody(body); try { CreateNoteResponse response = client.createNote(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] 给ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象创建一条评论，评论内容为test_note ``` # 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 = CreateNoteRequest() request.workspace_id = "{workspace_id}" request.body = CreateNoteRequestBody( note_type="note", content="test_note", type="textMessage", war_room_id="771b4a74-6f59-4b47-89ac-c8e4d6c13032" ) response = client.create_note(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] 给ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象创建一条评论，评论内容为test_note ``` 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.CreateNoteRequest{} request.WorkspaceId = "{workspace_id}" noteTypeCreateNoteRequestBody:= "note" warRoomIdCreateNoteRequestBody:= "771b4a74-6f59-4b47-89ac-c8e4d6c13032" request.Body = &model.CreateNoteRequestBody{ NoteType: ¬eTypeCreateNoteRequestBody, Content: "test_note", Type: "textMessage", WarRoomId: &warRoomIdCreateNoteRequestBody, } response, err := client.CreateNote(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=CreateNote&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建评论响应 | | 400 | 请求异常返回报文 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。