获取项目列表 - ListMigprojects
功能介绍
主机迁移服务中可以使用迁移项目来对源端进行项目管理,使用该接口获取当前账户下所有的迁移项目列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
sms:migproject:list
List
migproject *
-
-
-
URI
GET /v3/migprojects
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每一页记录的迁移项目 取值范围: 0-100 默认取值: 50 |
offset |
否 |
Integer |
偏移量 取值范围: 0-65535 默认取值: 0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
X-Auth-Token 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
查询到的迁移项目的数量 取值范围: 0-2147483647 |
migprojects |
Array of MigprojectsResponseBody objects |
查询到的迁移项目详情 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
迁移项目ID |
name |
String |
迁移项目名称 |
use_public_ip |
Boolean |
是否使用公网IP迁移 |
isdefault |
Boolean |
是否为默认模板 |
start_target_server |
Boolean |
迁移后是否启动目的端虚拟机 |
region |
String |
区域名称 |
speed_limit |
Integer |
模板中配置的限速信息,单位:Mbps 取值范围: 0-10000 |
exist_server |
Boolean |
迁移项目下是否存在服务器 |
description |
String |
迁移项目描述 |
type |
String |
迁移项目默认迁移类型 MIGRATE_BLOCK:块级迁移 MIGRATE_FILE:文件级迁移 枚举值:
|
enterprise_project |
String |
迁移项目所属的企业项目名称 |
syncing |
Boolean |
是否持续同步 |
start_network_check |
Boolean |
是否开启网络质量检测 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误代码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密授权信息 |
error_param |
Array of strings |
错误参数 |
details |
Array of details objects |
详细错误信息 |
请求示例
获取迁移项目列表
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" : "default" }, { "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" : "default" }, { "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" : "default" }, { "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" : "default" }, { "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" : "default" }, { "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" : "default" } ] }
状态码:403
鉴权失败
{ "error_code" : "SMS.9004", "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.", "encoded_authorization_message" : "XXXXXX", "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ], "details" : [ { "error_code" : "SMS.9004", "error_msg" : "You do not have permission to perform action XXX on resource XXX." } ] }
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.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(); 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 |
# 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() 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 |
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{} response, err := client.ListMigprojects(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
获取项目列表成功 |
403 |
鉴权失败 |
错误码
请参见错误码。