Updated on 2024-11-06 GMT+08:00

Create a Directory

Function

Create directories (data standards and code tables).

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/directorys

Table 1 Path Parameters

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.

Request Parameters

Table 2 Request header 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Catalog name.

description

No

String

Description.

type

Yes

String

Directory type

Options:

  • STANDARD_ELEMENT: data standard

  • CODE: code table

id

No

String

ID. This parameter is optional for creation but mandatory for update. Set this parameter to a value of the String type instead of the Long type.

parent_id

Yes

String

Parent directory ID. The value null is transferred at the first layer. Set this parameter to a value of the String type instead of the Long type.

prev_id

Yes

String

ID of the previous node. The value null is transferred for the first node. Set this parameter to a value of the String type instead of the Long type.

ref_id

No

String

ID of the associated theme. The value of this parameter is of the String type instead of the Long type.

children

No

Array of DirectoryVO objects

Subdirectory.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.

Table 5 data

Parameter

Type

Description

value

DirectoryVO object

value: unified outer data structure of the returned result.

Table 6 DirectoryVO

Parameter

Type

Description

name

String

Catalog name.

description

String

Description.

type

String

Directory type

Options:

  • STANDARD_ELEMENT: data standard

  • CODE: code table

id

String

ID. This parameter is optional for creation but mandatory for update. Set this parameter to a value of the String type instead of the Long type.

parent_id

String

Parent directory ID. The value null is transferred at the first layer. Set this parameter to a value of the String type instead of the Long type.

prev_id

String

ID of the previous node. The value null is transferred for the first node. Set this parameter to a value of the String type instead of the Long type.

root_id

String

Root node ID. The root node ID is its own ID and is read-only. Set this parameter to a value of the String type instead of the Long type.

qualified_name

String

Asset name of a catalog. This parameter is read-only.

from_public

String

Indicates whether the data is from the public layer. This parameter 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.

create_by

String

Creator, which is read-only.

update_by

String

Updater, which is read-only.

ref_id

String

ID of the associated theme. The value of this parameter is of the String type instead of the Long type.

children

Array of DirectoryVO objects

Subdirectory.

Status code: 400

Table 7 Response body parameters

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

Table 8 Response body parameters

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

Table 9 Response body parameters

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

Create a directory based on the request parameters.

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

{
  "name" : "Online payment",
  "parent_id" : "1169318103583268864",
  "prev_id" : 1169318103583268864,
  "type" : "STANDARD_ELEMENT"
}

Example Responses

Status code: 200

This operation succeeds, and the returned data is DirectoryVO.

{
  "data" : {
    "value" : {
      "name" : "Online payment",
      "description" : null,
      "type" : "STANDARD_ELEMENT",
      "id" : "1231215227505364992",
      "parent_id" : "1169318103583268864",
      "prev_id" : null,
      "root_id" : "1169318103583268864",
      "qualified_name" : "Payment Method. Online Payment",
      "create_time" : "2024-04-20T12:09:45.11+08:00",
      "update_time" : "2024-04-20T12:09:45.11+08:00",
      "from_public" : null,
      "create_by" : "ei_dayu_y00321344_01",
      "update_by" : "ei_dayu_y00321344_01",
      "ref_id" : null,
      "children" : null
    }
  }
}

Status code: 400

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

Status code: 401

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

Status code: 403

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

SDK Sample Code

The SDK sample code is as follows.

Create a directory based on the request parameters.

 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
50
51
52
53
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 CreateDirectorySolution {

    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();
        CreateDirectoryRequest request = new CreateDirectoryRequest();
        DirectoryVO body = new DirectoryVO();
        body.withPrevId("1169318103583268864");
        body.withParentId("1169318103583268864");
        body.withType(DirectoryVO.TypeEnum.fromValue("STANDARD_ELEMENT"));
        body.withName("Online payment");
        request.withBody(body);
        try {
            CreateDirectoryResponse response = client.createDirectory(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());
        }
    }
}

Create a directory based on the request parameters.

 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
# 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 = CreateDirectoryRequest()
        request.body = DirectoryVO(
            prev_id="1169318103583268864",
            parent_id="1169318103583268864",
            type="STANDARD_ELEMENT",
            name="Online payment"
        )
        response = client.create_directory(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a directory based on the request parameters.

 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
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.CreateDirectoryRequest{}
	request.Body = &model.DirectoryVo{
		PrevId: "1169318103583268864",
		ParentId: "1169318103583268864",
		Type: model.GetDirectoryVoTypeEnum().STANDARD_ELEMENT,
		Name: "Online payment",
	}
	response, err := client.CreateDirectory(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, and the returned data is DirectoryVO.

400

BadRequest

401

Unauthorized

403

Forbidden