ModifyMigrationJobAttribute - 修改迁移任务基础信息--服务器迁移中心-火山引擎

文档中心

立即注册

导航

ModifyMigrationJobAttribute - 修改迁移任务基础信息

最近更新时间：2024.11.27 14:01:37首次发布时间：2023.12.01 10:18:20

调用 ModifyMigrationJobAttribute 接口，修改迁移任务基础信息。

请求说明

调用该接口时，如不传入可选参数，则保持原有配置。

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyMigrationJobAttribute	要执行的操作，取值：ModifyMigrationJobAttribute。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
NetworkTransitionMode	String	否	PublicNetwork	网络传输模式。取值： PublicNetwork：公网传输。 VPC：内网传输。
Bandwidth	Integer	否	0	网络传输带宽，单位Mbps。最小值（默认）为`0`，表示不限速。
MigrationJobDescription	String	否	迁移本地虚拟机	任务描述。必须以字母或中文开头。只能包含中文、字母、数字、点号“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。” 长度限制在255个字符以内。说明若传入空字符串，将清空原有描述信息。
MigrationJobId	String	是	job-3tiegs1y963vj0****	迁移任务ID。您可以调用DescribeMigrationJobs接口查询获取。
MigrationJobName	String	否	VM迁移至ECS	任务名称。以字母或中文开头。只能包含中文、字母、数字、下划线“_”、中划线“-”和点号“.”。长度限制为1～128个字符。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
MigrationJobId	String	job-3tiegs1y963vj0****	迁移任务ID。

请求示例

GET /?Action=ModifyMigrationJobAttribute&Version=2020-04-01&MigrationJobId=job-3tiegs1y963vj0****&MigrationJobName=VM迁移至ECS HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: smc

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306021637410F150D*****",
    "Action": "ModifyMigrationJobAttribute",
    "Version": "2020-04-01",
    "Service": "smc",
    "Region": "cn-beijing"
  },
  "Result": {
    "MigrationJobId": "job-3tiegs1y963vj0******"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidMigrationJobDescription.Malformed	The specified MigrationJobDescription is malformed.	指定的MigrationJobDescription不合法。
400	InvalidMigrationJobName.Malformed	The specified MigrationJobName is malformed.	指定的MigrationJobName不合法。
400	LimitExceeded.MinimumBandwidth	The number of specified Bandwidth exceeds the minimum limit.	指定的Bandwidth超过最小限制。
400	MissingParameter.MigrationJobId	The required parameter MigrationJobId is not supplied.	参数MigrationJobId不能为空。
404	InvalidActionOrVersion	Could not find operation %s for version %s.	请求接口不存在。
404	InvalidMigrationJob.NotFound	The specified migration job does not exist.	指定的迁移任务不存在。