Querying the Field List
Function
This API is used to query the field 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 |
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. Range N/A |
|
dataclass_id |
Yes |
String |
Definition Data class ID. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Definition Offset. Constraints N/A Range N/A Default Value N/A |
|
limit |
No |
Integer |
Definition Data volume. Constraints N/A Range N/A Default Value N/A |
|
name |
No |
String |
Search by name. |
|
is_built_in |
No |
Boolean |
Built-in or not. |
|
field_category |
No |
String |
Field category. |
|
mapping |
No |
Boolean |
Whether to display in other places except the category mapping area. |
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 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. 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 |
Subscription package version. |
|
business_id |
String |
ID of the associated service. |
|
business_type |
String |
Associated services. |
|
dataclass_name |
String |
Data class name. |
|
business_code |
String |
Business code of the field. |
|
field_key |
String |
Field key. |
|
name |
String |
Field name. |
|
description |
String |
Field description. |
|
default_value |
String |
Default value. |
|
display_type |
String |
Display type. |
|
field_type |
String |
Definition Field type. Constraints N/A Range
Timestamp: Time Default Value N/A |
|
extra_json |
String |
Additional JSON. |
|
field_tooltip |
String |
Tool tips. |
|
iu_type |
String |
Input and output type. |
|
used_by |
String |
Related service. |
|
json_schema |
String |
JSON. |
|
is_built_in |
Boolean |
Built-in or not. true: Built in; false: Not built in. |
|
case_sensitive |
Boolean |
true: Case sensitive; false: Case insensitive |
|
read_only |
Boolean |
Read-only mode. The value can be true (read-only) or false (non-read-only). |
|
required |
Boolean |
Whether the parameter is mandatory. true: Mandatory; false: Optional. |
|
searchable |
Boolean |
Searchable or not. true: Searchable; false: Not searchable. |
|
visible |
Boolean |
Visible or not. true: Visible; false: Invisible. |
|
maintainable |
Boolean |
Maintainable or not. true: Maintainable; false: Not maintainable. |
|
editable |
Boolean |
Editable or not. true: Editable; false: Not editable. |
|
creatable |
Boolean |
Creatable or not. true: Yes; false: No |
|
mapping |
Boolean |
Whether to display in other places except the category mapping area. |
|
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. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Query the field list. Offset: 10. Quantity: 3.
{
"limit" : 3,
"offset" : 10
}
Example Responses
Status code: 200
Request succeeded.
{
"total" : 41,
"field_details" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"cloud_pack_version" : "Subscription package version.",
"business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"business_type" : "Service type.",
"dataclass_name" : "Service ID.",
"business_code" : "My Field",
"field_key" : "Field key.",
"name" : "Field name.",
"description" : "Field description.",
"default_value" : "Default value.",
"display_type" : "Display type.",
"field_type" : "String",
"extra_json" : "{}",
"field_tooltip" : "Tool tips.",
"iu_type" : "Input and output type.",
"used_by" : "Related service.",
"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" : "Peter",
"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.
Java
Query the field list. Offset: 10. Quantity: 3.
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()); } } } |
Python
Query the field list. Offset: 10. Quantity: 3.
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) |
Go
Query the field list. Offset: 10. Quantity: 3.
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) } } |
More
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 for 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