修改实例信息

接口说明


修改实例:实例名称、描述信息和密码信息。

注意事项:

  1. 如修改实例名称的时需要同时修改操作系统内部主机名称,则不支持中文,且状态运行中(active)的实例才可以进行。

  2. 修改实例信息、名称、描述和密码不能都为空。

  3. 弹性裸金属状态必须为已关机。

  4. 弹性裸金属需要开机后生效。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/modify-feature

请求参数

Body

参数名称
类型
必填
描述
instanceModifyFeatureReq
InstanceModifyFeatureReq
是

instanceModifyFeatureReq

instanceId
string
是

实例ID,可通过查询实例状态列表接口获取。

instanceName
string
否

实例名称。名称为5~59个字符,可包含英文、中文、数字,'-','-'不可在名称开头或末尾。

modifyHostName
boolean
否

是否同时修改操作系统内部主机名称。取值范围:

  • true:修改实例名称同时修改操作系统内部主机名称,此时实例名称不能包含中文。
  • false:仅修改实例名称。

默认值:false。

description
string
否

实例描述信息。主机描述,可输入[0,100]个字符。

password
string
否

实例密码。可参考批量创建实例接口password参数描述字段。

cpuOptions
CpuOptions
否

CPU自定义参数。

threadsPerCore
integer(int32)
否

CPU 线程数,仅部分规格支持,详见支持规格族列表。取值范围:

  • 1: 关闭超线程。
  • 2: 开启超线程。

默认值:2。

topologyType
string
否

CPU拓扑,仅部分规格支持,详见支持规格族列表。取值范围:

  • ContinuousCoreToHTMapping:HT连续模式。
  • DiscreteCoreToHTMapping:HT离散模式,仅当threadsPerCore为2时生效。

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/modify-feature
{
	"instanceName":"ECS-test123",
	"modifyHostName":false,
	"description":"ECS-testhao",
	"instanceId":"42fe7627-bf4b-4d82-bed4-1ed8775155r3"
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
<InstanceModifyFeatureResult> array

请求成功时返回的数据。

featureName
string

修改的信息名称。

message
string

操作结果信息,失败时返回错误信息,成功时返回空字符串。

result
boolean

操作是否下发成功。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
string

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"requestId":"reqId-dbee5d97774f4b90f32c4-457e7370-1",
	"state":"OK",
	"body":[
		{
			"result":true,
			"featureName":"description",
			"message":""
		},
		{
			"result":true,
			"featureName":"instanceName",
			"message":""
		}
	]
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。