Querying the Import Result
Function
Query the processing result of importing the Excel file. The value of uuid is the result returned by the /design/models/action or /design/catalogs/action API.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/catelogs/process-import
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
uuid |
Yes |
String |
Processing result of an import to be queried. |
Request 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
DsProcessImportResultVO object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
status |
String |
Unique value of the import, which is used to query the import result. Options:
|
group |
BatchOperationVO object |
Group information. |
rate |
String |
Indicates the current progress. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Batch approval ID, which is a string |
tenant_id |
String |
Project ID. |
group_id |
String |
Group ID, which is a string |
biz_name |
String |
Service name. |
biz_id |
String |
Business ID, which is a string |
operation_status |
String |
Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed). Options:
|
operation_type |
String |
Indicates the type. |
biz_info |
String |
Service details. |
create_by |
String |
Creator. |
remark |
String |
Indicates the remark information. |
total |
Integer |
Total number. |
success |
Integer |
Number of successful operations. |
failed |
Integer |
Indicates the number of failed operations. |
rate |
String |
Indicates the current progress. |
logs |
String |
Logs. |
groups |
Array of BatchOperationVO objects |
Group information. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
data |
Object |
Returned data information. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
data |
Object |
Returned data information. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
data |
Object |
Returned data information. |
Example Requests
Query the Excel import result based on the UUID.
GET https://{endpoint}/v2/{project_id}/design/catelogs/process-import?uuid=5a8b96cc-6ee1-429b-b6a9-b26b5f669218
Example Responses
Status code: 200
This operation succeeds, and the returned data is 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 Sample Code
The SDK sample code is as follows.
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) } } |
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 DsProcessImportResultVO. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot