Querying the Data Object List
Function
This API is used to query the data object list.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/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 |
|
dataclass_name |
Yes |
String |
Name of the data class the association subject data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents". |
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 number of records on each page. |
|
offset |
No |
Integer |
Offset. |
|
sort_by |
No |
String |
Sorting field: create_time | update_time |
|
order |
No |
String |
Sorting order. Options: DESC and ASC. |
|
from_date |
No |
String |
Search start time, for example, 2023-02-20T00:00:00.000Z. |
|
to_date |
No |
String |
Search end time, for example, 2023-02-27T23:59:59.999Z. |
|
condition |
No |
condition object |
Search condition expression. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
conditions |
No |
Array of conditions objects |
Expression list. |
|
logics |
No |
Array of strings |
Expression name list. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
total |
Integer |
Total number. |
|
size |
Integer |
Page size. |
|
page |
Integer |
Page number. |
|
success |
Boolean |
Successful or not. |
|
data |
Array of DataObjectDetail objects |
Details list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_time |
String |
Recording time, in the ISO 8601 format of "YYYY-MM-DDTHH:mm:ss.ms+Time zone". Time zone refers to where the incident occurred. If this parameter cannot be parsed, the default time zone GMT+8 is used. |
|
data_object |
Object |
Data object. |
|
dataclass_ref |
dataclass_ref object |
Data class object. |
|
format_version |
Integer |
Format version. |
|
id |
String |
Unique identifier of an incident. The value is in UUID format and can contain a maximum of 36 characters. |
|
project_id |
String |
ID of the current project. |
|
update_time |
String |
Update time, in the ISO 8601 format of "YYYY-MM-DDTHH:mm:ss.ms+Time zone". Time zone refers to where the incident occurred. If this parameter cannot be parsed, the default time zone GMT+8 is used. |
|
version |
Integer |
Version. |
|
workspace_id |
String |
ID of the current workspace. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Unique identifier of a data class. The value is in UUID format and can contain a maximum of 36 characters. |
|
name |
String |
Data class name. |
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 data objects by pagination. The first page needs to be returned, and 10 data records are allowed on each page.
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/search
{
"limit" : 10,
"offset" : 0
}
Example Responses
Status code: 200
Response body for querying the data object list.
{
"code" : "00000000",
"message" : "message",
"total" : 1,
"size" : 10,
"page" : 0,
"success" : true,
"data" : [ {
"create_time" : "2023-02-25T12:00:29.623Z+0800",
"format_version" : 1,
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca626",
"update_time" : "2023-02-27T20:28:53.001Z+0800",
"version" : 0,
"workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624",
"data_object" : {
"parent_id" : 0,
"name" : "demo_name"
},
"dataclass_ref" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca621",
"name" : "Department"
}
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Query data objects by pagination. The first page needs to be returned, and 10 data records are allowed on each page.
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 |
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 ListDataobjectsSolution { 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(); ListDataobjectsRequest request = new ListDataobjectsRequest(); request.withWorkspaceId("{workspace_id}"); request.withDataclassName("{dataclass_name}"); DataobjectSearch body = new DataobjectSearch(); body.withOffset(0); body.withLimit(10); request.withBody(body); try { ListDataobjectsResponse response = client.listDataobjects(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 data objects by pagination. The first page needs to be returned, and 10 data records are allowed on each page.
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 |
# 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 = ListDataobjectsRequest() request.workspace_id = "{workspace_id}" request.dataclass_name = "{dataclass_name}" request.body = DataobjectSearch( offset=0, limit=10 ) response = client.list_dataobjects(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 data objects by pagination. The first page needs to be returned, and 10 data records are allowed on each page.
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 |
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.ListDataobjectsRequest{} request.WorkspaceId = "{workspace_id}" request.DataclassName = "{dataclass_name}" offsetDataobjectSearch:= int32(0) limitDataobjectSearch:= int32(10) request.Body = &model.DataobjectSearch{ Offset: &offsetDataobjectSearch, Limit: &limitDataobjectSearch, } response, err := client.ListDataobjects(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 |
Response body for querying the data object list. |
|
400 |
Response body for failed requests for querying the data object list. |
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