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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID |
dataclass_id |
Yes |
String |
Data class ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Offset |
limit |
No |
Integer |
Data volume |
name |
No |
String |
Name |
is_built_in |
No |
Boolean |
Built-in or Not |
field_category |
No |
String |
Field types. |
mapping |
No |
Boolean |
Whether to display in other places other the classification and mapping module. |
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. |
content-type |
Yes |
String |
Content type. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
field_details |
Array of FieldResponseBody objects |
list of informations of field |
total |
Number |
Total data volume |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Id value |
cloud_pack_version |
String |
Subscribed version. |
business_id |
String |
ID of associated service. |
business_type |
String |
Associated service. |
dataclass_name |
String |
Data class name. |
business_code |
String |
Service code for the field. |
field_key |
String |
Key |
name |
String |
Field name. |
description |
String |
Field description. |
default_value |
String |
Default value. |
display_type |
String |
Display type. |
field_type |
String |
Field type, such as short text, radio, and grid. |
extra_json |
String |
Additional JSON. |
field_tooltip |
String |
Tool tip. |
iu_type |
String |
Input and output types. |
used_by |
String |
Services. |
json_schema |
String |
JSON mode. |
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. |
creator_id |
String |
Creator id value |
creator_name |
String |
Creator name value |
modifier_id |
String |
Modifier id value |
modifier_name |
String |
Modifier name value |
create_time |
String |
Create time |
update_time |
String |
Update time |
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 |
message |
String |
Error Description |
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 |
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"); 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(); ListDataclassFieldsRequest request = new ListDataclassFieldsRequest(); request.withWorkspaceId("{workspace_id}"); request.withDataclassId("{dataclass_id}"); 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 |
# 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"] 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 = ListDataclassFieldsRequest() request.workspace_id = "{workspace_id}" request.dataclass_id = "{dataclass_id}" 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 |
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") 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.ListDataclassFieldsRequest{} request.WorkspaceId = "{workspace_id}" request.DataclassId = "{dataclass_id}" 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.
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