新建 - cloudpods

请求参数

Body 参数application/json

cloudaccount

object (CloudaccountCreateInput)

可选

__meta__

object

可选

标签列表,最多支持20个

示例值:

{"user:rd":"op"}

string

弹性伸缩服务

可选

Bms

string

裸金属服务器

可选

Bss

string

合作伙伴运营能力

可选

Cce

string

云容器服务

可选

Cci

string

云容器实例 CCI

可选

Ces

string

可选

监控服务 CloudEye

Csbs

string

云服务器备份服务

可选

Cts

string

云审计服务

可选

Dcs

string

分布式缓存服务

可选

DefaultSubnetDns

string

默认DNS

可选

示例值:

10.125.0.26,10.125.0.27

Ecs

string

弹性云服务

可选

Elb

string

可选

弹性负载均衡 ELB

EndpointDomain

string

必需

华为私有云Endpoint域名

示例值:

hcso.com.cn

Eps

string

企业项目

可选

Evs

string

云硬盘 EVS

可选

Iam

string

统一身份认证服务

可选

Ims

string

镜像服务

可选

Modelarts

string

Modelarts

可选

Nat

string

Nat网关 NAT

可选

Obs

string

可选

对象存储服务 OBS

Rds

string

可选

关系型数据库 RDS

RegionId

string

可选

SfsTurbo

string

文件系统

可选

SkipDuplicateAccountCheck

boolean

可选

跳过重复账号注册检查

Vbs

string

云硬盘备份 VBS

可选

Vpc

string

虚拟私有云 VPC

可选

access_key_id

string

可选

秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3)

access_key_secret

string

可选

秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3)

access_url

string

认证地址

可选

account

string

可选

账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段

云平台	字段	翻译	是否必传	默认值	可否更新
Aliyun	access_key_id	秘钥ID	是		是
Aliyun	access_key_secret	秘钥Key	是		是
Qcloud	app_id	APP ID	是		否
Qcloud	secret_id	秘钥ID	是		是
Qcloud	secret_key	秘钥Key	是		是
OpenStack	project_name	用户所在项目	是		是
OpenStack	username	用户名	是		是
OpenStack	password	用户密码	是		是
OpenStack	auth_url	认证地址	是		否
OpenStack	domain_name	用户所在的域	否	Default	是
VMware	username	用户名	是		是
VMware	password	密码	是		是
VMware	host	主机IP或域名	是		否
VMware	port	主机端口	否	443	否
Azure	directory_id	目录ID	是		否
Azure	environment	区域	是		否
Azure	client_id	客户端ID	是		是
Azure	client_secret	客户端密码	是		是
Huawei	access_key_id	秘钥ID	是		是
Huawei	access_key_secret	秘钥	是		是
Huawei	environment	区域	是		否
Aws	access_key_id	秘钥ID	是		是
Aws	access_key_secret	秘钥	是		是
Aws	environment	区域	是		否
Ucloud	access_key_id	秘钥ID	是		是
Ucloud	access_key_secret	秘钥	是		是
Google	project_id	项目ID	是		否
Google	client_email	客户端email	是		否
Google	private_key_id	秘钥ID	是		是
Google	private_key	秘钥Key	是		是

app_id

string

可选

app id (Qcloud)

auto_create_project

boolean

可选

自动根据云上项目或订阅创建本地项目, OpenStack此参数为true

默认值:

false

auto_url

string

可选

认证地址 (openstack,zstack)

brand

string

可选

指定云平台品牌, 此参数默认和provider相同
requried: false

provider	支持的参数
VMware	VMware
Aliyun	Aliyun
Qcloud	Qcloud
Azure	Azure
Aws	Aws
Huawei	Huawei
OpenStack	OpenStack
Ucloud	Ucloud
ZStack	ZStack, DStack
Google	Google
Ctyun	Ctyun

client_id

string

可选

客户端ID (Azure)

client_secret

string

可选

客户端秘钥 (Azure)

currency

string

可选

货币类型
enmu: CNY, USD

description

string

资源描述

可选

示例值:

test create network

directory_id

string

可选

目录ID (Azure)

disabled

boolean

可选

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

domain_name

string

可选

账号所在的域 (openstack)

默认值:

Default

dry_run

boolean

可选

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

默认值:

false

enable_auto_sync_resource

boolean

可选

enable_project_sync

boolean

可选

enable_resource_sync

boolean

可选

enabled

boolean

可选

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

endpoint

string

可选

端点 (s3) 或 Apsara(飞天)

environment

string

可选

环境 (Azure, Aws, huawei, ctyun, aliyun)

gcp_client_email

string

可选

Google服务账号email (gcp)

gcp_private_key

string

可选

Google服务账号秘钥 (gcp)

gcp_private_key_id

string

可选

Google服务账号秘钥id (gcp)

gcp_project_id

string

可选

Google服务账号project id (gcp)

generate_name

string

可选

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

示例值:

test###

host

string

可选

主机IP (esxi)

is_emulated

boolean

可选

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

is_public

boolean

是否共享

可选

name

string

必需

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

示例值:

test-network

options

object

可选

额外信息,例如账单的access key

oracle_private_key

string

可选

oracle_tenancy_ocid

string

可选

oracle_user_ocid

string

可选

organization_id

integer <int64>

可选

飞天允许的最高组织id, 默认为1

password

string

可选

密码 (openstack, zstack, esxi)

port

integer <int64>

可选

主机端口 (esxi)

project_domain_id

string

可选

指定项目归属域名称或ID

project_id

string

可选

指定项目的名称或ID

project_mapping_id

string

可选

project_name

string

可选

账号所在的项目 (openstack)

provider

enum<string>

可选

指定云平台
Qcloud: 腾讯云
Ctyun: 天翼云

枚举值:

VMwareAliyunQcloudAzureAwsHuaweiOpenStackUcloudZStackGoogleCtyunJDcloud

proxy_setting_id

string

代理配置

可选

public_scope

string

共享范围

可选

read_only

boolean

可选

saml_auth

boolean

可选

是否启用SAML认证

默认值:

false

secret_id

string

可选

秘钥ID (Qcloud)

secret_key

string

可选

秘钥key (Qcloud)

show_sub_accounts

boolean

可选

仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号

skip_sync_resources

array[string]

可选

start_sync

boolean

可选

是否立即开始同步资源

status

string

用来存储资源的状态

可选

username

string

可选

用户名 (openstack, zstack, esxi)

zone

string

可选

VMware 账号有zone属性

count

integer <int64>

可选

默认值:

示例

{
  "cloudaccount": {
    "__meta__": {
      "user:rd": "op"
    },
    "As": "string",
    "Bms": "string",
    "Bss": "string",
    "Cce": "string",
    "Cci": "string",
    "Ces": "string",
    "Csbs": "string",
    "Cts": "string",
    "Dcs": "string",
    "DefaultSubnetDns": "10.125.0.26,10.125.0.27",
    "Ecs": "string",
    "Elb": "string",
    "EndpointDomain": "hcso.com.cn",
    "Eps": "string",
    "Evs": "string",
    "Iam": "string",
    "Ims": "string",
    "Modelarts": "string",
    "Nat": "string",
    "Obs": "string",
    "Rds": "string",
    "RegionId": "string",
    "SfsTurbo": "string",
    "SkipDuplicateAccountCheck": true,
    "Vbs": "string",
    "Vpc": "string",
    "access_key_id": "string",
    "access_key_secret": "string",
    "access_url": "string",
    "account": "string",
    "app_id": "string",
    "auto_create_project": false,
    "auto_url": "string",
    "brand": "string",
    "client_id": "string",
    "client_secret": "string",
    "currency": "string",
    "description": "test create network",
    "directory_id": "string",
    "disabled": true,
    "domain_name": "Default",
    "dry_run": false,
    "enable_auto_sync_resource": true,
    "enable_project_sync": true,
    "enable_resource_sync": true,
    "enabled": true,
    "endpoint": "string",
    "environment": "string",
    "gcp_client_email": "string",
    "gcp_private_key": "string",
    "gcp_private_key_id": "string",
    "gcp_project_id": "string",
    "generate_name": "test###",
    "host": "string",
    "is_emulated": true,
    "is_public": true,
    "name": "test-network",
    "options": {},
    "oracle_private_key": "string",
    "oracle_tenancy_ocid": "string",
    "oracle_user_ocid": "string",
    "organization_id": 0,
    "password": "string",
    "port": 0,
    "project_domain_id": "string",
    "project_id": "string",
    "project_mapping_id": "string",
    "project_name": "string",
    "provider": "VMware",
    "proxy_setting_id": "string",
    "public_scope": "string",
    "read_only": true,
    "saml_auth": false,
    "secret_id": "string",
    "secret_key": "string",
    "show_sub_accounts": true,
    "skip_sync_resources": [
      "string"
    ],
    "start_sync": true,
    "status": "string",
    "username": "string",
    "zone": "string"
  },
  "count": 1
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/cloudaccounts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cloudaccount": {
        "__meta__": {
            "user:rd": "op"
        },
        "As": "string",
        "Bms": "string",
        "Bss": "string",
        "Cce": "string",
        "Cci": "string",
        "Ces": "string",
        "Csbs": "string",
        "Cts": "string",
        "Dcs": "string",
        "DefaultSubnetDns": "10.125.0.26,10.125.0.27",
        "Ecs": "string",
        "Elb": "string",
        "EndpointDomain": "hcso.com.cn",
        "Eps": "string",
        "Evs": "string",
        "Iam": "string",
        "Ims": "string",
        "Modelarts": "string",
        "Nat": "string",
        "Obs": "string",
        "Rds": "string",
        "RegionId": "string",
        "SfsTurbo": "string",
        "SkipDuplicateAccountCheck": true,
        "Vbs": "string",
        "Vpc": "string",
        "access_key_id": "string",
        "access_key_secret": "string",
        "access_url": "string",
        "account": "string",
        "app_id": "string",
        "auto_create_project": false,
        "auto_url": "string",
        "brand": "string",
        "client_id": "string",
        "client_secret": "string",
        "currency": "string",
        "description": "test create network",
        "directory_id": "string",
        "disabled": true,
        "domain_name": "Default",
        "dry_run": false,
        "enable_auto_sync_resource": true,
        "enable_project_sync": true,
        "enable_resource_sync": true,
        "enabled": true,
        "endpoint": "string",
        "environment": "string",
        "gcp_client_email": "string",
        "gcp_private_key": "string",
        "gcp_private_key_id": "string",
        "gcp_project_id": "string",
        "generate_name": "test###",
        "host": "string",
        "is_emulated": true,
        "is_public": true,
        "name": "test-network",
        "options": {},
        "oracle_private_key": "string",
        "oracle_tenancy_ocid": "string",
        "oracle_user_ocid": "string",
        "organization_id": 0,
        "password": "string",
        "port": 0,
        "project_domain_id": "string",
        "project_id": "string",
        "project_mapping_id": "string",
        "project_name": "string",
        "provider": "VMware",
        "proxy_setting_id": "string",
        "public_scope": "string",
        "read_only": true,
        "saml_auth": false,
        "secret_id": "string",
        "secret_key": "string",
        "show_sub_accounts": true,
        "skip_sync_resources": [
            "string"
        ],
        "start_sync": true,
        "status": "string",
        "username": "string",
        "zone": "string"
    },
    "count": 1
}'

返回响应

🟢200成功

application/json

Body

cloudaccount

object (CloudaccountDetail)

可选

LastSyncCost

string

上次同步耗时

可选

ProjectMapping

string

可选

access_url

string

云环境连接地址

可选

account

string

云账号

可选

account_id

string

云环境唯一标识

可选

auto_create_project

boolean

可选

是否根据云上项目自动在本地创建对应项目

示例值:

false

auto_create_project_for_provider

boolean

可选

是否根据云订阅自动在本地创建对应项目

示例值:

false

balance

number <double>

账户余额

可选

示例值:

124.2

brand

string

可选

品牌信息, 一般和provider相同

示例值:

DStack

can_delete

boolean

可选

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

示例值:

true

can_update

boolean

可选

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

示例值:

true

cloud_env

string

可选

云账号环境类型
public: 公有云
private: 私有云
onpremise: 本地IDC

示例值:

public

created_at

string <date-time>

资源创建时间

可选

currency

string

可选

账户余额货币类型
enmu: CNY, USD

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

disk_count

integer <int64>

云盘数量

可选

示例值:

domain_id

string

域Id

可选

domain_src

string

可选

归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来

示例值:

local

eip_count

integer <int64>

弹性公网Ip数量

可选

示例值:

enable_auto_sync_resource

boolean

可选

enable_project_sync

boolean

可选

enable_resource_sync

boolean

可选

enabled

boolean

资源是否启用

可选

enabled_provider_count

integer <int64>

启用的子订阅数量

可选

示例值:

error_count

integer <int64>

可选

账号探测异常错误次数

guest_count

integer <int64>

云主机数量

可选

示例值:

health_status

string

账号健康状态

可选

示例值:

normal

host_count

integer <int64>

可选

宿主机数量(不计算虚拟机宿主机数量)

示例值:

iam_login_url

string

可选

公有云子账号登录地址

string

资源UUID

可选

is_emulated

boolean

可选

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

is_on_premise

boolean

可选

是否是本地IDC账号

示例值:

false

is_public

boolean

是否共享

可选

is_public_cloud

boolean

是否是公有云账号

可选

示例值:

true

lake_of_permissions

object (SAccountPermissions)

可选

last_sync

string <date-time>

可选

last_sync_end_at

string <date-time>

可选

= Column(DateTime, nullable=True)

metadata

object

标签

可选

name

string

资源名称

可选

options

object

额外信息

可选

probe_at

string <date-time>

上次账号探测时间

可选

progress

number <float>

操作进度0-100

可选

project

string

可选

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

project_domain

string

可选

资源归属项目的域名称

project_id

string

可选

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

project_mapping_id

string

可选

project_metadata

object

可选

provider

string

云平台类型

可选

示例值:

google

provider_count

integer <int64>

子订阅数量

可选

示例值:

proxy_setting

object (SProxySetting is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudcommon/db/proxy.SProxySetting.)

可选

proxy_setting_id

string

可选

默认值proxyapi.ProxySettingId_DIRECT

public_scope

string

默认共享范围

可选

public_src

string

可选

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

示例值:

local

read_only

boolean

可选

region_id

string

云平台默认区域id

可选

routetable_count

integer <int64>

路由表数量

可选

示例值:

saml_auth

boolean

可选

secret

string

云账号密码

可选

share_mode

string

可选

for backward compatiblity, keep is_public field, but not usable

默认值:

"false" nullable:"false"`

shared_domains

array[object (SharedDomain) {2}]

共享的域列表

可选

shared_projects

array[object (SharedProject) {4}]

共享的项目列表

可选

skip_sync_resources

array[string]

可选

status

string

资源状态

可选

storage_count

integer <int64>

块存储数量

可选

示例值:

storagecache_count

integer <int64>

存储缓存数量

可选

示例值:

sub_accounts

object (SubAccounts is an autogenerated struct via yunion.io/x/cloudmux/pkg/cloudprovider.SubAccounts.)

可选

sync_count

integer <int64>

并发同步数量

可选

sync_interval_seconds

integer <int64>

同步时间间隔

可选

示例值:

3600

sync_status

string

可选

sync_stauts2

string

同步状态

可选

sysinfo

object

云系统信息

可选

tenant

string

可选

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

tenant_id

string

项目Id

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

version

string

云API版本

可选

vpc_count

integer <int64>

虚拟私有网络数量

可选

示例值:

示例

{
  "cloudaccount": {
    "LastSyncCost": "string",
    "ProjectMapping": "string",
    "access_url": "string",
    "account": "string",
    "account_id": "string",
    "auto_create_project": false,
    "auto_create_project_for_provider": false,
    "balance": 124.2,
    "brand": "DStack",
    "can_delete": true,
    "can_update": true,
    "cloud_env": "public",
    "created_at": "2019-08-24T14:15:22Z",
    "currency": "string",
    "delete_fail_reason": {
      "class": "string",
      "code": 0,
      "details": "string"
    },
    "deleted": true,
    "deleted_at": "2019-08-24T14:15:22Z",
    "description": "string",
    "disk_count": 12,
    "domain_id": "string",
    "domain_src": "local",
    "eip_count": 2,
    "enable_auto_sync_resource": true,
    "enable_project_sync": true,
    "enable_resource_sync": true,
    "enabled": true,
    "enabled_provider_count": 1,
    "error_count": 0,
    "guest_count": 4,
    "health_status": "normal",
    "host_count": 0,
    "iam_login_url": "string",
    "id": "string",
    "is_emulated": true,
    "is_on_premise": false,
    "is_public": true,
    "is_public_cloud": true,
    "lake_of_permissions": {
      "property1": {
        "Permissions": [
          "string"
        ]
      },
      "property2": {
        "Permissions": [
          "string"
        ]
      }
    },
    "last_sync": "2019-08-24T14:15:22Z",
    "last_sync_end_at": "2019-08-24T14:15:22Z",
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "name": "string",
    "options": {},
    "probe_at": "2019-08-24T14:15:22Z",
    "progress": 0,
    "project": "string",
    "project_domain": "string",
    "project_id": "string",
    "project_mapping_id": "string",
    "project_metadata": {
      "property1": "string",
      "property2": "string"
    },
    "provider": "google",
    "provider_count": 1,
    "proxy_setting": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted": true,
      "deleted_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "domain_id": "string",
      "domain_src": "local",
      "http_proxy": "string",
      "https_proxy": "string",
      "id": "string",
      "is_emulated": true,
      "is_public": true,
      "name": "string",
      "no_proxy": "string",
      "public_scope": "string",
      "public_src": "local",
      "update_version": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "proxy_setting_id": "string",
    "public_scope": "string",
    "public_src": "local",
    "read_only": true,
    "region_id": "string",
    "routetable_count": 0,
    "saml_auth": true,
    "secret": "string",
    "share_mode": "\"false\" nullable:\"false\"`",
    "shared_domains": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "shared_projects": [
      {
        "domain": "string",
        "domain_id": "string",
        "id": "string",
        "name": "string"
      }
    ],
    "skip_sync_resources": [
      "string"
    ],
    "status": "string",
    "storage_count": 12,
    "storagecache_count": 10,
    "sub_accounts": {
      "accounts": [
        {
          "account": "string",
          "default_project_id": "string",
          "desc": "string",
          "health_status": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "cloudregions": [
        {
          "Id": "string",
          "Name": "string",
          "Status": "string"
        }
      ]
    },
    "sync_count": 0,
    "sync_interval_seconds": 3600,
    "sync_status": "string",
    "sync_stauts2": "string",
    "sysinfo": {},
    "tenant": "string",
    "tenant_id": "string",
    "update_fail_reason": {
      "class": "string",
      "code": 0,
      "details": "string"
    },
    "update_version": 0,
    "updated_at": "2019-08-24T14:15:22Z",
    "version": "string",
    "vpc_count": 4
  }
}