Obtaining Data Standards
Function
Obtain the data standard set based on the query conditions in pagination mode and sort the data by modification time in descending order.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/standards
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
directory_id |
No |
String |
Catalog ID. Obtain the data standards in the directory. If there are subdirectories, obtain the data standards of all subdirectories. |
begin_time |
No |
String |
Left boundary of time filtering. This parameter is used together with end_time. Only time range filtering is supported. Unilateral filtering is invalid. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
end_time |
No |
String |
Right boundary for time filtering. This parameter is used together with begin_time to support only time range filtering. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
limit |
No |
Integer |
Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100]. |
offset |
No |
Integer |
Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
X-Project-Id |
No |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
Content-Type |
No |
String |
Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
The data standard set is returned. |
Parameter |
Type |
Description |
---|---|---|
records |
Array of StandElementValueVOList objects |
StandElementValueVO array. |
total |
Integer |
Total number of data standards. |
Parameter |
Type |
Description |
---|---|---|
values |
Array of StandElementValueVO objects |
Attributes |
id |
String |
Data standard ID, which is a string |
directory_id |
String |
ID of the directory to which the standard belongs. The value is a string. |
directory_path |
String |
Directory tree. |
row_id |
String |
Row ID, which is a string |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
approval_info |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
from_public |
Boolean |
Indicates whether the data is from the public layer. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
Parameter |
Type |
Description |
---|---|---|
fd_name |
String |
Attribute name. |
fd_value |
String |
Property value. |
fd_id |
String |
Attribute ID, which is a string |
directory_id |
String |
ID of the directory to which the standard belongs. The value is a string. |
row_id |
String |
ID of the row to which the standard belongs. The value is a string. |
id |
String |
Data standard ID, which is a string |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Application ID, which is a string |
tenant_id |
String |
Project ID. For details about how to obtain the project ID, see the API path parameter project_id. |
name_ch |
String |
Chinese name of a service. |
name_en |
String |
English name of a service. |
biz_id |
String |
Business ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
biz_info |
String |
Serialized service details. The type is string. |
biz_info_obj |
Object |
Service details. The type is object. |
biz_version |
Integer |
Service version. |
biz_status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
approval_status |
String |
Service approval status. This parameter is read-only. Options:
|
approval_type |
String |
Service review type. Options:
|
submit_time |
String |
Submitted At |
create_by |
String |
Creator. |
l1 |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
l2 |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
l3 |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
approval_time |
String |
Review time. |
approver |
String |
Reviewer. |
|
String |
Email address of the reviewer. |
msg |
String |
Review information. |
directory_path |
String |
Directory tree. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Field ID, which is a string |
biz_type |
String |
Business entity type. Options:
|
biz_id |
String |
Business ID, which is a string |
biz_info |
String |
Business object information. |
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
biz_version |
Integer |
Service version, which is read-only. |
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Example Requests
Query the set of the first 10 data standards in the directory whose ID is 1193957835831218179 and its subdirectories.
GET https://{endpoint}/v2/{project_id}/design/standards?offset=1&limit=10&directory_id=1193957835831218179
Example Responses
Status code: 200
This operation succeeds. The returned data is the standard set of all data in the directory and its subdirectories and the total number of data.
{ "data" : { "value" : { "total" : 1, "records" : [ { "values" : [ { "fd_name" : "nameCh", "fd_value" : "test_czh_bug_0110", "fd_id" : "1169308633595617280", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090826", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "nameEn", "fd_value" : "DS000005", "fd_id" : "1169308634786799616", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090827", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "dataType", "fd_value" : "STRING", "fd_id" : "1169308634803576832", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090828", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "dataLength", "fd_value" : ",", "fd_id" : "1169308634824548352", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090816", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "hasAllowValueList", "fd_value" : "false", "fd_id" : "1169308634841325568", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090817", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "allowList", "fd_value" : "", "fd_id" : "1169308634862297088", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090818", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "referCodeTable", "fd_value" : "", "fd_id" : "1169308634879074304", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090819", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "codeStandColumn", "fd_value" : "", "fd_id" : "1169308634895851520", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090820", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "ruleOwner", "fd_value" : "", "fd_id" : "1169308634933600256", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090821", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "dataMonitorOwner", "fd_value" : "", "fd_id" : "1169308634950377472", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090822", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "standardLevel", "fd_value" : "", "fd_id" : "1169308634971348992", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090823", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "description", "fd_value" : "", "fd_id" : "1169308634988126208", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090824", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "englishName", "fd_value" : "", "fd_id" : "1194674245716848640", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195028291917090825", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "Oh, huh?", "fd_value" : "you can you up", "fd_id" : "1194674245767180288", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195409867876298763", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-12T16:52:02+08:00", "update_time" : "2024-01-12T17:33:42+08:00" }, { "fd_name" : "No, no, no.", "fd_value" : "no can no bb", "fd_id" : "1194674684046856192", "directory_id" : "1193957835831218179", "row_id" : "1195028291904507904", "id" : "1195409867876298764", "status" : "DRAFT", "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-12T16:52:02+08:00", "update_time" : "2024-01-12T17:33:42+08:00" } ], "id" : "1195028291904507904", "directory_id" : "1193957835831218179", "directory_path" : "test_czh2", "row_id" : "1195028291904507904", "status" : "DRAFT", "approval_info" : null, "new_biz" : null, "from_public" : false, "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-01-11T15:35:47+08:00", "update_time" : "2024-01-12T17:33:42+08:00" } ] } } }
SDK Sample Code
The SDK sample code is as follows.
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 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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListAllStandardsSolution { 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); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListAllStandardsRequest request = new ListAllStandardsRequest(); try { ListAllStandardsResponse response = client.listAllStandards(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.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 = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAllStandardsRequest() response = client.list_all_standards(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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 := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAllStandardsRequest{} response, err := client.ListAllStandards(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 |
This operation succeeds. The returned data is the standard set of all data in the directory and its subdirectories and the total number of data. |
400 |
Failed. The user request is invalid. |
401 |
Failed. User identity authentication failed. |
403 |
Failed. The user does not have the permission to call this API. |
404 |
Failed. The API requested by the user does not exist. |
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