更新时间:2024-05-08 GMT+08:00
分享

获取所有目录

功能介绍

获取所有目录(数据标准、码表)。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/design/directorys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

最小长度:3

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页查询条数,即查询Y条数据。默认值50,取值范围[1,100]。

最大值:100

缺省值:50

offset

Integer

查询起始坐标,即跳过X条数据,仅支持0或limit的整数倍,不满足则向下取整,默认值0。

缺省值:0

type

String

获取该目录下的数据,如果有子目录,获取所有子目录的数据。 枚举值:

  • CODE: 码表目录

  • STANDARD_ELEMENT: 数据标准目录

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。

最小长度:0

最大长度:4096

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

最小长度:3

最大长度:64

X-Project-Id

String

项目ID,获取方法请参见项目ID和账号ID

多project场景采用AK/SK认证的接口请求,则该字段必选。

最小长度:3

最大长度:64

Content-Type

String

默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。

最小长度:3

最大长度:64

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

data object

data,统一的返回结果的最外层数据结构。

表5 data

参数

参数类型

描述

value

Array of DirectoryVO objects

value,统一的返回结果的外层数据结构。

表6 DirectoryVO

参数

参数类型

描述

name

String

目录名称。

最小长度:1

最大长度:200

description

String

描述。

type

String

目录类型。 枚举值:

  • STANDARD_ELEMENT: 数据标准

  • CODE: 码表

id

String

ID,创建时可不传,更新时必填。填写String类型替代Long类型。

parent_id

String

父目录ID,首层传null。填写String类型替代Long类型。

prev_id

String

上个节点ID,首节点传null。填写String类型替代Long类型。

root_id

String

根节点ID,根节点此ID为自身ID,只读。填写String类型替代Long类型。

qualified_name

String

目录的资产名称,只读。

from_public

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。

create_by

String

创建人,只读。

update_by

String

更新人,只读。

ref_id

String

关联的主题ID,填写String类型替代Long类型。

children

Array of DirectoryVO objects

子目录。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DS.6000,请求处理失败。

最小长度:8

最大长度:36

error_msg

String

错误信息。

最小长度:2

最大长度:512

data

Object

返回的数据信息。

请求示例

根据目录类型获取数据标准的全部目录。

GET https://{endpoint}/v2/{project_id}/design/directorys?type=STANDARD_ELEMENT

响应示例

状态码: 200

Success,返回data数据是带有子目录的目录。

{
  "data" : {
    "value" : [ {
      "name" : "付款方式",
      "description" : null,
      "type" : "STANDARD_ELEMENT",
      "id" : "1169318103583268864",
      "parent_id" : null,
      "prev_id" : null,
      "root_id" : "1169318103583268864",
      "qualified_name" : "付款方式",
      "create_time" : "2023-11-01T16:52:41+08:00",
      "update_time" : "2023-11-01T16:52:41+08:00",
      "from_public" : false,
      "create_by" : "ei_dayu_y00321344_01",
      "update_by" : "ei_dayu_y00321344_01",
      "ref_id" : null,
      "children" : [ {
        "name" : "线上支付",
        "description" : null,
        "type" : "STANDARD_ELEMENT",
        "id" : "1231215227505364992",
        "parent_id" : "1169318103583268864",
        "prev_id" : null,
        "root_id" : "1169318103583268864",
        "qualified_name" : "付款方式.线上支付",
        "create_time" : "2024-04-20T12:09:45+08:00",
        "update_time" : "2024-04-20T12:09:45+08:00",
        "from_public" : false,
        "create_by" : "ei_dayu_y00321344_01",
        "update_by" : "ei_dayu_y00321344_01",
        "ref_id" : null,
        "children" : [ ]
      } ]
    } ]
  }
}

状态码: 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

状态码: 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

状态码: 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

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

    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();
        ListDirectoriesRequest request = new ListDirectoriesRequest();
        try {
            ListDirectoriesResponse response = client.listDirectories(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = ListDirectoriesRequest()
        response = client.list_directories(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.ListDirectoriesRequest{}
	response, err := client.ListDirectories(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success,返回data数据是带有子目录的目录。

400

BadRequest

401

Unauthorized

403

Forbidden

分享:

    相关文档

    相关产品