新建 - cloudpods

新建

请求参数

Body 参数application/json

count

integer <int64>

可选

默认值:

scalinggroup

object (ScalingGroupCreateInput)

可选

__meta__

object

可选

标签列表,最多支持20个

示例值:

{"user:rd":"op"}

cloudregion

string

必需

description: cloud region id or name

示例值:

cr-test-one

description

string

资源描述

可选

示例值:

test create network

desire_instance_number

integer <int64>

可选

description: 期望实例数

示例值:

disabled

boolean

可选

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

dry_run

boolean

可选

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

默认值:

false

enabled

boolean

可选

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

expansion_principle

enum<string>

可选

description: 扩容策略

枚举值:

balanced

示例值:

balanced

external_access_mode

string

Vpc外网访问模式

可选

generate_name

string

可选

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

示例值:

test###

guest_template

string

可选

description: 主机模板 id or name

示例值:

gt-test-one

health_check_cycle

integer <int64>

可选

description: 健康检查周期

示例值:

300

health_check_gov

integer <int64>

可选

description: 健康检查缓冲时间

示例值:

180

health_check_mode

enum<string>

可选

description: 检查健康模式

枚举值:

normalloadbalancer

示例值:

normal

hypervisor

string

可选

description: hypervisor

示例值:

kvm

is_emulated

boolean

可选

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

is_system

boolean

可选

description: indicate the resource is a system resource, which is not visible to user

lb_backend_group

string

可选

description: 负载均衡后端服务器组

示例值:

lbg-nihao

loadbalancer_backend_port

integer <int64>

可选

description: 负载均衡后端服务器统一端口

示例值:

8080

loadbalancer_backend_weight

integer <int64>

可选

description: 负载均衡后端服务器的weight

示例值:

max_instance_number

integer <int64>

可选

description: 最大实例数

示例值:

min_instance_number

integer <int64>

可选

description: 最小实例数

示例值:

name

string

必需

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

示例值:

test-network

networks

array[string]

可选

description: 多个网络(ID或者Name),

示例值:

n-test-one

project_domain_id

string

可选

指定项目归属域名称或ID

project_id

string

可选

指定项目的名称或ID

shrink_principle

enum<string>

可选

description: 缩容策略

枚举值:

earliestlatestconfig_earliestconfig_latest

示例值:

latest

status

string

用来存储资源的状态

可选

vpc_id

string

可选

关联VPC(ID或Name)

示例

{
    "count": 1,
    "scalinggroup": {
        "__meta__": {
            "user:rd": "op"
        },
        "cloudregion": "cr-test-one",
        "description": "test create network",
        "desire_instance_number": 1,
        "disabled": true,
        "dry_run": false,
        "enabled": true,
        "expansion_principle": "balanced",
        "external_access_mode": "string",
        "generate_name": "test###",
        "guest_template": "gt-test-one",
        "health_check_cycle": 300,
        "health_check_gov": 180,
        "health_check_mode": "normal",
        "hypervisor": "kvm",
        "is_emulated": true,
        "is_system": true,
        "lb_backend_group": "lbg-nihao",
        "loadbalancer_backend_port": 8080,
        "loadbalancer_backend_weight": 10,
        "max_instance_number": 10,
        "min_instance_number": 0,
        "name": "test-network",
        "networks": "n-test-one",
        "project_domain_id": "string",
        "project_id": "string",
        "shrink_principle": "earliest",
        "status": "string",
        "vpc_id": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

scalinggroup

object (ScalingGroupDetails)

可选

account

string

云账号名称

可选

示例值:

google-account

account_health_status

string

云账号监控状态

可选

account_id

string

云账号Id

可选

示例值:

4d3c8979-9dd0-439b-8d78-36fe1ab1666c

account_read_only

boolean

可选

account_status

string

云账号状态

可选

backend_group

string

负载均衡后端组名称

可选

backend_group_id

string

负载均衡后端组ID

可选

brand

string

可选

description: 平台

示例值:

OneCloud

can_delete

boolean

可选

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

示例值:

true

can_update

boolean

可选

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

示例值:

true

cloud_env

string

云环境

可选

示例值:

public

cloudregion

string

区域的名称

可选

cloudregion_id

string

归属区域ID

可选

created_at

string <date-time>

资源创建时间

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

desire_instance_number

integer <int64>

可选

DesireInstanceNumber represent the number of instances that should exist in the scaling group.
Scaling controller will monitor and ensure this in real time.
Scaling activities triggered by various policies will also modify this value.
This value should between MinInstanceNumber and MaxInstanceNumber

domain_id

string

域Id

可选

enabled

boolean

资源是否启用

可选

environment

string

可选

Environment

expansion_principle

string

可选

ExpansionPrinciple represent the principle when creating new instance to join in.

freezed

boolean

资源是否被冻结

可选

group

string

实例组名称

可选

group_id

string

实例组ID

可选

guest_template

string

主机模板名称

可选

guest_template_id

string

主机模板ID

可选

health_check_cycle

integer <int64>

可选

health_check_gov

integer <int64>

可选

health_check_mode

string

可选

hypervisor

string

可选

string

资源UUID

可选

instance_number

integer <int64>

可选

description: 实例数

示例值:

is_default_vpc

boolean

是否为经典网络

可选

is_emulated

boolean

可选

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

is_system

boolean

是否是系统资源

可选

loadbalancer

string

负载均衡名称

可选

loadbalancer_backend_port

integer <int64>

可选

loadbalancer_backend_weight

integer <int64>

可选

loadbalancer_id

string

负载均衡ID

可选

manager

string

云订阅名称

可选

示例值:

google-account

manager_domain

string

子订阅所在域名称

可选

示例值:

Default

manager_domain_id

string

子订阅所在域Id

可选

示例值:

default

manager_id

string

可选

VPC归属云订阅ID

manager_project

string

子订阅所在项目名称

可选

示例值:

system

manager_project_id

string

子订阅所在项目Id

可选

示例值:

4d3c8979-9dd0-439b-8d78-36fe1ab1666c

max_instance_number

integer <int64>

可选

metadata

object

标签

可选

min_instance_number

integer <int64>

可选

name

string

资源名称

可选

networks

array[object (ScalingGroupNetwork) {4}]

可选

description: 网络信息

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

provider

string

云平台名称

可选

示例值:

Google

region

string

区域的名称

可选

示例值:

Default

region_ext_id

string

纳管云区域的Id

可选

示例值:

59e7bc87-a6b3-4c39-8f02-c68e8243d4e4

region_external_id

string

可选

纳管云区域的组合Id(平台+Id)

示例值:

ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4

region_id

string

区域的Id

可选

示例值:

default

scaling_policy_number

integer <int64>

可选

description: 伸缩策略的数量

示例值:

shrink_principle

string

可选

ShrinkPrinciple represent the principle when removing instance from scaling group.

status

string

资源状态

可选

tenant

string

可选

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

tenant_id

string

项目Id

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

vpc

string

Vpc Name

可选

vpc_ext_id

string

VPC外部Id

可选

vpc_id

string

VPC ID

可选

zone

string

可用区名称

可选

示例值:

北京一区

zone_ext_id

string

可选

纳管云的zoneId

zone_id

string

可用区ID

可选

示例

{
    "scalinggroup": {
        "account": "google-account",
        "account_health_status": "string",
        "account_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
        "account_read_only": true,
        "account_status": "string",
        "backend_group": "string",
        "backend_group_id": "string",
        "brand": "OneCloud",
        "can_delete": true,
        "can_update": true,
        "cloud_env": "public",
        "cloudregion": "string",
        "cloudregion_id": "string",
        "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",
        "desire_instance_number": 0,
        "domain_id": "string",
        "enabled": true,
        "environment": "string",
        "expansion_principle": "string",
        "freezed": true,
        "group": "string",
        "group_id": "string",
        "guest_template": "string",
        "guest_template_id": "string",
        "health_check_cycle": 0,
        "health_check_gov": 0,
        "health_check_mode": "string",
        "hypervisor": "string",
        "id": "string",
        "instance_number": 0,
        "is_default_vpc": true,
        "is_emulated": true,
        "is_system": true,
        "loadbalancer": "string",
        "loadbalancer_backend_port": 0,
        "loadbalancer_backend_weight": 0,
        "loadbalancer_id": "string",
        "manager": "google-account",
        "manager_domain": "Default",
        "manager_domain_id": "default",
        "manager_id": "string",
        "manager_project": "system",
        "manager_project_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
        "max_instance_number": 0,
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "min_instance_number": 0,
        "name": "string",
        "networks": [
            {
                "guest_ip_end": "string",
                "guest_ip_start": "string",
                "id": "string",
                "name": "string"
            }
        ],
        "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",
        "provider": "Google",
        "region": "Default",
        "region_ext_id": "59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
        "region_external_id": "ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
        "region_id": "default",
        "scaling_policy_number": 3,
        "shrink_principle": "string",
        "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",
        "vpc": "string",
        "vpc_ext_id": "string",
        "vpc_id": "string",
        "zone": "北京一区",
        "zone_ext_id": "string",
        "zone_id": "string"
    }
}