更新时间:2025-07-24 GMT+08:00
分享

获取异步进度

功能介绍

获取异步进度

调用方法

请参见如何调用API

URI

GET /GT3KServer/v4/progress/{operation_uri}

表1 路径参数

参数

是否必选

参数类型

描述

operation_uri

String

参数解释

异步操作uri

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

project_uuid

String

参数解释

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制

不涉及

取值范围

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

uri

String

参数解释

进度uri

取值范围

不涉及

name

String

参数解释

异步进度名称

取值范围

不涉及

total

Integer

参数解释

资源总数

取值范围

不涉及

completed

Boolean

参数解释

异步操作是否完成

取值范围

true:已完成 false:未完成

cancelled

Boolean

参数解释

异步操作是否取消

取值范围

true:已取消 false:未取消

informations

Array of strings

参数解释

提示信息列表

取值范围

不涉及

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

错误信息

取值范围

不涉及

submitted_time

String

参数解释

提交时间

取值范围

不涉及

begin_time

String

参数解释

开始时间

取值范围

不涉及

end_time

String

参数解释

结束时间

取值范围

不涉及

server_ip

String

参数解释

服务ip

取值范围

不涉及

last_modified_time

Long

参数解释

最后修改时间

取值范围

不涉及

finished_count

Integer

参数解释

执行完成总数

取值范围

不涉及

return_value

Object

参数解释

异步操作返回值

取值范围

不涉及

exception_message

String

参数解释

异常信息

取值范围

不涉及

line_up_num

Integer

参数解释

行编号

取值范围

不涉及

asyn_operation_key

String

参数解释

异步操作的key

取值范围

不涉及

is_ended

Boolean

参数解释

是否结束

取值范围

true:已结束 false:未结束

finished_percent

Integer

参数解释

异步操作完成进度

取值范围

0-100

状态码:400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:401

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:404

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:500

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

请求示例

GET https://{endpoint}/GT3KServer/v4/progress/sdga11233sghh

响应示例

状态码:200

参数解释

获取异步进度返回体

取值范围

不涉及

{
  "uri" : "79d49383043f4f84818569b38b38dcf4",
  "name" : "BatchCopyMindmap",
  "total" : 1,
  "completed" : true,
  "informations" : [ ],
  "code" : null,
  "reason" : null,
  "submitted_time" : "2025-01-13 07:56:56",
  "begin_time" : "2025-01-13 07:56:56",
  "end_time" : "2025-01-13 07:56:56",
  "last_modified_time" : 1736751416756,
  "finished_count" : 1,
  "finished_percent" : 100
}

SDK代码示例

SDK代码示例如下。

Java

 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
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;


public class ShowProgressSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowProgressRequest request = new ShowProgressRequest();
        request.withOperationUri("{operation_uri}");
        try {
            ShowProgressResponse response = client.showProgress(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());
        }
    }
}

Python

 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 huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.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"]

    credentials = BasicCredentials(ak, sk)

    client = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowProgressRequest()
        request.operation_uri = "{operation_uri}"
        response = client.show_progress(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowProgressRequest{}
	request.OperationUri = "{operation_uri}"
	response, err := client.ShowProgress(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

参数解释

获取异步进度返回体

取值范围

不涉及

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档