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

Exporting Service Data

Function

Export service data based on request parameters. The following data can be exported: code table, data standard, atomic metric, derivative metric, compound metric, summary table, service metric, theme, process, logical model, physical model, dimension, and fact table.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/export-model

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

ids

No

Array of strings

List of exported object IDs. For example, the IDs of several logical models are of the String type instead of the Long type.

asyn

No

Boolean

Indicates whether to export data asynchronously. The options are true (asynchronous) and false (synchronous).

type

No

String

Exported service type. The options are ER (relational modeling), Directory_CodeTable (code table directory), Directory_Standard (standard directory), DIM (dimension modeling), codeTable (code table), and dataStandard. directory_id is used to export code tables and data standards in a specified directory. model_id and biz_catalog_id are used to export specified models and service tables in a directory. import_bizcatalog is used to export the process architecture. import_bizmetric is used to export service indicators.

directory_id

No

String

ID of the home directory. The value of this parameter is of the String type instead of the Long type.

biz_catalog_id

No

String

ID of the service layer to which the service layer belongs. The value is of the String type instead of the Long type.

biz_catalog_id_list

No

Array of strings

ID list of the service catalog to which the service belongs.

model_id

No

String

ID of the relational model to which the model belongs. This parameter is required for exporting a relational model. Set this parameter to the string type instead of the long type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

Returned data information.

Table 5 data

Parameter

Type

Description

uuid

String

Unique ID returned by the import API

Status code: 400

Table 6 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 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: 403

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.

Example Requests

Export service data whose model ID is 1213499006739791872 and table IDs are 1226583503525818368 and 1217121407599800322 from the relational modeling.

POST https://{endpoint}/v2/{project_id}/design/export-model

{
  "asyn" : "true",
  "type" : "ER",
  "model_id" : "1213499006739791872",
  "ids" : [ "1226583503525818368", "1217121407599800322" ]
}

Example Responses

Status code: 200

Success

{
  "data" : {
    "uuid" : "fd653968-864b-45f6-9842-2b125d2dbfb7"
  }
}

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.

Export service data whose model ID is 1213499006739791872 and table IDs are 1226583503525818368 and 1217121407599800322 from the relational modeling.

 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
54
55
56
57
58
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.*;

import java.util.List;
import java.util.ArrayList;

public class ExportDesignModelsSolution {

    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();
        ExportDesignModelsRequest request = new ExportDesignModelsRequest();
        ExportParam body = new ExportParam();
        List<String> listbodyIds = new ArrayList<>();
        listbodyIds.add("1226583503525818368");
        listbodyIds.add("1217121407599800322");
        body.withModelId("1213499006739791872");
        body.withType("ER");
        body.withAsyn(true);
        body.withIds(listbodyIds);
        request.withBody(body);
        try {
            ExportDesignModelsResponse response = client.exportDesignModels(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());
        }
    }
}

Export service data whose model ID is 1213499006739791872 and table IDs are 1226583503525818368 and 1217121407599800322 from the relational modeling.

 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
# 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 = ExportDesignModelsRequest()
        listIdsbody = [
            "1226583503525818368",
            "1217121407599800322"
        ]
        request.body = ExportParam(
            model_id="1213499006739791872",
            type="ER",
            asyn=True,
            ids=listIdsbody
        )
        response = client.export_design_models(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Export service data whose model ID is 1213499006739791872 and table IDs are 1226583503525818368 and 1217121407599800322 from the relational modeling.

 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
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.ExportDesignModelsRequest{}
	var listIdsbody = []string{
        "1226583503525818368",
	    "1217121407599800322",
    }
	modelIdExportParam:= "1213499006739791872"
	typeExportParam:= "ER"
	asynExportParam:= true
	request.Body = &model.ExportParam{
		ModelId: &modelIdExportParam,
		Type: &typeExportParam,
		Asyn: &asynExportParam,
		Ids: &listIdsbody,
	}
	response, err := client.ExportDesignModels(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

Success

400

BadRequest

401

Unauthorized

403

Forbidden