更新 - cloudpods

更新

请求参数

Path 参数

string

必需

The Id or Name of guest_image

Body 参数application/json

guest_image

object (SharableVirtualResourceBaseUpdateInput)

可选

description

string

资源描述

可选

name

string

资源名称

可选

progress

number <float>

可选

示例

{
    "guest_image": {
        "description": "string",
        "name": "string",
        "progress": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

guest_image

object (GuestImageDetails)

可选

can_delete

boolean

可选

资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因

示例值:

true

can_update

boolean

可选

资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因

示例值:

true

created_at

string <date-time>

资源创建时间

可选

data_images

array[object (SubImageInfo) {9}]

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

disable_delete

boolean

可选

disk_format

string

可选

domain_id

string

域Id

可选

encrypt_alg

string

可选

加密算法，aes-256 or sm4

encrypt_key

string

秘钥名称

可选

encrypt_key_id

string

加密密钥ID

可选

encrypt_key_user

string

密钥用户

可选

encrypt_key_user_domain

string

密钥用户域

可选

encrypt_key_user_domain_id

string

密钥用户域ID

可选

encrypt_key_user_id

string

密钥用户ID

可选

freezed

boolean

资源是否被冻结

可选

string

资源UUID

可选

is_emulated

boolean

可选

是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数

is_public

boolean

是否共享

可选

is_system

boolean

是否是系统资源

可选

metadata

object

标签

可选

min_ram_mb

integer <int32>

可选

name

string

资源名称

可选

os_arch

string

可选

操作系统 CPU 架构

示例值:

x86 arm

pending_deleted

boolean

可选

资源是否处于回收站中

pending_deleted_at

string <date-time>

资源放入回收站时间

可选

progress

number <float>

操作进度0-100

可选

project

string

可选

资源归属项目的名称（向后兼容别名）
Deprecated

project_domain

string

可选

资源归属项目的域名称

project_id

string

可选

资源归属项目的ID(向后兼容别名）
Deprecated

project_metadata

object

可选

project_src

string

可选

云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过

示例值:

local

properties

object

可选

protected

boolean

可选

public_scope

string

默认共享范围

可选

public_src

string

可选

共享设置的来源, local: 本地设置, cloud: 从云上同步过来

示例值:

local

root_image

object (SubImageInfo)

可选

shared_domains

array[object (SharedDomain) {2}]

共享的域列表

可选

shared_projects

array[object (SharedProject) {4}]

共享的项目列表

可选

size

integer <int64>

可选

Status string json:"status"

status

string

资源状态

可选

tenant

string

可选

资源归属项目的名称
alias:project

tenant_id

string

项目Id

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

示例

{
    "guest_image": {
        "can_delete": true,
        "can_update": true,
        "created_at": "2019-08-24T14:15:22Z",
        "data_images": [
            {
                "created_at": "2019-08-24T14:15:22Z",
                "disable_delete": true,
                "disk_format": "string",
                "encrypt_key_id": "string",
                "id": "string",
                "min_disk_mb": 0,
                "name": "string",
                "size": 0,
                "status": "string"
            }
        ],
        "delete_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "deleted": true,
        "deleted_at": "2019-08-24T14:15:22Z",
        "description": "string",
        "disable_delete": true,
        "disk_format": "string",
        "domain_id": "string",
        "encrypt_alg": "string",
        "encrypt_key": "string",
        "encrypt_key_id": "string",
        "encrypt_key_user": "string",
        "encrypt_key_user_domain": "string",
        "encrypt_key_user_domain_id": "string",
        "encrypt_key_user_id": "string",
        "freezed": true,
        "id": "string",
        "is_emulated": true,
        "is_public": true,
        "is_system": true,
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "min_ram_mb": 0,
        "name": "string",
        "os_arch": "x86 arm",
        "pending_deleted": true,
        "pending_deleted_at": "2019-08-24T14:15:22Z",
        "progress": 0,
        "project": "string",
        "project_domain": "string",
        "project_id": "string",
        "project_metadata": {
            "property1": "string",
            "property2": "string"
        },
        "project_src": "local",
        "properties": {},
        "protected": true,
        "public_scope": "string",
        "public_src": "local",
        "root_image": {
            "created_at": "2019-08-24T14:15:22Z",
            "disable_delete": true,
            "disk_format": "string",
            "encrypt_key_id": "string",
            "id": "string",
            "min_disk_mb": 0,
            "name": "string",
            "size": 0,
            "status": "string"
        },
        "shared_domains": [
            {
                "id": "string",
                "name": "string"
            }
        ],
        "shared_projects": [
            {
                "domain": "string",
                "domain_id": "string",
                "id": "string",
                "name": "string"
            }
        ],
        "size": 0,
        "status": "string",
        "tenant": "string",
        "tenant_id": "string",
        "update_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "update_version": 0,
        "updated_at": "2019-08-24T14:15:22Z"
    }
}