更新云服务器实例

更新云服务器实例

Path Parameters

subscription_name string required

订阅

resource_group_name string required

资源组

zone string required

可用区

ecs_instance_name string required

实例名称

Query Parameters

update_mask field-mask

更新字段掩码

application/json

Request Body required

id string required

资源id

name string required

资源名

display_name string

Possible values: <= 63 characters

资源显示的名称

description string

实例资源描述

uid string required

实例资源uuid

resource_type string

资源类型

creator_id string

ECS实例资源的创建用户id

owner_id string

ECS实例资源的所有者用户id

tenant_id string

租户id

zone string required

可用区

state enum

Possible values: [CREATING, RUNNING, STOPPING, STOPPED, BOOTING, REBOOTING, RESETTING, DELETING, DELETED, FAILED, UPDATING]

ECS实例的状态

sku_id string required

Sku id

tags object
附加到ECS实例资源的标签
property name* string
properties object
云服务器实例特性
resource object required
规格属性 [不可更改]
compute_type enum
Possible values: [GPU, CPU]
计算类型
gpu_type string
GPU型号
cpu_type string
CPU型号
cpu_frequency string
CPU频率
gpu string
GPU卡数
cpu string
CPU核数
memory string
内存规格，单位GB
gpu_vram string
GPU显存, 单位GB
image object required
镜像
name string required
镜像名称
distros string
发行版 [Rocky/Ubuntu/OpenEuler/Windows]
version string
发行版本号
description string
镜像描述
image_type enum required
Possible values: [OFFICIAL, PRIVATE]
镜像类型
architecture enum
Possible values: [X86_64, AARCH64]
架构
uuid string required
Disk uuid
snapshot_id string required
快照 id
creator_id string
镜像创建人
patch_tag string required
镜像补丁标识
deleted boolean required
是否删除
tenant_id string
租户id
zone string
可用区
state enum
Possible values: [IS_UNKNOWN, IS_WAITING, IS_CREATING, IS_AVAILABLE, IS_FAILED, IS_UNAVAILABLE]
镜像状态
compute_type enum
Possible values: [CT_UNKNOWN, CT_CPU, CT_GPU]
镜像计算类型
id string
ID
size uint32
镜像大小
abs_image_id string
ABS镜像ID
hostname string
主机名
ssh_user string required
SSH用户名
ssh_password string required
SSH密码
key_pairs string[]
密钥对
vpc object required
虚拟专有网络
vpc_name string required
专有网络名称
namespace string
命名空间
environments object
环境变量
property name* string
network_interfaces object[] required
网络接口列表信息
Array [
vnic_id string required
网络UUID
name string
网络接口名称
subnet string
子网信息
private_ip string
私有网络ip地址
mac_address string
MAC地址
primary boolean
是否是主网卡
]
disks object[] required
磁盘列表信息
Array [
uuid string
存储磁盘UUID
sku_id string
块存储Sku id
disk_type enum
Possible values: [SYSTEM, DATA]
磁盘类型
disk_size int32
磁盘空间大小
disk_category string
磁盘种类：SSD, 高速云盘
description string
描述信息
lifecycle boolean
生命周期, true表示随ecs实例生命周期释放
mount_point string
挂载点
]
user_data bytes
用户自定义数据, 需要使用base64编码, 原始数据不能超过16KB
stop_mode enum
Possible values: [BILLING, SAVE]
停机模式
volume_mounts object[]
卷挂载
Array [
type enum required
Possible values: [MOUNT_TYPE_UNSPECIFIED, PV_AFS, PV_ACS, PV_AFS_MODEL, PV_AFS_TENSORBOARD]
挂载类型
id string required
卷 ID
mount_path string required
挂载路径
subdir string
卷内的子目录
zone string
可用区
endpoint string
端点
]
metadata object
元数据。 支持的元数据键: - access-key: 用户访问密钥。 - secret-key: 用户私密密钥
items object[]
键值对数组
Array [
key string
元数据条目的键
value string
元数据条目的值
]
order_info object

订单信息

billing_cycle_number int32

购买时长

auto_renew boolean

自动续费

currency_code string

货币代码

payment_channel enum

Possible values: [PC_UNSPECIFIED, PC_BALANCE, PC_CREDIT, PC_FROZENACCOUNT, PC_REMIT_OFFLINE, PC_ALIPAY, PC_UNIONPAY, PC_REMIT_ONLINE, PC_CONTRACT, PC_WECHAT, PC_PACKAGE]

支付方式

note string

订单备注

order_type enum

Possible values: [OT_UNSPECIFIED, OT_ORIGINAL, OT_RENEW, OT_UPGRADED, OT_DOWNGRADED, OT_CONTRACT, OT_UNSUBSCRIBE, OT_RESIZE, OT_MUTATIO, OT_CONTRACT_RENEW]

订单类型

order_id string

订单id

start_time date-time

订单生效日期

payment_model enum

Possible values: [PM_UNSPECIFIED, PM_PREPAID, PM_POSTPAID]

付费类型

billing_model enum

Possible values: [BM_UNSPECIFIED, BM_USAGE, BM_MONTHLY, BM_YEARLY]

计费类型

original_id string

合同包ID

end_time date-time

订单结束时间

auto_convert_postpaid boolean

预付费自动转后付费

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

id string required

资源id

name string required

资源名

display_name string

Possible values: <= 63 characters

资源显示的名称

description string

实例资源描述

uid string required

实例资源uuid

resource_type string

资源类型

creator_id string

ECS实例资源的创建用户id

owner_id string

ECS实例资源的所有者用户id

tenant_id string

租户id

zone string required

可用区

state enum

Possible values: [CREATING, RUNNING, STOPPING, STOPPED, BOOTING, REBOOTING, RESETTING, DELETING, DELETED, FAILED, UPDATING]

ECS实例的状态

sku_id string required

Sku id

tags object
附加到ECS实例资源的标签
property name* string
properties object
云服务器实例特性
resource object required
规格属性 [不可更改]
compute_type enum
Possible values: [GPU, CPU]
计算类型
gpu_type string
GPU型号
cpu_type string
CPU型号
cpu_frequency string
CPU频率
gpu string
GPU卡数
cpu string
CPU核数
memory string
内存规格，单位GB
gpu_vram string
GPU显存, 单位GB
image object required
镜像
name string required
镜像名称
distros string
发行版 [Rocky/Ubuntu/OpenEuler/Windows]
version string
发行版本号
description string
镜像描述
image_type enum required
Possible values: [OFFICIAL, PRIVATE]
镜像类型
architecture enum
Possible values: [X86_64, AARCH64]
架构
uuid string required
Disk uuid
snapshot_id string required
快照 id
creator_id string
镜像创建人
patch_tag string required
镜像补丁标识
deleted boolean required
是否删除
tenant_id string
租户id
zone string
可用区
state enum
Possible values: [IS_UNKNOWN, IS_WAITING, IS_CREATING, IS_AVAILABLE, IS_FAILED, IS_UNAVAILABLE]
镜像状态
compute_type enum
Possible values: [CT_UNKNOWN, CT_CPU, CT_GPU]
镜像计算类型
id string
ID
size uint32
镜像大小
abs_image_id string
ABS镜像ID
hostname string
主机名
ssh_user string required
SSH用户名
ssh_password string required
SSH密码
key_pairs string[]
密钥对
vpc object required
虚拟专有网络
vpc_name string required
专有网络名称
namespace string
命名空间
environments object
环境变量
property name* string
network_interfaces object[] required
网络接口列表信息
Array [
vnic_id string required
网络UUID
name string
网络接口名称
subnet string
子网信息
private_ip string
私有网络ip地址
mac_address string
MAC地址
primary boolean
是否是主网卡
]
disks object[] required
磁盘列表信息
Array [
uuid string
存储磁盘UUID
sku_id string
块存储Sku id
disk_type enum
Possible values: [SYSTEM, DATA]
磁盘类型
disk_size int32
磁盘空间大小
disk_category string
磁盘种类：SSD, 高速云盘
description string
描述信息
lifecycle boolean
生命周期, true表示随ecs实例生命周期释放
mount_point string
挂载点
]
user_data bytes
用户自定义数据, 需要使用base64编码, 原始数据不能超过16KB
stop_mode enum
Possible values: [BILLING, SAVE]
停机模式
volume_mounts object[]
卷挂载
Array [
type enum required
Possible values: [MOUNT_TYPE_UNSPECIFIED, PV_AFS, PV_ACS, PV_AFS_MODEL, PV_AFS_TENSORBOARD]
挂载类型
id string required
卷 ID
mount_path string required
挂载路径
subdir string
卷内的子目录
zone string
可用区
endpoint string
端点
]
metadata object
元数据。 支持的元数据键: - access-key: 用户访问密钥。 - secret-key: 用户私密密钥
items object[]
键值对数组
Array [
key string
元数据条目的键
value string
元数据条目的值
]
order_info object

订单信息

billing_cycle_number int32

购买时长

auto_renew boolean

自动续费

currency_code string

货币代码

payment_channel enum

Possible values: [PC_UNSPECIFIED, PC_BALANCE, PC_CREDIT, PC_FROZENACCOUNT, PC_REMIT_OFFLINE, PC_ALIPAY, PC_UNIONPAY, PC_REMIT_ONLINE, PC_CONTRACT, PC_WECHAT, PC_PACKAGE]

支付方式

note string

订单备注

order_type enum

Possible values: [OT_UNSPECIFIED, OT_ORIGINAL, OT_RENEW, OT_UPGRADED, OT_DOWNGRADED, OT_CONTRACT, OT_UNSUBSCRIBE, OT_RESIZE, OT_MUTATIO, OT_CONTRACT_RENEW]

订单类型

order_id string

订单id

start_time date-time

订单生效日期

payment_model enum

Possible values: [PM_UNSPECIFIED, PM_PREPAID, PM_POSTPAID]

付费类型

billing_model enum

Possible values: [BM_UNSPECIFIED, BM_USAGE, BM_MONTHLY, BM_YEARLY]

计费类型

original_id string

合同包ID

end_time date-time

订单结束时间

auto_convert_postpaid boolean

预付费自动转后付费

{
  "id": "string",
  "name": "string",
  "display_name": "string",
  "description": "string",
  "uid": "string",
  "resource_type": "string",
  "creator_id": "string",
  "owner_id": "string",
  "tenant_id": "string",
  "zone": "string",
  "state": "CREATING",
  "sku_id": "string",
  "tags": {},
  "properties": {
    "resource": {
      "compute_type": "GPU",
      "gpu_type": "string",
      "cpu_type": "string",
      "cpu_frequency": "string",
      "gpu": "string",
      "cpu": "string",
      "memory": "string",
      "gpu_vram": "string"
    },
    "image": {
      "name": "string",
      "distros": "string",
      "version": "string",
      "description": "string",
      "image_type": "OFFICIAL",
      "architecture": "X86_64",
      "uuid": "string",
      "snapshot_id": "string",
      "creator_id": "string",
      "patch_tag": "string",
      "deleted": true,
      "create_time": "2025-12-09T07:25:03.851Z",
      "update_time": "2025-12-09T07:25:03.851Z",
      "tenant_id": "string",
      "zone": "string",
      "state": "IS_UNKNOWN",
      "compute_type": "CT_UNKNOWN",
      "id": "string",
      "size": 0,
      "abs_image_id": "string"
    },
    "hostname": "string",
    "ssh_user": "string",
    "ssh_password": "string",
    "key_pairs": [
      "string"
    ],
    "vpc": {
      "vpc_name": "string",
      "namespace": "string"
    },
    "environments": {},
    "network_interfaces": [
      {
        "vnic_id": "string",
        "name": "string",
        "subnet": "string",
        "private_ip": "string",
        "mac_address": "string",
        "primary": true
      }
    ],
    "disks": [
      {
        "uuid": "string",
        "sku_id": "string",
        "disk_type": "SYSTEM",
        "disk_size": 0,
        "disk_category": "string",
        "description": "string",
        "lifecycle": true,
        "mount_point": "string"
      }
    ],
    "user_data": "string",
    "stop_mode": "BILLING",
    "volume_mounts": [
      {
        "type": "MOUNT_TYPE_UNSPECIFIED",
        "id": "string",
        "mount_path": "string",
        "subdir": "string",
        "zone": "string",
        "endpoint": "string"
      }
    ],
    "metadata": {
      "items": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  },
  "order_info": {
    "billing_cycle_number": 0,
    "auto_renew": true,
    "currency_code": "string",
    "payment_channel": "PC_UNSPECIFIED",
    "note": "string",
    "order_type": "OT_UNSPECIFIED",
    "order_id": "string",
    "start_time": "2025-12-09T07:25:03.851Z",
    "payment_model": "PM_UNSPECIFIED",
    "billing_model": "BM_UNSPECIFIED",
    "original_id": "string",
    "end_time": "2025-12-09T07:25:03.851Z",
    "auto_convert_postpaid": true
  },
  "deleted": true,
  "create_time": "2025-12-09T07:25:03.851Z",
  "update_time": "2025-12-09T07:25:03.851Z"
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...