新建 - cloudpods

新建

请求参数

Body 参数application/json

cloudregion

object (EnabledStatusStandaloneResourceCreateInput)

可选

__meta__

object

可选

标签列表,最多支持20个

示例值:

{"user:rd":"op"}

description

string

资源描述

可选

示例值:

test create network

disabled

boolean

可选

该资源是否被管理员人为禁用, 和enabled互斥

dry_run

boolean

可选

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

默认值:

false

enabled

boolean

可选

该资源是否被管理员人为启用或者禁用

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

status

string

用来存储资源的状态

可选

count

integer <int64>

可选

默认值:

示例

{
    "cloudregion": {
        "__meta__": {
            "user:rd": "op"
        },
        "description": "test create network",
        "disabled": true,
        "dry_run": false,
        "enabled": true,
        "generate_name": "test###",
        "is_emulated": true,
        "name": "test-network",
        "status": "string"
    },
    "count": 1
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

cloudregion

object (CloudregionDetails)

可选

can_delete

boolean

可选

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

示例值:

true

can_update

boolean

可选

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

示例值:

true

city

string

城市

可选

示例值:

Guiyang

cloud_env

string

可选

云类型, public, private or onpremise

示例值:

public

country_code

string

国家代码

可选

示例值:

created_at

string <date-time>

资源创建时间

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

enabled

boolean

资源是否启用

可选

environment

string

云环境

可选

示例值:

ChinaCloud

external_id

string

可选

云上Id, 对应云上资源自身Id

guest_count

integer <int64>

云主机梳理

可选

示例值:

guest_increment_count

integer <int64>

可选

距离前天0点新增云主机数量

示例值:

string

资源UUID

可选

imported_at

string <date-time>

资源导入时间

可选

is_emulated

boolean

可选

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

latitude

number <float>

纬度

可选

示例值:

26.647003

longitude

number <float>

经度

可选

示例值:

106.630211

metadata

object

标签

可选

name

string

资源名称

可选

network_count

integer <int64>

IP子网数量

可选

示例值:

progress

number <float>

操作进度0-100

可选

provider

string

云平台

可选

示例值:

Huawei

source

string

可选

资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目

status

string

资源状态

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

vpc_count

integer <int64>

虚拟私有网络数量

可选

示例值:

zone_count

integer <int64>

可用区数量

可选

示例值:

示例

{
    "cloudregion": {
        "can_delete": true,
        "can_update": true,
        "city": "Guiyang",
        "cloud_env": "public",
        "country_code": "CN",
        "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,
        "environment": "ChinaCloud",
        "external_id": "string",
        "guest_count": 2,
        "guest_increment_count": 0,
        "id": "string",
        "imported_at": "2019-08-24T14:15:22Z",
        "is_emulated": true,
        "latitude": 26.647003,
        "longitude": 106.630211,
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "name": "string",
        "network_count": 12,
        "progress": 0,
        "provider": "Huawei",
        "source": "string",
        "status": "string",
        "update_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "update_version": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "vpc_count": 2,
        "zone_count": 3
    }
}