/vm-images/{id} - NeutonOS

请求参数

Path 参数

id

integer

必需

Header 参数

x-sddc-token

string

可选

默认值:

78ce2df0c80e4b10a28c7779af4dc10f

Body 参数application/json

VmImageUpdateReq API request

spec

object (VmImageUpdateReqSpec)

可选

VmImageUpdateReqSpec define update VM image spec

bios

string

可选

Bios is bios type of the image.
Valid values are: "Legacy", "UEFI".

description

string

可选

Description is the description of VM image.

name

string

可选

Name is the name of VM image.

示例

{
    "spec": {
        "bios": "string",
        "description": "string",
        "name": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'http://10.16.11.91:6012/sddc/v1/vm-images/' \
--header 'x-sddc-token: 78ce2df0c80e4b10a28c7779af4dc10f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "spec": {
        "bios": "string",
        "description": "string",
        "name": "string"
    }
}'

返回响应

🟢202成功

application/json

Body

VmImage is a vm image.

metadata

object (ResourceMeta is the metadata all resource type must have.)

必需

created_at

string <date-time>

必需

creation_finish

string <date-time>

可选

deletion_begin

string <date-time>

可选

deletion_finish

string <date-time>

可选

id

integer <int64>

必需

labels

array[object (ResourceMetaLabel is the label metadata of resource.) {4}]

可选

name

string

可选

project_id

integer <int64>

可选

state

object (ResourceMetaState is the state metadata of resource.)

可选

spec

object (VmImageSpec VM image's spec.)

必需

+X:resourceRef:resource=VmImage;field=Spec;

arch

string

必需

bios

string

必需

bootable

boolean

必需

bs_policy_id

integer <int64>

必需

bs_snap_id

integer <int64>

必需

bs_volume_id

integer <int64>

必需

checksum

string

必需

checksum_type

string

必需

cloud_config_enabled

boolean

必需

created_at

string <date-time>

必需

creation_finish

string <date-time>

可选

deleted_at

object (NullTime represents a time.Time that may be null.)

可选

NullTime implements the Scanner interface so
it can be used as a scan destination, similar to NullString.

deletion_begin

string <date-time>

可选

deletion_finish

string <date-time>

可选

description

string

必需

etag

string

必需

id

integer <int64>

必需

name

string

必需

os_distribution

string

必需

os_name

string

必需

os_type

string

必需

project_id

integer <int64>

必需

size_byte

integer <int64>

可选

source_url

string

可选

storage_type

string

必需

type

string

必需

updated_at

string <date-time>

必需

status

object (VmImageStatus VM image's status.)

必需

+X:resourceRef:resource=VmImage;field=Status;

actual_size_byte

integer <int64>

必需

bs_snap_id

integer <int64>

可选

created_at

string <date-time>

必需

deleted_at

object (NullTime represents a time.Time that may be null.)

可选

NullTime implements the Scanner interface so
it can be used as a scan destination, similar to NullString.

download_failed_count

integer <int64>

必需

etag

string

必需

id

integer <int64>

必需

ID is field of status table must be set according to spec table.

progress

number <double>

必需

state

string

可选

total_size_byte

integer <int64>

必需

updated_at

string <date-time>

必需

vm_num

integer <int64>

必需

示例

{
    "metadata": {
        "created_at": "2019-08-24T14:15:22Z",
        "creation_finish": "2019-08-24T14:15:22Z",
        "deletion_begin": "2019-08-24T14:15:22Z",
        "deletion_finish": "2019-08-24T14:15:22Z",
        "id": 0,
        "labels": [
            {
                "label_key_id": 0,
                "label_key_name": "string",
                "label_value_id": 0,
                "label_value_name": "string"
            }
        ],
        "name": "string",
        "project_id": 0,
        "state": {
            "diff_fields": {
                "irreconcilable": [
                    "string"
                ],
                "reconciling": [
                    "string"
                ]
            },
            "state": "string"
        }
    },
    "spec": {
        "arch": "string",
        "bios": "string",
        "bootable": true,
        "bs_policy_id": 0,
        "bs_snap_id": 0,
        "bs_volume_id": 0,
        "checksum": "string",
        "checksum_type": "string",
        "cloud_config_enabled": true,
        "created_at": "2019-08-24T14:15:22Z",
        "creation_finish": "2019-08-24T14:15:22Z",
        "deleted_at": {
            "Time": "2019-08-24T14:15:22Z",
            "Valid": true
        },
        "deletion_begin": "2019-08-24T14:15:22Z",
        "deletion_finish": "2019-08-24T14:15:22Z",
        "description": "string",
        "etag": "string",
        "id": 0,
        "name": "string",
        "os_distribution": "string",
        "os_name": "string",
        "os_type": "string",
        "project_id": 0,
        "size_byte": 0,
        "source_url": "string",
        "storage_type": "string",
        "type": "string",
        "updated_at": "2019-08-24T14:15:22Z"
    },
    "status": {
        "actual_size_byte": 0,
        "bs_snap_id": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "deleted_at": {
            "Time": "2019-08-24T14:15:22Z",
            "Valid": true
        },
        "download_failed_count": 0,
        "etag": "string",
        "id": 0,
        "progress": 0,
        "state": "string",
        "total_size_byte": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "vm_num": 0
    }
}