修改实例ip - ModifyInstanceIp
功能介绍
用户可选择指定的 iMetal 实例,修改ip。
接口约束:iMetal 实例处于就绪状态(已调测成功)或修改ip失败同时为下电状态。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/instances/{id}/ip
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
|
id |
是 |
String |
参数解释: 实例ID, 创建实例CreateInstance请求响应返回的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
vpc_id |
否 |
String |
参数解释: 创建网卡所属的 VPC ID,可通过 VPC API 查询:https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html。 约束限制: 不涉及 取值范围: VPC ID 默认取值: 不涉及 |
|
nics |
否 |
Array of Nic objects |
参数解释: 网卡信息列表 约束限制: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
subnet_id |
是 |
String |
参数解释: 创建网卡所属 CloudDCN 子网 ID,可通过 CloudDCN API 查询:https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html。 约束限制: 不涉及 取值范围: CloudDCN 子网 ID 默认取值: 不涉及 |
|
ip_address |
否 |
String |
参数解释: 创建网卡指定静态IP,批量安装时,该参数不生效。不填或空字符串,默认在子网(subnet)中自动分配一个未使用的IP作网卡的IP地址。若指定IP地址,该IP地址必须在子网(subnet)对应的网段内,且未被使用。 约束限制: 不涉及 取值范围: 子网静态IP 默认取值: 不涉及 |
响应参数
状态码:202
修改ip请求成功
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码 |
|
error_msg |
String |
参数解释: 错误描述 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码 |
|
error_msg |
String |
参数解释: 错误描述 |
状态码:429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
- |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码 |
|
error_msg |
String |
参数解释: 错误描述 |
请求示例
修改实例ip
PUT https://{endpoint}/v1/{project_id}/instances/{id}/ip
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
修改ip请求成功 |
|
400 |
请求参数错误,请求失败 |
|
401 |
请求未鉴权 |
|
429 |
请求过载 |
|
500 |
服务端内部错误 |
错误码
请参见错误码。