更新云服务器实例 | 大装置帮助中心
跳到主要内容

更新云服务器实例

PATCH /compute/ecs/v2/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/virtualMachines/{virtual_machine_name}

请求头（Request Header）​

参考认证（authentication）

请求参数（Request Parameters）​

名称类型必须位置默认值取值范围描述
subscription_namestring是path--订阅名称
resource_group_namestring是path--资源组
zonestring是path--可用区
virtual_machine_namestring是path--云服务器实例名
update_maskstring否query--更新标记，当前支持更新 display_name、properties.metadata、properties.hostname。多个字段用逗号分隔，例如：display_name,properties.hostname

请求体（Request Body）​

名称类型必须默认值取值范围描述
display_namestring否--云服务器实例显示名称, 需符合正则：^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
propertiesobject否--云服务器实例属性

其中，properties 的参数如下

名称类型必须默认值取值范围描述
hostnamestring否--主机名称
metadataobject否--元数据

其中，metadata 的参数如下

名称类型描述
itemsarray[object]键值对数组

其中，items 的 object 参数如下

名称类型描述
keystring元数据条目的键
valuestring元数据条目的值

请求示例（Request Example）​

curl -XPATCH 'https://management.cn-sh-02.sensecoreapi.cn/compute/ecs/v2/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/default/zones/cn-sh-02a/virtualMachines/ecs-xxxxxxxxxx?update_mask=display_name,properties.hostname,properties.metadata' -d '{
    "display_name": "ecstestupdated",
    "properties": {
        "hostname": "ecs-xxxxxxxxxx-updated",
        "metadata": {
            "items": [
                {
                    "key": "key2",
                    "value": "value2"
                }
            ]
        }
    }
}'

响应（Response）​

名称类型描述
idstring云服务器实例 ID
namestring云服务器实例名称
uidstring云服务器实例 UID
display_namestring云服务器实例显示名称
descriptionstring云服务器实例描述
resource_typestring资源类型
creator_idstring云服务器实例创建者 ID
owner_idstring云服务器实例所有者 ID
tenant_idstring租户 ID
zonestring可用区
statestring云服务器实例状态
sku_idstring最小库存单元 ID
tagsobject云服务器实例标签
propertiesobject云服务器实例属性
order_infoobject订单信息
create_timestring云服务器实例创建时间
update_timestring云服务器实例更新时间
deletedboolean云服务器实例是否删除

其中，state 有如下情况

状态含义
STATE_UNSPECIFIED未指定
CREATING云服务器创建中
STARTING云服务器启动中
RUNNING云服务器运行中
UPDATING云服务器更新中
STOPPING云服务器停止中
STOPPED云服务器已停止，计算资源保留
TERMINATING云服务器终止中
TERMINATED云服务器已终止，计算资源释放
DELETING云服务器删除中
DELETED云服务器已删除，无法恢复
ERROR云服务器故障

其中，properties 的参数如下

名称类型描述
machine_typestring机器类型，例如：g1i.24xlarge
hostnamestring主机名
metadataobject元数据
network_interfacesarray[object]网络接口信息列表
disksarray[object]磁盘信息列表
volume_mountsarray[object]卷挂载信息列表
virtual_machine_typestring云服务器类型
image_idstring镜像 ID

其中，metadata 的参数如下

名称类型描述
itemsarray[object]键值对数组

其中，items 的 object 参数如下

名称类型描述
keystring元数据条目的键
valuestring元数据条目的值

其中，network_interfaces 的 object 参数如下

名称类型描述
uidstring弹性网卡 UID
propertiesobject弹性网卡属性

其中，properties 的参数如下

名称类型描述
subnet_info.uidstring弹性网卡所属 Subnet UID
vpc_info.uidstring弹性网卡所属 VPC UID

其中，disks 的 object 参数如下

名称类型描述
uidstring磁盘 UID
propertiesobject磁盘属性

其中，properties 的参数如下

状态含义
resources.billing_items.capacityint32
resources.billing_items.capacity_unitstring
resources.disk_typestring
resources.system_diskboolean
resources.ecs_lifecycleboolean

其中，resources.billing_items.capacity_unit 有如下情况

状态含义
EB容量单位 EB
PB容量单位 PB
TB容量单位 TB
GB容量单位 GB
MB容量单位 MB

其中，resources.disk_type 有如下情况

状态含义
CLOUDEFFICIENCY高效云盘
CLOUDSSDSSD 云盘
CLOUDOCEANSTOROceanStor 云盘

其中，volume_mounts 的 object 参数如下

名称类型描述
typestring挂载类型
idstring卷 ID
mount_pathstring挂载路径
subdirstring卷内的子目录
zonestring可用区

其中，type 有如下情况

状态含义
MOUNT_TYPE_UNSPECIFIED未知挂载类型，当前不支持。
PV_AFS使用 AFS 的持久卷

其中，virtual_machine_type 有如下情况

状态含义
VIRTUAL_MACHINE_TYPE_UNSPECIFIED未指定
VM虚拟机
BM_CLASSICAL传统裸金属
BM_DPUDPU 裸金属

其中，order_info 的参数如下

名称类型描述
order_idstring订单 ID
billing_cycle_numberint32购买时长
auto_renewboolean自动续费
currency_codestring货币代码
payment_channelstring支付方式
notestring订单备注
order_typestring订单类型
payment_modelstring付费类型
billing_modelstring计费类型
original_idstring合同包 ID
start_timestring订单生效日期
end_timestring订单结束时间
auto_convert_postpaidboolean是否为预付费自动转后付费

其中，payment_channel 有如下情况

状态含义
PC_UNSPECIFIED未指定
PC_BALANCE余额支付
PC_CREDIT信用支付
PC_FROZENACCOUNT冻结款支付
PC_REMIT_OFFLINE线下汇款
PC_ALIPAY支付宝支付
PC_UNIONPAY银联支付
PC_REMIT_ONLINE在线转账
PC_CONTRACT合同包支付

其中，order_type 有如下情况

状态含义
OT_UNSPECIFIED未指定
OT_ORIGINAL原始订单
OT_RENEW续费订单
OT_UPGRADED升配订单
OT_DOWNGRADED降配订单
OT_CONTRACT合同订单
OT_UNSUBSCRIBE退订订单
OT_RESIZE扩缩容订单

其中，payment_model 有如下情况

状态含义
PM_UNSPECIFIED未指定
PM_PREPAID预付
PM_POSTPAID后付费

其中，billing_model 有如下情况

状态含义
BM_UNSPECIFIED未指定
BM_USAGE按量计费
BM_MONTHLY包月
BM_YEARLY包年

响应示例（Response Example）​

{
    "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/default/zones/cn-sh-02a/virtualMachines/ecs-xxxxxxxxxx",
    "name": "ecs-xxxxxxxxxx",
    "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "display_name": "ecstestupdated",
    "description": "",
    "resource_type": "compute.ecs.v2.virtualMachine",
    "creator_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "owner_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "zone": "cn-sh-02a",
    "state": "RUNNING",
    "sku_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "tags": {},
    "properties": {
        "machine_type": "c1.small",
        "hostname": "ecs-xxxxxxxxxx-updated",
        "metadata": {
            "items": [
                {
                    "key": "key2",
                    "value": "value2"
                }
            ]
        },
        "network_interfaces": [
            {
                "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "properties": {
                    "subnet_info": {
                        "uid": "019ab560-93f6-7037-acdf-876c79c6f65d"
                    },
                    "vpc_info": {
                        "uid": "019ab560-77f5-7df4-88b5-bb9dca36d6c1"
                    }
                }
            }
        ],
        "disks": [
            {
                "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "properties": {
                    "resources": {
                        "billing_items": {
                            "capacity": 40,
                            "capacity_unit": "GB"
                        },
                        "disk_type": "CLOUDEFFICIENCY",
                        "system_disk": true,
                        "ecs_lifecycle": true
                    }
                }
            },
            {
                "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "properties": {
                    "resources": {
                        "billing_items": {
                            "capacity": 40,
                            "capacity_unit": "GB"
                        },
                        "disk_type": "CLOUDEFFICIENCY",
                        "system_disk": false,
                        "ecs_lifecycle": false
                    }
                }
            }
        ],
        "volume_mounts": [
            {
                "type": "PV_AFS",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "mount_path": "/mnt/data",
                "subdir": "/",
                "zone": "cn-sh-02a"
            }
        ],
        "virtual_machine_type": "VM",
        "image_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "order_info": {
        "order_id": "xxxxxxxxxx",
        "billing_cycle_number": 1,
        "auto_renew": false,
        "currency_code": "CNY",
        "payment_channel": "PC_UNSPECIFIED",
        "note": "",
        "order_type": "OT_ORIGINAL",
        "payment_model": "PM_PREPAID",
        "billing_model": "BM_MONTHLY",
        "original_id": "",
        "start_time": "2024-01-01T12:00:00Z",
        "end_time": null,
        "auto_convert_postpaid": false
    },
    "create_time": "2024-01-01T12:00:00.000000Z",
    "update_time": "2024-01-01T12:00:00.000000Z",
    "deleted": false
}