批量IAAS资源订单

批量IAAS资源订单
demand资源规格参数:
ECS新增虚机规格参数

参数	是否必填	参数类型	说明
vmName	是	String	云主机名称
displayName	是	String	主机名称
flavorUUID	是	String	规格ID
imagePublic	是	Integer	镜像类型，取值范围:[0=私有镜像,1=公有镜像,2=共享镜像,3=安全镜像,4=甄选镜像] --3，4暂不支持
imageID	是	String	镜像Id
volumeID	否	String	启动卷ID-暂不生效
imageName	否	String	镜像名称-暂不生效
osType	是	String	操作系统类型(Linux/Windows)-暂不生效
syshdType	是	String	系统盘类型
syshd	是	Integer	系统盘大小
diskList	否	Array	数据盘
vpc	否	String	虚拟私有云
secGroupList	否	Array	安全组id ，值类型为string
networkCardList	是	Array	网卡
extIP	是	String	是否使用弹性公网IP ，取值范围:[1=自动分配,0=不使用,2=使用已有]
ipType	否	String	弹性IP版本，取值范围:[ipv4=v4地址,ipv6=v6地址]，暂只支持ipv4
bandWidth	否	Integer	带宽，取值范围:[1~2000]-默认100
bandwidthType	否	String	带宽类型(cn2)-暂不生效
ipv6Address	否	String	ipv6地址-暂不支持
publicIP	否	String	弹性公网IP的id-暂不生效
affinityGroup	否	String	云主机组uuid
keyPairID	否	String	密钥对-暂时不用
rootPassword	否	String	用户密码
orderCount	是	Integer	购买数量
metadata	否	Object	虚机元数据-暂不生效

表diskList

参数	是否必填	参数类型	说明
cmkUUID	否	String	非对称密钥uuid-暂不生效
diskMode	否	String	磁盘属性(VBD)-暂不生效
title	是	String	磁盘名称-暂不生效
encrypted	是	String	磁盘加密标志，取值范围:[1=加密,0=不加密] -暂不生效
diskType	是	String	磁盘类型，取值范围:[data=数据盘]，默认值:data
type	是	String	磁盘分类 SAS-public/..
size	是	Integer	磁盘容量

表networkCards

参数	是否必填	参数类型	说明
title	是	String	网卡名称-暂不生效
ipv6Change	是	Boolean	是否升级IPv6-暂不生效
fixedIP	否	String	内网IPv4地址
master	是	Boolean	是否主节点(True代表主节点)
ipv6	否	String	内网IPv6地址
subnetID	否	String	子网id
shareVpcID	否	String	共享VPCID-暂不生效

虚拟机变配规格参数

参数	是否必填	参数类型	说明	示例
flavorUUID	是	String	规格ID	0824679a-dc86-47dc-a0d3-9c330928f4f6

EBM

新增裸机规格参数

参数	是否必填	参数类型	说明	示例
deviceType	string	是	body	物理机套餐类型
name	string	是	body	物理机名称
hostname	string	是	body	hostname
imageUUID	string	是	body	物理机镜像id
password	string	是	body	密码
systemVolumeRaidUUID	string	否	body	本地系统盘raid类型，如果有本地系统盘则必填
dataVolumeRaidUUID	string	否	body	本地数据盘raid类型，如果有本地数据盘则必填
vpcID	string	是	body	主网卡网络ID
extIP	string	是	body	是否使用弹性公网IP，取值范围:[1=自动分配,0=不使用,2=使用已有]
ipType	string	否	body	弹性IP版本，取值范围:[ipv4=v4地址,ipv6=v6地址]，只支持ipv4
bandwidth	Integer	否	body	带宽
bandwidthType	string	否	body	带宽类型-暂不生效
ipv6Address	string	否	body	ipv6地址-暂不生效
publicIP	string	否	body	弹性公网IP的id -暂不生效
securityGroupID	string	否	body	安全组ID
diskList	array	否	body	云盘信息列表
networkCardList	array	是	body	网卡

diskList 表信息

参数	是否必填	参数类型	说明
diskType	是	String	磁盘类型，system,data
diskMode	否	String	磁盘属性(VBD)-暂不生效
title	否	String	磁盘名称，长度2~64,不支持中文
type	是	String	磁盘分类
size	是	Integer	磁盘容量

networkCardList 表信息

参数	是否必填	参数类型	说明
title	是	String	网卡名称
fixedIP	否	String	内网IPv4地址
master	是	Boolean	是否主节点(True代表主节点)
ipv6	否	String	内网IPv6地址
subnetID	是	String	子网id
sharedVpcID	否	string	如果是共享VPC，-暂不生效

####EBS新增磁盘规格参数

参数	是否必填	参数类型	说明
isEncrypt	是	Boolean	是否加密盘，默认false -暂不生效
cmkUUID	否	String	如果是加密盘，需要提供kms的uuid -暂不生效
diskMode	否	String	磁盘模式，VBD/ISCSI/FCSAN -暂不生效
type	是	String	磁盘类型，
name	否	String	磁盘命名，单账户单资源池下，命名需唯一
size	是	Int	磁盘大小，单位GB

变配磁盘规格参数

参数	是否必填	参数类型	说明	示例	下级对象
diskSize	是	Int	磁盘大小，单位GB

####NAT新增NAT网关规格参数

参数	是否必填	参数类型
vpcID	是	String 需要创建NAT网关的VPC的ID。
name	是	String NAT网关的名称。
spec	是	Integer 规格
description	否	String NAT网关的描述。

变配NAT规格参数

参数	是否必填	参数类型	说明	示例
spec	是	Integer		规格 1~4

新增弹性IP规格参数

参数	是否必填	参数类型	说明
name	是	string	eip名称
bandWidth	否	Integer	带宽
description	否	string	描述信息

变配EIP规格参数

参数	是否必填	参数类型	说明
bandWidth	否	Integer	带宽

新增VPCE终端节点规格参数

参数	是否必填	参数类型	说明
endpointServiceID	是	String	终端节点关联的终端节点服务
endpointName	是	String	终端节点名称，只能由数字，字母，-组成不能以数字和-开头，最大长度28
subnetID	是	String	子网id
vpcID	是	String
type	否	String	接口还是反向，interface:接口，reverse:反向
IP	否	String	vpc address
whitelistFlag	是	int	白名单开关 1.开启 0.关闭，默认1
whitelist	否	Array[String]	白名单
description	否	String	描述

ELB
####新增负载均衡规格参数

参数	是否必填	参数类型	说明
vpcID	string	否	vpc的ID
subnetID	string	是	子网的ID
slaName	string	是	规格名称-未与公有云对齐，私有云必传
name	string	是	名称
description	string	否	描述
eipID	string	否	弹性公网IP的ID。当resourceType=external为必填
type	string	是	资源类型。internal：内网负载均衡，external：公网负载均衡
privateIpAddress	string	否	负载均衡的私有IP地址，不指定则自动分配
deleteProtection	boolean	否	删除保护。false（不开启）、true（开）。默认：不开启

请求参数

Body 参数application/json

batchOrderID

string

客户端订单号

必需

客户端订单号，存根，用于保证订单幂等性，要求全局唯一，客户端需自己编排生成

serverBatchOrderID

string

服务端订单号

可选

sharedTags

object

批量资源共享的公共信息

可选

批量资源共享的公共信息，附着于具体资源项。tag信息支撑基于标签的资源检索。
key-value，value仅支持字符串。
通过资源项的查询接口亦可获得

sharedMetas

object

批量资源共享的公共信息

可选

批量资源共享的公共信息，附着于具体资源项。通过资源项的查询接口亦可获得。
key-value，value仅支持字符串。

resourceDemands

array [object {9}]

资源需求列表

必需

resourceType

string

资源类型

必需

ecs- 虚拟机，ebm-裸金属，ebs-云硬盘，elb-负载均衡，nat-nat网关，eip- 弹性公网IP，vpce- vpce终端

resourceRoleID

string

资源在批量开通中的角色ID(暂时不需要)

必需

channelInfos

object

渠道唯一标记信息,key-value格式，详情见备注

必需

在acition为新增时上送resourceId,在变配退订时上送资源的resourceUUID

tags

object

资源标签-暂不支持

可选

key-value，value仅支持字符串

metas

string

资源的附加属性-暂不支持

可选

资源的附加属性，key-value仅支持字符串

regionID

string

资源池ID

必需

azName

string

可用区

可选

projectID

string

项目ID

必需

demand

object

资源规格

必需

参考备注

action

string

资源需求类型

必需

new-开通 changeSpec-变配 delete-删除

示例

{
    "batchOrderID": "CO202304280101230123110001",
    "action": "new",
    "resourceDemands": [
        {
            "projectID": 904281422,
            "demand": {
                "vmName": "ecs-test-0428001",
                "flavorUUID": "810e3e2c-404b-a480-337b-65769b3cfc54",
                "imagePublic": 1,
                "imageID": "96cf2b46-7c45-4d52-b239-a488b43b7c9a",
                "imageName": "img-test-0428001",
                "osType": "Linux",
                "syshdType": "SAS-public",
                "syshd": 40,
                "extIP": "0",
                "vpc": "vpc-n96mwxjlt6",
                "secGroupList": [
                    "sg-yjo0aruemp"
                ],
                "orderCount ": 1,
                "diskList": [
                    {
                        "title": "vo-yjw01107",
                        "encrypted": "0",
                        "diskType ": "data",
                        "type": "SAS-public",
                        "size": 40
                    }
                ],
                "networkCardList": [
                    {
                        "title": "net-yjwvm0117",
                        "subnetID": "subnet-79dzrqykep",
                        "ipv6Change": false,
                        "master": true
                    }
                ]
            },
            "channelInfos": {
                "vm": "testvm0428001",
                "ip": "testip0428001",
                "volume": [
                    "testvolume0428001"
                ]
            },
            "resourceType": "ecs",
            "regionID": "TestRegionID",
            "azName": "az1"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200successful operation

application/json

Body

statusCode

integer <int32>

必需

返回状态码(800为成功，900为失败)

errorCode

string

具体错误码标志

必需

message

string

失败时的错误信息

必需

description

string

失败时的错误描述

必需

returnObj

object

返回参数

必需

serverBatchOrderID

string

必需

totalCount

integer <int32>

下发了总订单数

可选

successCount

integer <int32>

成功订单数量

可选

failedCount

integer <int32>

异常订单数量

可选

inProgressCount

integer <int32>

在途订单数量

可选

timeoutCount

integer <int32>

实施超过时限的资源项数目

可选

successResourceInfos

array [object {9}]

成功实施的资源项详情

可选

failedResourceRoles

array [object {8}]

失败的资源项列表

可选

inProgressResourceRoles

array [object {8}]

在途资源项列表

可选

timeoutResourceRoles

array [object {8}]

实施超时的资源项详情*

必需

示例

{
    "statusCode": 800,
    "errorCode": null,
    "message": null,
    "description": "SUCCESS",
    "returnObj": {
        "serverBatchOrderID": "20230428000102",
        "totalCount": 1,
        "successCount": 0,
        "failedCount": 0,
        "inProgressCount": 1,
        "timeoutCount": null,
        "successResourceInfos": [],
        "failedResourceRoles": [],
        "inProgressResourceRoles": [
            {
                "resourceType": "VM",
                "resourceRoleID": null,
                "taskRegistTime": "2023-04-28 14:28:58.0",
                "taskStartTime": "2023-04-28 14:28:58.0",
                "taskStopTime": "2023-04-28 14:28:58.0",
                "regionID": "TestRegionID",
                "azName": "az1",
                "errMessage": null
            }
        ],
        "timeoutResourceRoles": null
    }
}

虚拟机变配规格参数#

新增裸机规格参数#

diskList 表信息#

networkCardList 表信息#

变配磁盘规格参数#

变配NAT规格参数#

新增弹性IP规格参数#

变配EIP规格参数#

新增VPCE终端节点规格参数#

请求参数

示例代码

返回响应

虚拟机变配规格参数

新增裸机规格参数

diskList 表信息

networkCardList 表信息

变配磁盘规格参数

变配NAT规格参数

新增弹性IP规格参数

变配EIP规格参数

新增VPCE终端节点规格参数