新建 - cloudpods

新建

请求参数

Body 参数application/json

count

integer <int64>

可选

默认值:

service

object (StandaloneResourceCreateInput)

可选

__meta__

object

可选

标签列表,最多支持20个

示例值:

{"user:rd":"op"}

description

string

资源描述

可选

示例值:

test create network

dry_run

boolean

可选

预检验参数,若为true则仅检查参数,并不真正创建变更

默认值:

false

generate_name

string

可选

生成资源名称的模板，如果name为空，则为必填项
description: generated resource name, given a pattern to generate name, required if name is not given

示例值:

test###

is_emulated

boolean

可选

资源是否为模拟资源
description: the resource is an emulated resource

name

string

必需

资源名称，如果generate_name为空，则为必填项
description: resource name, required if generated_name is not given

示例值:

test-network

示例

{
    "count": 1,
    "service": {
        "__meta__": {
            "user:rd": "op"
        },
        "description": "test create network",
        "dry_run": false,
        "generate_name": "test###",
        "is_emulated": true,
        "name": "test-network"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

service

object (ServiceDetails)

可选

can_delete

boolean

可选

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

示例值:

true

can_update

boolean

可选

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

示例值:

true

config_version

integer <int64>

可选

created_at

string <date-time>

资源创建时间

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

enabled

boolean

可选

endpoint_count

integer <int64>

可选

extra

object

可选

string

资源UUID

可选

is_emulated

boolean

可选

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

metadata

object

标签

可选

name

string

资源名称

可选

type

string

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

示例

{
    "service": {
        "can_delete": true,
        "can_update": true,
        "config_version": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "delete_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "deleted": true,
        "deleted_at": "2019-08-24T14:15:22Z",
        "description": "string",
        "enabled": true,
        "endpoint_count": 0,
        "extra": {},
        "id": "string",
        "is_emulated": true,
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "name": "string",
        "type": "string",
        "update_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "update_version": 0,
        "updated_at": "2019-08-24T14:15:22Z"
    }
}