Querying the Comment List
Function
This API is used to query the comment list.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/notes/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 |
|---|---|---|---|
|
limit |
No |
Integer |
The maximum number of records can be returned on each page for a pagination query. The value starts from 1. |
|
offset |
No |
Integer |
Pagination query parameter. This parameter specifies the start position of the query result. The value starts from 0. |
|
sort_by |
No |
String |
Sorting field. |
|
order |
No |
String |
Sorting order, which can be ascending or descending. |
|
from_date |
No |
String |
Search start time. |
|
to_date |
No |
String |
Search end time. |
|
war_room_id |
No |
String |
ID of the commented object. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
|
total |
Integer |
Total records. |
|
size |
Integer |
Records on each page. |
|
page |
Integer |
Current page number. |
|
success |
Boolean |
Whether the request is successful. |
|
data |
Array of NotesDetail objects |
Comment list details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_time |
String |
Creation time. |
|
update_time |
String |
Update time. |
|
data |
data object |
Comment content body. |
|
id |
String |
Unique UUID of a comment. |
|
is_deleted |
Boolean |
Whether it is deleted. |
|
marked_note |
Boolean |
Whether it is a comment. |
|
note_type |
String |
Comment action type. |
|
project_id |
String |
Project ID. |
|
type |
String |
Comment type. |
|
user |
user object |
User information. |
|
war_room_id |
String |
ID of the commented object. |
|
workspace_id |
String |
Workspace. |
|
content |
Object |
Comment details. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Query comments of the data object with ID 771b4a74-6f59-4b47-89ac-c8e4d6c13032. The first five records are queried in descending order by creation time.
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"
}
Example Responses
Status code: 200
Request body for searching the comment list.
{
"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 Sample Code
The SDK sample code is as follows.
Query comments of the data object with ID 771b4a74-6f59-4b47-89ac-c8e4d6c13032. The first five records are queried in descending order by creation time.
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()); } } } |
Query comments of the data object with ID 771b4a74-6f59-4b47-89ac-c8e4d6c13032. The first five records are queried in descending order by creation time.
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) |
Query comments of the data object with ID 771b4a74-6f59-4b47-89ac-c8e4d6c13032. The first five records are queried in descending order by creation time.
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 |
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.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) } } |
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 |
Request body for searching the comment list. |
|
400 |
Returned packet for abnormal requests. |
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