搜索评论列表 - ListNotes
功能介绍
搜索评论列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/notes/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 | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询参数,用于指定一次查询最多的结果数,从1开始。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 分页查询参数。用于指定查询结果的起始位置,从0开始 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| sort_by | 否 | String | 参数解释: 排序字段 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| order | 否 | String | 参数解释: 升序/降序 约束限制: 不涉及 取值范围: DESC: 降序 ASC: 升序 默认取值: 不涉及 |
| from_date | 否 | String | 参数解释: 搜索起始时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| to_date | 否 | String | 参数解释: 搜索结束时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| war_room_id | 否 | String | 参数解释: 评论的对象ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| message | String | 参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| total | Integer | 参数解释: 总条数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| size | Integer | 参数解释: 分页查询数据大小 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| page | Integer | 参数解释: 当前页码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| success | Boolean | 参数解释: 是否请求成功 约束限制: 不涉及 取值范围: true:成功 false: 失败 默认取值: 不涉及 |
| data | Array of NotesDetail objects | 参数解释: 评论列表详情 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 评论详情信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 用户id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| name | String | 参数解释: 用户名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| message | String | 参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象的评论,从第0条开始查询5条数据,按照创建时间降序排序
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/notes/search
{
"limit" : 5,
"offset" : 0,
"order" : "DESC",
"sort_by" : "create_time",
"war_room_id" : "771b4a74-6f59-4b47-89ac-c8e4d6c13032"
} 响应示例
状态码:200
搜索评论列表请求体响应
{
"code" : "00000000",
"message" : "message",
"total" : 1,
"size" : 5,
"page" : 0,
"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" : "<p>note test</p>"
}
} ]
} SDK代码示例
SDK代码示例如下。
查询ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象的评论,从第0条开始查询5条数据,按照创建时间降序排序
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 54 55 | 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 ListNotesSolution { 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(); ListNotesRequest request = new ListNotesRequest(); request.withWorkspaceId("{workspace_id}"); ListNotesRequestBody body = new ListNotesRequestBody(); body.withWarRoomId("771b4a74-6f59-4b47-89ac-c8e4d6c13032"); body.withOrder("DESC"); body.withSortBy("create_time"); body.withOffset(0); body.withLimit(5); request.withBody(body); try { ListNotesResponse response = client.listNotes(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()); } } } |
查询ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象的评论,从第0条开始查询5条数据,按照创建时间降序排序
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 | # 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 = ListNotesRequest() request.workspace_id = "{workspace_id}" request.body = ListNotesRequestBody( war_room_id="771b4a74-6f59-4b47-89ac-c8e4d6c13032", order="DESC", sort_by="create_time", offset=0, limit=5 ) response = client.list_notes(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询ID为771b4a74-6f59-4b47-89ac-c8e4d6c13032的数据对象的评论,从第0条开始查询5条数据,按照创建时间降序排序
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 54 55 56 57 58 59 60 61 62 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListNotesRequest{} request.WorkspaceId = "{workspace_id}" warRoomIdListNotesRequestBody:= "771b4a74-6f59-4b47-89ac-c8e4d6c13032" orderListNotesRequestBody:= "DESC" sortByListNotesRequestBody:= "create_time" offsetListNotesRequestBody:= int32(0) limitListNotesRequestBody:= int32(5) request.Body = &model.ListNotesRequestBody{ WarRoomId: &warRoomIdListNotesRequestBody, Order: &orderListNotesRequestBody, SortBy: &sortByListNotesRequestBody, Offset: &offsetListNotesRequestBody, Limit: &limitListNotesRequestBody, } response, err := client.ListNotes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 搜索评论列表请求体响应 |
| 400 | 请求异常返回报文 |
错误码
请参见错误码。