获取数据标准集合
功能介绍
根据查询条件分页获取数据标准集合，按修改时间降序排序。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/design/standards
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参见项目ID和账号ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
directory_id |
否 |
String |
目录ID。获取该目录下的数据标准，如果有子目录，同时获取所有子目录的数据标准。 |
|
begin_time |
否 |
String |
时间过滤左边界，与end_time一起使用，只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
end_time |
否 |
String |
时间过滤右边界，与begin_time一起使用只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
limit |
否 |
Integer |
每页查询条数，即查询Y条数据。默认值50，取值范围[1,100]。 |
|
offset |
否 |
Integer |
查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整，默认值0。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 |
|
workspace |
是 |
String |
工作空间ID，获取方法请参见实例ID和工作空间ID。 |
|
X-Project-Id |
否 |
String |
项目ID，获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求，则该字段必选。 |
|
Content-Type |
否 |
String |
默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
返回数据标准集合。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
records |
Array of StandElementValueVOList objects |
StandElementValueVO数组。 |
|
total |
Integer |
数据标准的总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
values |
Array of StandElementValueVO objects |
属性信息。 |
|
id |
String |
数据标准的ID，ID字符串。 |
|
directory_id |
String |
标准所属目录，ID字符串。 |
|
directory_path |
String |
目录树。 |
|
row_id |
String |
标准行的ID，ID字符串。 |
|
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
|
approval_info |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。 |
|
new_biz |
BizVersionManageVO object |
业务版本管理，只读。 |
|
from_public |
Boolean |
是否来自公共层。 |
|
create_by |
String |
创建人。 |
|
update_by |
String |
更新人。 |
|
create_time |
String |
创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
update_time |
String |
更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
fd_name |
String |
属性名称。 |
|
fd_value |
String |
属性值。 |
|
fd_id |
String |
属性定义的ID，ID字符串。 |
|
directory_id |
String |
标准所属目录，ID字符串。 |
|
row_id |
String |
标准所属行，ID字符串。 |
|
id |
String |
数据标准的ID，ID字符串。 |
|
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
|
create_by |
String |
创建人。 |
|
update_by |
String |
更新人。 |
|
create_time |
String |
创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
update_time |
String |
更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
审批单ID，ID字符串。 |
|
tenant_id |
String |
项目ID，获取方式参考接口路径参数“project_id”。 |
|
name_ch |
String |
业务中文名。 |
|
name_en |
String |
业务英文名。 |
|
biz_id |
String |
业务ID，ID字符串。 |
|
biz_type |
String |
业务实体类型。 枚举值：
|
|
biz_info |
String |
序列化之后的业务详情，类型是string。 |
|
biz_info_obj |
Object |
业务详情，类型是object。 |
|
biz_version |
Integer |
业务版本。 |
|
biz_status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
|
approval_status |
String |
业务审批状态，只读。 枚举值：
|
|
approval_type |
String |
业务审核类型。 枚举值：
|
|
submit_time |
String |
提交时间。 |
|
create_by |
String |
创建者。 |
|
l1 |
String |
主题域分组中文名，只读，创建和更新时无需填写。 |
|
l2 |
String |
主题域中文名，只读，创建和更新时无需填写。 |
|
l3 |
String |
业务对象中文名，只读，创建和更新时无需填写。 |
|
approval_time |
String |
审核时间。 |
|
approver |
String |
审核人。 |
|
|
String |
审核人邮箱。 |
|
msg |
String |
审核信息。 |
|
directory_path |
String |
目录树。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
ID信息，ID字符串。 |
|
biz_type |
String |
业务实体类型。 枚举值：
|
|
biz_id |
String |
业务ID，ID字符串。 |
|
biz_info |
String |
业务对象信息。 |
|
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
|
biz_version |
Integer |
业务版本，只读。 |
|
create_time |
String |
创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
update_time |
String |
更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
请求示例
查询目录ID为1193957835831218179及其子目录下的前十条数据标准的集合。
GET https://{endpoint}/v2/{project_id}/design/standards?offset=1&limit=10&directory_id=1193957835831218179
响应示例
状态码： 200
Success，返回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" : "啊啊啊",
"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" : "不不不",
"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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success，返回data数据是该目录及其子目录下的全部数据标准集合，以及总数。 |
|
400 |
失败，用户请求非法。 |
|
401 |
失败，用户身份认证失败。 |
|
403 |
失败，用户无权限调用此API。 |
|
404 |
失败，用户请求API不存在。 |
