Querying the Data Class List
Function
This API is used to query the data class list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 32 Maximum: 36 |
workspace_id |
Yes |
String |
Workspace ID Minimum: 32 Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Offset Minimum: 0 Maximum: 999999999 Default: 0 |
limit |
No |
Integer |
Data volume Minimum: 1 Maximum: 100 Default: 10 |
name |
No |
String |
Name Minimum: 0 Maximum: 64 |
business_code |
No |
String |
Code Minimum: 0 Maximum: 64 |
description |
No |
String |
Description. Minimum: 0 Maximum: 1024 |
is_built_in |
No |
Boolean |
Built-in or Not |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 0 Maximum: 2097152 |
content-type |
Yes |
String |
Content type. Default: application/json;charset=UTF-8 Minimum: 0 Maximum: 64 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
dataclass_details |
Array of DataClassResponseBody objects |
Data class details. Array Length: 0 - 100 |
total |
Number |
Total data volume Minimum: 2 Maximum: 999999999 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Data class ID. Minimum: 32 Maximum: 64 |
create_time |
String |
Creation time. Minimum: 0 Maximum: 64 |
update_time |
String |
Update time. Minimum: 0 Maximum: 64 |
creator_id |
String |
Creator ID. Minimum: 32 Maximum: 64 |
creator_name |
String |
Creator username Minimum: 32 Maximum: 64 |
modifier_id |
String |
ID of the user who updated the information. Minimum: 32 Maximum: 64 |
modifier_name |
String |
Creator username Minimum: 32 Maximum: 64 |
cloud_pack_version |
String |
Subscribed version. Minimum: 2 Maximum: 64 |
region_id |
String |
Region ID Minimum: 0 Maximum: 64 |
project_id |
String |
Tenant ID. Minimum: 0 Maximum: 64 |
workspace_id |
String |
Workspace ID Minimum: 0 Maximum: 64 |
domain_id |
String |
domain id Minimum: 0 Maximum: 64 |
name |
String |
Data class name. Minimum: 2 Maximum: 64 |
business_code |
String |
Service code for the data class. Minimum: 2 Maximum: 64 |
description |
String |
Description of the data class. Minimum: 2 Maximum: 1024 |
is_built_in |
Boolean |
Whether the data class is built in SecMaster. The options are - true for built-in and false for outsourced. |
parent_id |
String |
Parent data class ID. Minimum: 32 Maximum: 64 |
type_num |
Number |
Quantity of sub-type data classes. Minimum: 0 Maximum: 99999 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error Code Minimum: 0 Maximum: 64 |
message |
String |
Error Description Minimum: 0 Maximum: 1024 |
Example Requests
Query the data object relationship list. The offset is 10, and three alerts are queried.
{ "limit" : 3, "offset" : 10 }
Example Responses
Status code: 200
Request succeeded.
{ "total" : 41, "dataclass_details" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_name" : "Tom", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "modifier_name" : "Jerry", "cloud_pack_version" : "Subscribed version.", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "Evidence", "business_code" : "Evidence", "description" : "Description of custom data classes.", "is_built_in" : false, "parent_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "type_num" : 9 } ] }
SDK Sample Code
The SDK sample code is as follows.
Query the data object relationship list. The offset is 10, and three alerts are queried.
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 |
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 ListDataclassSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ListDataclassRequest request = new ListDataclassRequest(); request.withOffset(<offset>); request.withLimit(<limit>); request.withName("<name>"); request.withBusinessCode("<business_code>"); request.withDescription("<description>"); request.withIsBuiltIn(<is_built_in>); try { ListDataclassResponse response = client.listDataclass(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 the data object relationship list. The offset is 10, and three alerts are queried.
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDataclassRequest() request.offset = <offset> request.limit = <limit> request.name = "<name>" request.business_code = "<business_code>" request.description = "<description>" request.is_built_in = <IsBuiltIn> response = client.list_dataclass(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 the data object relationship list. The offset is 10, and three alerts are queried.
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDataclassRequest{} offsetRequest:= float32(<offset>) request.Offset = &offsetRequest limitRequest:= float32(<limit>) request.Limit = &limitRequest nameRequest:= "<name>" request.Name = &nameRequest businessCodeRequest:= "<business_code>" request.BusinessCode = &businessCodeRequest descriptionRequest:= "<description>" request.Description = &descriptionRequest isBuiltInRequest:= <is_built_in> request.IsBuiltIn = &isBuiltInRequest response, err := client.ListDataclass(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 succeeded. |
400 |
Response body of the failed requests for querying the data class 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