
# 新建迁移项目 - CreateMigproject
#### 功能介绍
新建迁移项目。
#### 接口约束
迁移项目不可与已有的迁移项目同名。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-sms/sms_api_0007.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-sms/sms_api_8001.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                   | 访问级别  | 资源类型（\*为必须）   | 条件键 | 别名                         | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | sms:migproject:create | Write | migproject \* | -   | sms:server:migrationServer | -      |
     
  
 
#### URI
POST /v3/migprojects
#### 请求参数
表1请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | X-Auth-Token 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：**1** 最大长度：**16384** |
   
表2请求Body参数 
| 参数                  | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| name                | 是    | String  | 迁移项目名称 最小长度：**1** 最大长度：**100**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| description         | 否    | String  | 迁移项目描述 最小长度：**0** 最大长度：**255**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| isdefault           | 否    | Boolean | 是否为默认模板 缺省值：**false**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| region              | 是    | String  | 区域名称 最小长度：**0** 最大长度：**100**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| start_target_server | 否    | Boolean | 迁移后是否启动目的端虚拟机 缺省值：**true**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| speed_limit         | 否    | Integer | 限制迁移速率，单位：Mbps。0表示不限速 最小值：**0** 最大值：**1000** 缺省值：**0**                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| use_public_ip       | 否    | Boolean | 是否使用公网IP迁移 缺省值：**true**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| exist_server        | 否    | Boolean | 是否是已经存在的服务器 缺省值：**true**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| type                | 是    | String  | 迁移项目类型 MIGRATE_BLOCK:块级迁移 MIGRATE_FILE:文件级迁移 最小长度：**0** 最大长度：**255** 枚举值： - **MIGRATE_BLOCK**   - **MIGRATE_FILE**    |
| enterprise_project  | 否    | String  | 企业项目名称 缺省值：**default** 最小长度：**0** 最大长度：**255**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| syncing             | 否    | Boolean | 首次复制或者同步后 是否继续持续同步 缺省值：**false**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| start_network_check | 否    | Boolean | 是否启动网络质量检测                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数 | 参数类型   | 描述                                                                                                                   |
|:---|:---|:---|
| id | String | 创建迁移项目返回的新添加的迁移项目的id 最小长度：**0** 最大长度：**255** |
   
**状态码：403**
表4响应Body参数 
| 参数                            | 参数类型                                                            | 描述                                                                                                                                                         |
|:---|:---|:---|
| error_code                    | String                                                          | 错误代码 最小长度：**0** 最大长度：**255**                                                       |
| error_msg                     | String                                                          | 错误信息 最小长度：**0** 最大长度：**255**                                                       |
| encoded_authorization_message | String                                                          | 加密授权信息 最小长度：**0** 最大长度：**65535**                                                   |
| error_param                   | Array of strings                                                | 错误参数 最小长度：**0** 最大长度：**65535** 数组长度：**1 - 20** |
| details                       | Array of [details] objects | 详细错误信息 数组长度：**1 - 20**                                                                                                 |
   
 表5details 
| 参数         | 参数类型   | 描述                                                                                                        |
|:---|:---|:---|
| error_code | String | SMS错误代码 最小长度：**0** 最大长度：**65535** |
| error_msg  | String | SMS错误信息 最小长度：**0** 最大长度：**65535** |
   
#### 请求示例
新建迁移项目。新的迁移项目名称是N121，region信息是region，使用公网ip是true，迁移项目类型是MIGRATE_BLOCK
```
POST https://{endpoint}/v3/migprojects
{
  "name" : "N121",
  "description" : "",
  "region" : "region",
  "start_target_server" : true,
  "speed_limit" : 0,
  "use_public_ip" : true,
  "exist_server" : true,
  "isdefault" : true,
  "type" : "MIGRATE_BLOCK",
  "syncing" : false,
  "enterprise_project" : "default"
}
```
#### 响应示例
**状态码：200**
新建迁移项目成功
```
{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
}
```
**状态码：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代码示例如下。
- [Java]
  新建迁移项目。新的迁移项目名称是N121，region信息是region，使用公网ip是true，迁移项目类型是MIGRATE_BLOCK
  ```
  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 CreateMigprojectSolution {
      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();
          CreateMigprojectRequest request = new CreateMigprojectRequest();
          PostMigProjectBody body = new PostMigProjectBody();
          body.withSyncing(false);
          body.withEnterpriseProject("default");
          body.withType(PostMigProjectBody.PostMigProjectBody.fromValue("MIGRATE_BLOCK"));
          body.withExistServer(true);
          body.withUsePublicIp(true);
          body.withSpeedLimit(0);
          body.withStartTargetServer(true);
          body.withRegion("region");
          body.withIsdefault(true);
          body.withDescription("");
          body.withName("N121");
          request.withBody(body);
          try {
              CreateMigprojectResponse response = client.createMigproject(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]
  新建迁移项目。新的迁移项目名称是N121，region信息是region，使用公网ip是true，迁移项目类型是MIGRATE_BLOCK
  ```
  # 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 = CreateMigprojectRequest()
          request.body = PostMigProjectBody(
              syncing=False,
              enterprise_project="default",
              type="MIGRATE_BLOCK",
              exist_server=True,
              use_public_ip=True,
              speed_limit=0,
              start_target_server=True,
              region="region",
              isdefault=True,
              description="",
              name="N121"
          )
          response = client.create_migproject(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]
  新建迁移项目。新的迁移项目名称是N121，region信息是region，使用公网ip是true，迁移项目类型是MIGRATE_BLOCK
  ```
  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, err := global.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := sms.SmsClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := sms.NewSmsClient(hcClient)
      request := &model.CreateMigprojectRequest{}
  syncingPostMigProjectBody:= false
  enterpriseProjectPostMigProjectBody:= "default"
  existServerPostMigProjectBody:= true
  usePublicIpPostMigProjectBody:= true
  speedLimitPostMigProjectBody:= int32(0)
  startTargetServerPostMigProjectBody:= true
  isdefaultPostMigProjectBody:= true
  descriptionPostMigProjectBody:= ""
  request.Body = &model.PostMigProjectBody{
  Syncing: &syncingPostMigProjectBody,
  EnterpriseProject: &enterpriseProjectPostMigProjectBody,
  Type: model.GetPostMigProjectBodyTypeEnum().MIGRATE_BLOCK,
  ExistServer: &existServerPostMigProjectBody,
  UsePublicIp: &usePublicIpPostMigProjectBody,
  SpeedLimit: &speedLimitPostMigProjectBody,
  StartTargetServer: &startTargetServerPostMigProjectBody,
  Region: "region",
  Isdefault: &isdefaultPostMigProjectBody,
  Description: &descriptionPostMigProjectBody,
  Name: "N121",
  }
  response, err := client.CreateMigproject(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMS/sdk?api=CreateMigproject)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述       |
|:---|:---|
| 200 | 新建迁移项目成功 |
| 403 | 鉴权失败     |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-sms/ErrorCode.html)。
