更新云服务器

更新云服务器

Path Parameters

subscription_name string required

订阅名称

resource_group_name string required

资源组名称

zone string required

可用区

virtual_machine_name string required

云服务器名称

Query Parameters

update_mask field-mask

更新字段掩码

request_id string

请求 id

application/json

Request Body required

display_name string

云服务器显示名称

description string

云服务器描述

resource_type string

资源类型

zone string required

可用区

sku_id string required

最小库存单元ID

tags object
云服务器标签
property name* string
properties object

云服务器属性

machine_type string required

机器类型。 例如：g1i.24xlarge

hostname string

主机名

metadata object

元数据。元数据键区分大小写。 预定义的元数据键是由系统创建。创建云服务器时，系统会自动设置该云服务器上某些键的元数据值。示例： - UID：对应的值记录云服务器UID。 自定义元数据键是由用户创建。支持添加新的自定义元数据键，更新现有键的值，以及移除不需要的任何 自定义元数据条目。示例： - login-credentials：对应的值记录用户ssh登录的账号密码，例如 {username}:{password}。 - startup-script：对应的值记录大小最大为256KB的bash启动脚本, 可用来完成实例启动时配置。 - ssh-keys：对应的值记录用户ssh登录的公钥，用分号隔开，例如 {public_key1};{public_key2};...。 - ssh-key-ids： 对应的值记录用户ssh登录的密钥对ID，用分号隔开，例如 {ssh_key_id1};{ssh_key_id2};...。 - access-key：对应的值记录用户访问密钥。 - secret-key：对应的值记录用户私密密钥。 - security-enhancement：对应的值记录安全增强功能，例如 true代表开启，false代表关闭，默认值为true

items object[]

键值对数组

Array [

key string

元数据条目的键

value string

元数据条目的值

]

network_interfaces object[] required

网络接口信息列表

Array [

display_name string

资源名称

description string

资源描述

resource_type string

资源类型

creator_id string

创建者id

owner_id string

拥有者id

tenant_id string

租户id

zone string

可用区

sku_id string

最小库存单元id

tags object

弹性网卡资源的标签

property name* string

properties object

弹性网卡资源的属性

resources object

资源规格属性

billing_items object

单独购买的计费项

capacity int32

创建块存储资源容量

capacity_unit enum

Possible values: [EB, PB, TB, GB, MB]

创建块存储资源容量单位

disk_type enum

Possible values: [CLOUDEFFICIENCY, CLOUDSSD, CLOUDOCEANSTOR]

资源包存储类型

system_disk boolean

是否是系统盘

ecs_lifecycle boolean

是否随ecs实例释放

snapshot_id string

根据指定的快照id进行盘的创建

image_id string

根据指定的镜像id进行盘的创建

subnet_info object

subnet 信息

uid string required

Subnet 的uid

roce_rail_num string

RoCE轨道号，训练网专用

protocol string

协议类型：IPv4，IPv6 或者 Dual

ip_v4_addr string

IPv4 地址

ip_v6_addr string

IPv6地址

mac_addr string

Mac 地址

vpc_info object

vpc 信息

uid string

VPC 的uid

name string

名称

display_name 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

预付费自动转后付费

]

disks object[]

磁盘信息列表

Array [

id string required

块存储资源 id

name string required

块存储资源名称

display_name string

块存储资源别名

description string

块存储资源描述

uid string required

块存储资源的uuid

resource_type string

块存储资源的资源类型

creator_id string

创建DiskStorage resource的用户id

owner_id string

拥有DiskStorage resource的用户id

tenant_id string

租户id

zone string required

可用区

state enum

Possible values: [CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, EXPIREDOWNGRADING, EXPIREDOWNGRADED, RENEWUPGRADING, EXPIRESTOPPING, EXPIRESTOPPED, RENEWSTARTING, DOWNGRADING, DOWNGRADE, RESTORING, ATTACHING, INUSE, DETACHING, DETACHFAILED, ATTACHFAILED, DELETEDFAILED, RESIZING, RESIZEFAILED, ARREARSTOPPING, ARREARSTOPPED, RECHARGESTARTING, RESIZECANCELING]

块存储资源状态

sku_id string

最小库存单元id

tags object

块存储资源的标签

property name* string

properties object

块存储资源的属性

resources object

资源

billing_items object

单独购买的计费项

capacity int32

创建块存储资源容量

capacity_unit enum

Possible values: [EB, PB, TB, GB, MB]

创建块存储资源容量单位

disk_type enum

Possible values: [CLOUDEFFICIENCY, CLOUDSSD, CLOUDOCEANSTOR]

资源包存储类型

system_disk boolean

是否是系统盘

ecs_lifecycle boolean

是否随ecs实例释放

snapshot_id string

根据指定的快照id进行盘的创建

image_id string

根据指定的镜像id进行盘的创建

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

预付费自动转后付费

deleted boolean

是否删除块存储资源

create_time date-time

创建块存储资源资源的时间

update_time date-time

上一次更新DiskStorage resource的时间

]

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

端点

]

dnat_rules object[]

DNAT规则列表

Array [

subscription_name string

订阅

resource_group_name string

资源组

zone string

可用区

nat_gw_name string required

natgw名

dnat_rule_name string

dnat规则名, ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

dnat_rule object

dnat规则

id string

DnatRule资源id

name string required

DnatRule名

display_name string

DnatRule前端展示名

description string

DnatRule说明

uid string

DnatRule的uuid

resource_type string

DNATrule资源类型

creator_id string

创建该DnatRule规则的用户id

owner_id string

拥有该DnatRule资源的用户id

tenant_id string

租户id

zone string

可用区

state enum

Possible values: [STATE_UNSPECIFIED, CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED]

DnatRule当前的状态

tags object

DnatRule资源标签

property name* string

properties object

DnatRule 属性

eip_name string required

EIP 名称

external_ip string required

EIP IP

external_port string

对外暴露的端口

protocol string required

对外暴露的协议

internal_ip string

对外暴露的 VPC 内服务的 IP, type非IP时，该字段选填

internal_port string

对内暴露的端口

internal_instance_type enum required

Possible values: [INSTANCE_TYPE_UNSPECIFIED, IP, ECS, BMS, AIS, ECP]

对外暴露的 VPC内服务的实例类型

internal_instance_uid string

对外暴露的 VPC内服务的实例唯一标识,目前使用实例uid作为唯一标识，type为IP，该字段选填，ECS、BMS、AIS则这里是ENI的uid

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

预付费自动转后付费

deleted boolean

指明DnatRule是否已删除

create_time date-time

DnatRule资源的创建时间

update_time date-time

DnatRule资源的更新时间

request_id string

该请求的唯一标识符。限制为36个ASCII字符。建议使用随机UUID。 只有当提供了'request_id'时，此请求才是幂等的

]

image_id string required

镜像ID

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

display_name string

云服务器显示名称

description string

云服务器描述

resource_type string

资源类型

zone string required

可用区

sku_id string required

最小库存单元ID

tags object
云服务器标签
property name* string
properties object

云服务器属性

machine_type string required

机器类型。 例如：g1i.24xlarge

hostname string

主机名

metadata object

元数据。元数据键区分大小写。 预定义的元数据键是由系统创建。创建云服务器时，系统会自动设置该云服务器上某些键的元数据值。示例： - UID：对应的值记录云服务器UID。 自定义元数据键是由用户创建。支持添加新的自定义元数据键，更新现有键的值，以及移除不需要的任何 自定义元数据条目。示例： - login-credentials：对应的值记录用户ssh登录的账号密码，例如 {username}:{password}。 - startup-script：对应的值记录大小最大为256KB的bash启动脚本, 可用来完成实例启动时配置。 - ssh-keys：对应的值记录用户ssh登录的公钥，用分号隔开，例如 {public_key1};{public_key2};...。 - ssh-key-ids： 对应的值记录用户ssh登录的密钥对ID，用分号隔开，例如 {ssh_key_id1};{ssh_key_id2};...。 - access-key：对应的值记录用户访问密钥。 - secret-key：对应的值记录用户私密密钥。 - security-enhancement：对应的值记录安全增强功能，例如 true代表开启，false代表关闭，默认值为true

items object[]

键值对数组

Array [

key string

元数据条目的键

value string

元数据条目的值

]

network_interfaces object[] required

网络接口信息列表

Array [

display_name string

资源名称

description string

资源描述

resource_type string

资源类型

creator_id string

创建者id

owner_id string

拥有者id

tenant_id string

租户id

zone string

可用区

sku_id string

最小库存单元id

tags object

弹性网卡资源的标签

property name* string

properties object

弹性网卡资源的属性

resources object

资源规格属性

billing_items object

单独购买的计费项

capacity int32

创建块存储资源容量

capacity_unit enum

Possible values: [EB, PB, TB, GB, MB]

创建块存储资源容量单位

disk_type enum

Possible values: [CLOUDEFFICIENCY, CLOUDSSD, CLOUDOCEANSTOR]

资源包存储类型

system_disk boolean

是否是系统盘

ecs_lifecycle boolean

是否随ecs实例释放

snapshot_id string

根据指定的快照id进行盘的创建

image_id string

根据指定的镜像id进行盘的创建

subnet_info object

subnet 信息

uid string required

Subnet 的uid

roce_rail_num string

RoCE轨道号，训练网专用

protocol string

协议类型：IPv4，IPv6 或者 Dual

ip_v4_addr string

IPv4 地址

ip_v6_addr string

IPv6地址

mac_addr string

Mac 地址

vpc_info object

vpc 信息

uid string

VPC 的uid

name string

名称

display_name 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

预付费自动转后付费

]

disks object[]

磁盘信息列表

Array [

id string required

块存储资源 id

name string required

块存储资源名称

display_name string

块存储资源别名

description string

块存储资源描述

uid string required

块存储资源的uuid

resource_type string

块存储资源的资源类型

creator_id string

创建DiskStorage resource的用户id

owner_id string

拥有DiskStorage resource的用户id

tenant_id string

租户id

zone string required

可用区

state enum

Possible values: [CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, EXPIREDOWNGRADING, EXPIREDOWNGRADED, RENEWUPGRADING, EXPIRESTOPPING, EXPIRESTOPPED, RENEWSTARTING, DOWNGRADING, DOWNGRADE, RESTORING, ATTACHING, INUSE, DETACHING, DETACHFAILED, ATTACHFAILED, DELETEDFAILED, RESIZING, RESIZEFAILED, ARREARSTOPPING, ARREARSTOPPED, RECHARGESTARTING, RESIZECANCELING]

块存储资源状态

sku_id string

最小库存单元id

tags object

块存储资源的标签

property name* string

properties object

块存储资源的属性

resources object

资源

billing_items object

单独购买的计费项

capacity int32

创建块存储资源容量

capacity_unit enum

Possible values: [EB, PB, TB, GB, MB]

创建块存储资源容量单位

disk_type enum

Possible values: [CLOUDEFFICIENCY, CLOUDSSD, CLOUDOCEANSTOR]

资源包存储类型

system_disk boolean

是否是系统盘

ecs_lifecycle boolean

是否随ecs实例释放

snapshot_id string

根据指定的快照id进行盘的创建

image_id string

根据指定的镜像id进行盘的创建

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

预付费自动转后付费

deleted boolean

是否删除块存储资源

create_time date-time

创建块存储资源资源的时间

update_time date-time

上一次更新DiskStorage resource的时间

]

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

端点

]

dnat_rules object[]

DNAT规则列表

Array [

subscription_name string

订阅

resource_group_name string

资源组

zone string

可用区

nat_gw_name string required

natgw名

dnat_rule_name string

dnat规则名, ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

dnat_rule object

dnat规则

id string

DnatRule资源id

name string required

DnatRule名

display_name string

DnatRule前端展示名

description string

DnatRule说明

uid string

DnatRule的uuid

resource_type string

DNATrule资源类型

creator_id string

创建该DnatRule规则的用户id

owner_id string

拥有该DnatRule资源的用户id

tenant_id string

租户id

zone string

可用区

state enum

Possible values: [STATE_UNSPECIFIED, CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED]

DnatRule当前的状态

tags object

DnatRule资源标签

property name* string

properties object

DnatRule 属性

eip_name string required

EIP 名称

external_ip string required

EIP IP

external_port string

对外暴露的端口

protocol string required

对外暴露的协议

internal_ip string

对外暴露的 VPC 内服务的 IP, type非IP时，该字段选填

internal_port string

对内暴露的端口

internal_instance_type enum required

Possible values: [INSTANCE_TYPE_UNSPECIFIED, IP, ECS, BMS, AIS, ECP]

对外暴露的 VPC内服务的实例类型

internal_instance_uid string

对外暴露的 VPC内服务的实例唯一标识,目前使用实例uid作为唯一标识，type为IP，该字段选填，ECS、BMS、AIS则这里是ENI的uid

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

预付费自动转后付费

deleted boolean

指明DnatRule是否已删除

create_time date-time

DnatRule资源的创建时间

update_time date-time

DnatRule资源的更新时间

request_id string

该请求的唯一标识符。限制为36个ASCII字符。建议使用随机UUID。 只有当提供了'request_id'时，此请求才是幂等的

]

image_id string required

镜像ID

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",
  "uid": "string",
  "display_name": "string",
  "description": "string",
  "resource_type": "string",
  "creator_id": "string",
  "owner_id": "string",
  "tenant_id": "string",
  "zone": "string",
  "state": "STATE_UNSPECIFIED",
  "sku_id": "string",
  "tags": {},
  "properties": {
    "machine_type": "string",
    "hostname": "string",
    "metadata": {
      "items": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "network_interfaces": [
      {
        "id": "string",
        "uid": "string",
        "name": "string",
        "display_name": "string",
        "description": "string",
        "resource_type": "string",
        "creator_id": "string",
        "owner_id": "string",
        "tenant_id": "string",
        "zone": "string",
        "state": "STATE_UNSPECIFIED",
        "sku_id": "string",
        "tags": {},
        "properties": {
          "resources": {
            "billing_items": {
              "capacity": 0,
              "capacity_unit": "EB"
            },
            "disk_type": "CLOUDEFFICIENCY",
            "system_disk": true,
            "ecs_lifecycle": true,
            "snapshot_id": "string",
            "image_id": "string"
          },
          "subnet_info": {
            "uid": "string",
            "name": "string",
            "display_name": "string",
            "gateway_ip": "string",
            "cluster_info": "string",
            "roce_rail_num": "string"
          },
          "protocol": "string",
          "ip_v4_addr": "string",
          "ip_v6_addr": "string",
          "mac_addr": "string",
          "gw_ip": "string",
          "gw_ipv6": "string",
          "mtu": 0,
          "instance": "string",
          "vpc_info": {
            "uid": "string",
            "name": "string",
            "display_name": "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.962Z",
          "payment_model": "PM_UNSPECIFIED",
          "billing_model": "BM_UNSPECIFIED",
          "original_id": "string",
          "end_time": "2025-12-09T07:25:03.962Z",
          "auto_convert_postpaid": true
        },
        "deleted": true,
        "create_time": "2025-12-09T07:25:03.962Z",
        "update_time": "2025-12-09T07:25:03.962Z"
      }
    ],
    "disks": [
      {
        "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": {
          "resources": {
            "billing_items": {
              "capacity": 0,
              "capacity_unit": "EB"
            },
            "disk_type": "CLOUDEFFICIENCY",
            "system_disk": true,
            "ecs_lifecycle": true,
            "snapshot_id": "string",
            "image_id": "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.963Z",
          "payment_model": "PM_UNSPECIFIED",
          "billing_model": "BM_UNSPECIFIED",
          "original_id": "string",
          "end_time": "2025-12-09T07:25:03.963Z",
          "auto_convert_postpaid": true
        },
        "deleted": true,
        "create_time": "2025-12-09T07:25:03.963Z",
        "update_time": "2025-12-09T07:25:03.963Z"
      }
    ],
    "volume_mounts": [
      {
        "type": "MOUNT_TYPE_UNSPECIFIED",
        "id": "string",
        "mount_path": "string",
        "subdir": "string",
        "zone": "string",
        "endpoint": "string"
      }
    ],
    "dnat_rules": [
      {
        "subscription_name": "string",
        "resource_group_name": "string",
        "zone": "string",
        "nat_gw_name": "string",
        "dnat_rule_name": "string",
        "dnat_rule": {
          "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": "STATE_UNSPECIFIED",
          "tags": {},
          "properties": {
            "eip_name": "string",
            "external_ip": "string",
            "external_port": "string",
            "protocol": "string",
            "internal_ip": "string",
            "internal_port": "string",
            "internal_instance_type": "INSTANCE_TYPE_UNSPECIFIED",
            "internal_instance_uid": "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.963Z",
            "payment_model": "PM_UNSPECIFIED",
            "billing_model": "BM_UNSPECIFIED",
            "original_id": "string",
            "end_time": "2025-12-09T07:25:03.963Z",
            "auto_convert_postpaid": true
          },
          "deleted": true,
          "create_time": "2025-12-09T07:25:03.963Z",
          "update_time": "2025-12-09T07:25:03.963Z"
        },
        "request_id": "string"
      }
    ],
    "virtual_machine_type": "VIRTUAL_MACHINE_TYPE_UNSPECIFIED",
    "image_id": "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.963Z",
    "payment_model": "PM_UNSPECIFIED",
    "billing_model": "BM_UNSPECIFIED",
    "original_id": "string",
    "end_time": "2025-12-09T07:25:03.963Z",
    "auto_convert_postpaid": true
  },
  "deleted": true,
  "create_time": "2025-12-09T07:25:03.963Z",
  "update_time": "2025-12-09T07:25:03.963Z"
}

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...