Help Center> SecMaster> API Reference> API> Data Class Management> Querying the Data Class List
Updated on 2024-03-20 GMT+08:00

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/{dataclass_id}/fields

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 32

Maximum: 36

workspace_id

Yes

String

Workspace ID

Minimum: 32

Maximum: 36

dataclass_id

Yes

String

Data class ID.

Minimum: 32

Maximum: 36

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Number

Offset

Minimum: 0

Maximum: 999999999

Default: 0

limit

No

Number

Data volume

Minimum: 1

Maximum: 100

Default: 10

name

No

String

Name

Minimum: 0

Maximum: 64

is_built_in

No

Boolean

Built-in or Not

field_category

No

String

Field types.

Minimum: 0

Maximum: 1024

mapping

No

Boolean

Whether to display in other places other the classification and mapping module.

Request Parameters

Table 3 Request header 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

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

field_details

Array of FieldResponseBody objects

list of informations of field

Array Length: 0 - 100

total

Number

Total data volume

Minimum: 2

Maximum: 999999999

Table 6 FieldResponseBody

Parameter

Type

Description

id

String

Id value

Minimum: 32

Maximum: 64

cloud_pack_version

String

Subscribed version.

Minimum: 2

Maximum: 64

business_id

String

ID of associated service.

Minimum: 32

Maximum: 64

business_type

String

Associated service.

Minimum: 2

Maximum: 64

dataclass_name

String

Data class name.

Minimum: 2

Maximum: 64

business_code

String

Service code for the field.

Minimum: 2

Maximum: 64

field_key

String

Key

Minimum: 2

Maximum: 64

name

String

Field name.

Minimum: 2

Maximum: 64

description

String

Field description.

Minimum: 2

Maximum: 1024

default_value

String

Default value.

Minimum: 2

Maximum: 1024

display_type

String

Display type.

Minimum: 2

Maximum: 64

field_type

String

Field type, such as short text, radio, and grid.

Minimum: 2

Maximum: 64

extra_json

String

Additional JSON.

Minimum: 2

Maximum: 64

field_tooltip

String

Tool tip.

Minimum: 2

Maximum: 64

iu_type

String

Input and output types.

Minimum: 2

Maximum: 64

used_by

String

Services.

Minimum: 2

Maximum: 64

json_schema

String

JSON mode.

Minimum: 2

Maximum: 64

is_built_in

Boolean

Whether it is built in SecMaster. The options are - true for built-in and false for outsourced.

case_sensitive

Boolean

Case-sensitive mode. - true Enabled. False Disabled.

read_only

Boolean

Read-only mode. True Enabled. False Disabled.

required

Boolean

Mandatory mode. True Enabled. False Disabled.

searchable

Boolean

Search mode. True Enabled. False Disabled.

visible

Boolean

Visible mode. True Enabled. False Disabled.

maintainable

Boolean

Maintenance mode. True Enabled. False Disabled.

editable

Boolean

Edit mode. True Enabled. False Disabled.

creatable

Boolean

Creation mode. True Enabled. False Disabled.

mapping

Boolean

Whether to display in other places other the classification and mapping module.

target_api

String

Target API.

Minimum: 0

Maximum: 1024

creator_id

String

Creator id value

Minimum: 32

Maximum: 64

creator_name

String

Creator name value

Minimum: 32

Maximum: 64

modifier_id

String

Modifier id value

Minimum: 32

Maximum: 64

modifier_name

String

Modifier name value

Minimum: 32

Maximum: 64

create_time

String

Create time

Minimum: 0

Maximum: 64

update_time

String

Update time

Minimum: 0

Maximum: 64

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 8 Response body parameters

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,
  "field_details" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "cloud_pack_version" : "Subscribed version.",
    "business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "business_type" : "Service type",
    "dataclass_name" : "Business ID",
    "business_code" : "My Field",
    "field_key" : "Key",
    "name" : "Field name.",
    "description" : "Field description.",
    "default_value" : "Default value.",
    "display_type" : "Display type.",
    "field_type" : "shorttext",
    "extra_json" : "{}",
    "field_tooltip" : "Tool tip.",
    "iu_type" : "Input and output types.",
    "used_by" : "Services.",
    "json_schema" : "{}",
    "is_built_in" : false,
    "case_sensitive" : false,
    "read_only" : false,
    "required" : false,
    "searchable" : false,
    "visible" : false,
    "maintainable" : false,
    "editable" : false,
    "creatable" : false,
    "mapping" : true,
    "target_api" : "Target API.",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_name" : "Tom",
    "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "modifier_name" : "Jerry",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800"
  } ]
}

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 ListDataclassFieldsSolution {

    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();
        ListDataclassFieldsRequest request = new ListDataclassFieldsRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withName("<name>");
        request.withIsBuiltIn(<is_built_in>);
        request.withFieldCategory("<field_category>");
        request.withMapping(<mapping>);
        try {
            ListDataclassFieldsResponse response = client.listDataclassFields(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListDataclassFieldsRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.name = "<name>"
        request.is_built_in = <IsBuiltIn>
        request.field_category = "<field_category>"
        request.mapping = <Mapping>
        response = client.list_dataclass_fields(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.ListDataclassFieldsRequest{}
	offsetRequest:= float32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= float32(<limit>)
	request.Limit = &limitRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	isBuiltInRequest:= <is_built_in>
	request.IsBuiltIn = &isBuiltInRequest
	fieldCategoryRequest:= "<field_category>"
	request.FieldCategory = &fieldCategoryRequest
	mappingRequest:= <mapping>
	request.Mapping = &mappingRequest
	response, err := client.ListDataclassFields(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.