文档首页/ 对象存储迁移服务 OMS/ API参考/ API v2（推荐）/ 迁移任务组管理/ 获取指定id的taskgroup信息
更新时间：2024-09-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取指定id的taskgroup信息

功能介绍

获取指定id的taskgroup信息

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/taskgroups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

最小长度：1

最大长度：1024

group_id

是

String

任务组id

最小长度：1

最大长度：1024

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM鉴权Token

最小长度：1

最大长度：16384

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

group_id

String

任务组id

最小长度：1

最大长度：100

status

Integer

迁移组任务状态。 0 – 等待中 1 – 执行中/创建中 2 – 监控任务执行 3 – 暂停 4 – 创建任务失败 5 – 迁移失败 6 – 迁移完成 7 – 暂停中 8 – 等待删除中 9 – 删除

最小值：0

最大值：9

error_reason

ErrorReasonResp object

任务组失败原因，非失败状态时该字段为空字符串。

src_node

TaskGroupSrcNodeResp object

源端信息

description

String

任务描述，不能超过255个字符，且不能包含^<>&"'等特殊字符。

最小长度：0

最大长度：255

dst_node

TaskGroupDstNodeResp object

目的端信息。

enable_metadata_migration

Boolean

是否启用元数据迁移，默认否。不启用时，为保证迁移任务正常运行，仍将为您迁移ContentType元数据。

缺省值：false

enable_failed_object_recording

Boolean

是否开启记录失败对象

enable_restore

Boolean

是否自动解冻归档数据，（由于对象存储解冻需要源端存储等待一定时间，开启自动解冻会对迁移速度有较大影响，建议先完成归档存储数据解冻后再启动迁移）。开启后，如果遇到归档类型数据，会自动解冻再进行迁移；如果遇到归档类型的对象直接跳过相应对象，系统默认对象迁移失败并记录相关信息到失败对象列表中。

enable_kms

Boolean

存储入OBS时是否使用KMS加密。

task_type

String

任务类型，默认为PREFIX。 LIST：对象列表迁移 URL_LIST：URL列表迁移， PREFIX：对象前缀迁移

枚举值：

  • LIST

  • URL_LIST

  • PREFIX

bandwidth_policy

Array of BandwidthPolicyDto objects

配置流量控制策略。数组中一个元素对应一个时段的最大带宽，最多允许5个时段，且时段不能重叠。

数组长度：0 - 5

smn_config

SmnInfo object

SMN消息发送配置。

source_cdn

SourceCdnResp object

指定是否启用CDN迁移支持，若包含此字段则为支持，否则为不支持，启用CDN迁移支持后，迁移时将从CDN域名获取源端对象。

migrate_since

Long

迁移指定时间（时间戳，毫秒），表示仅迁移在指定时间之后修改的源端待迁移对象。默认为0，表示不设置迁移指定时间。

最小值：0

最大值：9223372036854775807

缺省值：0

migrate_speed

Long

任务组迁移速度（Byte/s）

最小值：0

最大值：9223372036854775807

total_time

Long

迁移任务组总耗时(毫秒)

最小值：0

最大值：9223372036854775807

start_time

Long

迁移任务组的启动时间(Unix时间戳，毫秒)

最小值：0

最大值：9223372036854775807

total_task_num

Long

任务组包含的迁移任务总数

最小值：0

最大值：9223372036854775807

create_task_num

Long

已创建的迁移任务数

最小值：0

最大值：9223372036854775807

failed_task_num

Long

失败的迁移任务数

最小值：0

最大值：9223372036854775807

complete_task_num

Long

已完成的迁移任务数

最小值：0

最大值：9223372036854775807

paused_task_num

Long

暂停的迁移任务数

最小值：0

最大值：9223372036854775807

executing_task_num

Long

正在运行的迁移任务数

最小值：0

最大值：9223372036854775807

waiting_task_num

Long

等待中的迁移任务数

最小值：0

最大值：9223372036854775807

total_num

Long

迁移任务组包含的对象总数量

最小值：0

最大值：9223372036854775807

create_complete_num

Long

已完成任务创建的对象总数量

最小值：0

最大值：9223372036854775807

success_num

Long

成功的对象数量

最小值：0

最大值：9223372036854775807

fail_num

Long

失败的对象数量

最小值：0

最大值：9223372036854775807

skip_num

Long

忽略的对象数量

最小值：0

最大值：9223372036854775807

total_size

Long

任务迁移总大小(Byte)

最小值：0

最大值：9223372036854775807

create_complete_size

Long

已创建迁移任务包含的对象总大小(Byte)

最小值：0

最大值：9223372036854775807

complete_size

Long

已迁移成功的对象总大小(Byte)

最小值：0

最大值：9223372036854775807

failed_object_record

FailedObjectRecordDto object

失败对象记录

object_overwrite_mode

String

迁移前同名对象覆盖方式，用于迁移前判断源端与目的端有同名对象时，覆盖目的端或跳过迁移。默认SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE。NO_OVERWRITE：不覆盖。迁移前源端对象与目的端对象同名时，不做对比直接跳过迁移。SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE：大小/最后修改时间对比覆盖。默认配置。迁移前源端对象与目的端对象同名时，通过对比源端和目的端对象大小和最后修改时间，判断是否覆盖目的端，需满足源端/目的端对象的加密状态一致。源端与目的端同名对象大小不相同，或目的端对象的最后修改时间晚于源端对象的最后修改时间(源端较新)，覆盖目的端。 CRC64_COMPARISON_OVERWRITE：CRC64对比覆盖。目前仅支持华为/阿里/腾讯。迁移前源端对象与目的端对象同名时，通过对比源端和目的端对象元数据中CRC64值是否相同，判断是否覆盖目的端，需满足源端/目的端对象的加密状态一致。如果源端与目的端对象元数据中不存在CRC64值，则系统会默认使用SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE(大小/最后修改时间对比覆盖)来对比进行覆盖判断。FULL_OVERWRITE：全覆盖。迁移前源端对象与目的端对象同名时，不做对比覆盖目的端。

枚举值：

  • NO_OVERWRITE

  • SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE

  • CRC64_COMPARISON_OVERWRITE

  • FULL_OVERWRITE

dst_storage_policy

String

目的端存储类型设置，当且仅当目的端为华为云OBS时需要，默认为标准存储 STANDARD：华为云OBS标准存储 IA：华为云OBS低频存储 ARCHIVE：华为云OBS归档存储 DEEP_ARCHIVE：华为云OBS深度归档存储 SRC_STORAGE_MAPPING：保留源端存储类型，将源端存储类型映射为华为云OBS存储类型

缺省值：STANDARD

最小长度：0

最大长度：128

枚举值：

  • STANDARD

  • IA

  • ARCHIVE

  • DEEP_ARCHIVE

  • SRC_STORAGE_MAPPING

consistency_check

String

一致性校验方式，用于迁移前/后校验对象是否一致，所有校验方式需满足源端/目的端对象的加密状态一致，具体校验方式和校验结果可通过对象列表查看。默认size_last_modified。size_last_modified：默认配置。迁移前后，通过对比源端和目的端对象大小+最后修改时间，判断对象是否已存在或迁移后数据是否完整。源端与目的端同名对象大小相同，且目的端对象的最后修改时间不早于源端对象的最后修改时间，则代表该对象已存在/迁移成功。crc64：目前仅支持华为/阿里/腾讯。迁移前后，通过对比源端和目的端对象元数据中CRC64值是否相同，判断对象是否已存在/迁移完成。如果源端与目的端对象元数据中不存在CRC64值，则系统会默认使用大小/最后修改时间校验方式来校验。no_check：目前仅支持HTTP/HTTPS数据源。当源端对象无法通过标准http协议中content-length字段获取数据大小时，默认数据下载成功即迁移成功，不对数据做额外校验，且迁移时源端对象默认覆盖目的端同名对象。当源端对象能正常通过标准http协议中content-length字段获取数据大小时，则采用大小/最后修改时间校验方式来校验。

枚举值：

  • size_last_modified

  • crc64

  • no_check

enable_requester_pays

Boolean

是否开启请求者付款，在启用后，请求者支付请求和数据传输费用。
表4 ErrorReasonResp

参数

参数类型

描述

error_code

String

迁移失败的错误码。

最小长度：0

最大长度：10

error_msg

String

迁移失败的原因。

最小长度：0

最大长度：1024
表5 TaskGroupSrcNodeResp

参数

参数类型

描述

bucket

String

源端桶的名称。

最小长度：0

最大长度：1024

cloud_type

String

源端云服务提供商。可选值有AWS、AZURE、ALIYUN、TENCENT、HUAWEICLOUD、QINGCLOUD、KINGSOFTCLOUD、BAIDU、QINIU、GOOGLE、URLSOURCE或者UCLOUD。默认值为ALIYUN。

枚举值：

  • AWS

  • AZURE

  • ALIYUN

  • TENCENT

  • HUAWEICLOUD

  • QINGCLOUD

  • KINGSOFTCLOUD

  • BAIDU

  • QINIU

  • URLSOURCE

  • UCLOUD

  • GOOGLE

region

String

源端桶所处的区域。

最小长度：0

最大长度：100

app_id

String

当源端为腾讯云时，会返回此参数。

最小长度：0

最大长度：255

object_key

Array of strings

任务组类型为前缀迁移任务时，表示待迁移前缀。

最小长度：0

最大长度：1024

数组长度：0 - 500

list_file

ListFile object

列表文件配置，当task_type为list或url_list时，list_file为必选参数。
表6 ListFile

参数

参数类型

描述

list_file_key

String

对象列表文件或URL列表文件对象名。

最小长度：1

最大长度：1024

obs_bucket

String

存放对象列表文件的OBS桶名。

请确保与目的端桶处于同一区域，否则将导致任务创建失败。

最小长度：0

最大长度：1024

list_file_num

String

存放对象列表文件的数量

最小长度：0

最大长度：65535
表7 TaskGroupDstNodeResp

参数

参数类型

描述

bucket

String

目的端桶的名称。

最小长度：0

最大长度：1024

region

String

目的端桶所处的区域。

最小长度：0

最大长度：100

save_prefix

String

目的端桶内路径前缀（拼接在对象key前面,组成新的key,拼接后不能超过1024个字符）。

最小长度：0

最大长度：1024
表8 BandwidthPolicyDto

参数

参数类型

描述

end

String

流量控制结束时间（包含），格式为“hh:mm”。例如“12:03”表示12时03分。

max_bandwidth

Long

时段内允许的最大流量带宽，单位Byte/s，取值范围为>= 1048576Byte/s（相当于1MB/s）且<=209715200Byte/s（相当于200MB/s）。

最小值：1048576

最大值：209715200

start

String

流量控制开始时间（包含），格式为“hh:mm”。例如“12:03”表示12时03分。
表9 SmnInfo

参数

参数类型

描述

notify_result

Boolean

记录迁移任务执行完毕后SMN消息是否发送成功。

notify_error_message

String

记录SMN消息发送失败原因的错误码（迁移任务成功时为空）。

最小长度：0

最大长度：1024

topic_name

String

SMN Topic的名称（SMN消息发送成功时为空）。

最小长度：0

最大长度：5120
表10 SourceCdnResp

参数

参数类型

描述

domain

String

从指定域名获取对象。

最小长度：0

最大长度：1024

protocol

String

协议类型，支持http和https协议。

枚举值：

  • http

  • https

authentication_type

String

鉴权类型: NONE, QINIU_PRIVATE_AUTHENTICATION, ALIYUN_OSS_A, ALIYUN_OSS_B, ALIYUN_OSS_C, KSYUN_PRIVATE_AUTHENTICATION, AZURE_SAS_TOKEN,TENCENT_COS_A,TENCENT_COS_B,TENCENT_COS_C,TENCENT_COS_D

枚举值：

  • NONE

  • QINIU_PRIVATE_AUTHENTICATION

  • ALIYUN_OSS_A

  • ALIYUN_OSS_B

  • ALIYUN_OSS_C

  • KSYUN_PRIVATE_AUTHENTICATION

  • AZURE_SAS_TOKEN

  • TENCENT_COS_A

  • TENCENT_COS_B

  • TENCENT_COS_C

  • TENCENT_COS_D
表11 FailedObjectRecordDto

参数

参数类型

描述

result

Boolean

是否支持失败对象重传。

list_file_key

String

失败对象列表文件路径。

最小长度：0

最大长度：1024

error_code

String

失败对象列表上传失败的错误码。

最小长度：0

最大长度：10

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

请求示例

查询f4e146cac1de45669c3fed73dc3b9c6f项目下id为157ece42-3270-4824-a3d2-f0187a03ca01的迁移任务组

Get https://{endpoint}/v2/f4e146cac1de45669c3fed73dc3b9c6f/taskgroups/157ece42-3270-4824-a3d2-f0187a03ca01

响应示例

状态码： 200

OK

{
  "group_id" : "9522a7e5-b4fc-44b9-93e1-4dbadbd86e67",
  "status" : 3,
  "error_reason" : null,
  "src_node" : {
    "bucket" : "dst-test-001",
    "cloud_type" : "HUAWEICLOUD",
    "region" : "cn-north-7",
    "app_id" : "",
    "object_key" : [ "" ],
    "list_file" : null
  },
  "description" : "",
  "dst_node" : {
    "bucket" : "assess-bucket-1",
    "region" : "cn-north-7",
    "save_prefix" : ""
  },
  "enable_metadata_migration" : false,
  "enable_failed_object_recording" : true,
  "enable_restore" : false,
  "enable_kms" : false,
  "task_type" : "PREFIX",
  "bandwidth_policy" : [ ],
  "smn_config" : null,
  "source_cdn" : null,
  "migrate_since" : 0,
  "migrate_speed" : 0,
  "total_time" : 7907369,
  "start_time" : 1659937788779,
  "total_task_num" : null,
  "create_task_num" : null,
  "failed_task_num" : null,
  "complete_task_num" : null,
  "paused_task_num" : null,
  "executing_task_num" : null,
  "waiting_task_num" : null,
  "total_num" : 4128588,
  "create_complete_num" : null,
  "success_num" : 0,
  "fail_num" : 0,
  "skip_num" : 0,
  "total_size" : 27814708666,
  "create_complete_size" : null,
  "complete_size" : 0,
  "failed_object_record" : {
    "result" : null,
    "list_file_key" : null,
    "error_code" : null
  },
  "object_overwrite_mode" : "SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE",
  "consistency_check" : "size_last_modified",
  "enable_requester_pays" : false
}

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
 
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.oms.v2.region.OmsRegion;
import com.huaweicloud.sdk.oms.v2.*;
import com.huaweicloud.sdk.oms.v2.model.*;


public class ShowTaskGroupSolution {

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

        OmsClient client = OmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowTaskGroupRequest request = new ShowTaskGroupRequest();
        try {
            ShowTaskGroupResponse response = client.showTaskGroup(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
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkoms.v2 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 = OmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowTaskGroupRequest()
        response = client.show_task_group(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
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/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 := oms.NewOmsClient(
        oms.OmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

OK

404

Not Found

错误码

请参见错误码。

父主题： 迁移任务组管理

相关文档