更新时间:2024-11-22 GMT+08:00

查询导入结果

功能介绍

查询导入excel的处理结果(其中参数uuid获取为:/design/models/action或/design/catalogs/action接口返回结果)。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/design/catelogs/process-import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

uuid

String

需要查询的某次导入的处理结果。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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

表4 响应Body参数

参数

参数类型

描述

data

DsProcessImportResultVO object

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

表5 DsProcessImportResultVO

参数

参数类型

描述

status

String

标识本次导入的唯一值,用于查询导入结果。

枚举值:

  • importing: 导入中

  • fail: 导入失败

  • success: 导入成功

group

BatchOperationVO object

分组信息。

rate

String

当前进度。

表6 BatchOperationVO

参数

参数类型

描述

id

String

批量审批ID,ID字符串。

tenant_id

String

项目ID。

group_id

String

组ID,ID字符串。

biz_name

String

业务名。

biz_id

String

业务ID,ID字符串。

operation_status

String

操作结果类型枚举。RUNNING(运行中)、SUCCESS(操作成功)、FAILED(操作失败)。

枚举值:

  • RUNNING: 运行中

  • SUCCESS: 操作成功

  • FAILED: 操作失败

operation_type

String

类型。

biz_info

String

业务详情。

create_by

String

创建人。

remark

String

remark信息。

total

Integer

总数。

success

Integer

操作成功个数。

failed

Integer

操作失败个数。

rate

String

当前进度。

logs

String

日志。

groups

Array of BatchOperationVO objects

分组信息。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

data

Object

返回的数据信息。

状态码: 401

表8 响应Body参数

参数

参数类型

描述

data

Object

返回的数据信息。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

data

Object

返回的数据信息。

请求示例

根据uuid查询导入excel的处理结果。

GET https://{endpoint}/v2/{project_id}/design/catelogs/process-import?uuid=5a8b96cc-6ee1-429b-b6a9-b26b5f669218

响应示例

状态码: 200

Success,返回data数据是DsProcessImportResultVO。

{
  "data" : {
    "status" : "success",
    "group" : {
      "id" : null,
      "tenant_id" : "xxx",
      "group_id" : "1014919548664713216",
      "biz_name" : null,
      "biz_id" : null,
      "operation_status" : "SUCCESS",
      "operation_type" : "IMPORT_CODETABLE",
      "biz_info" : null,
      "create_by" : "abc",
      "remark" : null,
      "total" : 2,
      "success" : 2,
      "failed" : 0,
      "rate" : "1.00",
      "logs" : null,
      "groups" : [ {
        "id" : "1014919548861845504",
        "tenant_id" : "xxx",
        "group_id" : "1014919548664713216",
        "biz_name" : "test",
        "biz_id" : null,
        "operation_status" : "SUCCESS",
        "operation_type" : "IMPORT_CODETABLE",
        "biz_info" : "{\"op_name\":\"test\",\"op_number\":0}",
        "create_by" : "abc",
        "remark" : "SKIP",
        "total" : 0,
        "success" : 0,
        "failed" : 0,
        "rate" : null,
        "logs" : null,
        "groups" : null
      } ]
    },
    "rate" : "1.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 ImportResultSolution {

    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();
        ImportResultRequest request = new ImportResultRequest();
        try {
            ImportResultResponse response = client.importResult(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 = ImportResultRequest()
        response = client.import_result(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.ImportResultRequest{}
	response, err := client.ImportResult(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success,返回data数据是DsProcessImportResultVO。

400

BadRequest

401

Unauthorized

403

Forbidden