更新时间:2024-07-31 GMT+08:00
分享

获取项目列表

功能介绍

主机迁移服务中可以使用迁移项目来对源端进行项目管理,使用该接口获取当前账户下所有的迁移项目列表。

调用方法

请参见如何调用API

URI

GET /v3/migprojects

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每一页记录的迁移项目

最小值:0

最大值:100

缺省值:50

offset

Integer

偏移量

最小值:0

最大值:65535

缺省值:0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:16384

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

查询到的迁移项目的数量

最小值:0

最大值:2147483647

migprojects

Array of MigprojectsResponseBody objects

查询到的迁移项目详情

数组长度:0 - 65535

表4 MigprojectsResponseBody

参数

参数类型

描述

id

String

迁移项目ID

最小长度:1

最大长度:254

name

String

迁移项目名称

最小长度:2

最大长度:19

use_public_ip

Boolean

是否使用公网IP迁移

isdefault

Boolean

是否为默认模板

start_target_server

Boolean

迁移后是否启动目的端虚拟机

region

String

区域名称

最小长度:0

最大长度:255

speed_limit

Integer

模板中配置的限速信息,单位:Mbps

最小值:0

最大值:10000

exist_server

Boolean

迁移项目下是否存在服务器

description

String

迁移项目描述

最小长度:0

最大长度:255

type

String

迁移项目默认迁移类型 MIGRATE_BLOCK:块级迁移 MIGRATE_FILE:文件级迁移

枚举值:

  • MIGRATE_BLOCK

  • MIGRATE_FILE

enterprise_project

String

迁移项目所属的企业项目名称

最小长度:0

最大长度:255

syncing

Boolean

是否持续同步

start_network_check

Boolean

是否开启网络质量检测

请求示例

获取迁移项目列表

GET https://{endpoint}/v3/migprojects

响应示例

状态码: 200

获取项目列表成功

{
  "count" : 6,
  "migprojects" : [ {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_test",
    "use_public_ip" : true,
    "isdefault" : true,
    "start_target_server" : true,
    "region" : "06334e957c80d2642f39c0030856abdb",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "SystemProject",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_test",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_test_Test",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_test002",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_test003",
    "use_public_ip" : true,
    "isdefault" : false,
    "start_target_server" : true,
    "region" : "region",
    "speed_limit" : 0,
    "exist_server" : true,
    "description" : "",
    "type" : "MIGRATE_BLOCK",
    "enterprise_project" : "defalut"
  } ]
}

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.GlobalCredentials;
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.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;


public class ListMigprojectsSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListMigprojectsRequest request = new ListMigprojectsRequest();
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListMigprojectsResponse response = client.listMigprojects(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
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 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 = GlobalCredentials(ak, sk)

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

    try:
        request = ListMigprojectsRequest()
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_migprojects(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
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListMigprojectsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListMigprojects(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

获取项目列表成功

错误码

请参见错误码

相关文档