puhui-uci

[异步] 创建

开发环境

http://192.168.3.254:31299

POST

/api/v1/guestsTbl/shcheduler

调度器

[taskName：ecsCreateTask]
创建虚拟机

请求参数

Body 参数application/json

cloudCredentialInfo

object (types.CloudProviderParams)

可选

accessKey

string

必需

身份验证 AccessKey

provider

enum<string>

可选

云服务商，枚举类型 Aliyun、Qcloud

枚举值:

AliyunQcloudAwsHuaweiBaiduCloudpods

secretKey

string

必需

身份验证 SecretKey

url

string

可选

服务商地址，用于私有云

data

object (types.GuestCreateOptions)

可选

accountId

string

账号ID

可选

amount

integer

必需

指定创建虚拟机/裸金属实例的数量。取值范围：1~100。

>= 1<= 100

billingCycle

object

可选

周期 Year Month Week

dataDisk

array[object (types.Disk) {5}]

系统盘

可选

description

string

描述信息

可选

eipBandwidth

integer

可选

eip带宽指定此参数后会创建新的弹性公网IP并绑定到新建的虚拟机经典网络虚拟机不支持绑定eip

environment

string

可选

环境 local，daily，product

imageId

string

镜像 id

必需

instanceChargeType

string

可选

付费类型。 SpotPaid:抢占 PostPaid:按量付费 PrePaid:预付费，默认值为PostPaid

instanceId

string

cpc实例ID

可选

instanceTypeInfo

object

实例规格信息

可选

name

string

可选

虚拟机/裸金属名称，非必填，如果不填则自动生成

networkId

string

可选

所属 network id

password

string

密码

必需

regionId

string

必需

区域（region） id

secgroupIds

array[string]

安全组 id 列表

必需

sysDisk

object

系统盘

可选

tenantId

string

租户ID

可选

userData

array[string]

用户自定义启动脚本

可选

vpcId

string

所属 vpc id

必需

zoneId

string

必需

地域（zone） id

taskId

string

任务id

可选

taskName

string

任务名称

可选

示例

{
    "cloudCredentialInfo": {
        "accessKey": "string",
        "provider": "Aliyun",
        "secretKey": "string",
        "url": "string"
    },
    "data": {
        "accountId": "string",
        "amount": 1,
        "billingCycle": {
            "autoRenew": true,
            "count": 0,
            "unit": "string"
        },
        "dataDisk": [
            {
                "iops": 0,
                "name": "string",
                "sizeGB": 0,
                "storageId": "string",
                "storageType": "string"
            }
        ],
        "description": "string",
        "eipBandwidth": 0,
        "environment": "string",
        "imageId": "string",
        "instanceChargeType": "string",
        "instanceId": "string",
        "instanceTypeInfo": {
            "gpuCount": 0,
            "gpuVendorDevice": "string",
            "instanceType": "string",
            "interfaceManagement": 0,
            "interfaceService": 0,
            "sysDiskCount": 0,
            "sysDiskRaid": "string",
            "sysDiskStorageType": "string",
            "vcpuCount": 0,
            "vmemSize": 0
        },
        "name": "string",
        "networkId": "string",
        "password": "string",
        "regionId": "string",
        "secgroupIds": [
            "string"
        ],
        "sysDisk": {
            "iops": 0,
            "name": "string",
            "sizeGB": 0,
            "storageId": "string",
            "storageType": "string"
        },
        "tenantId": "string",
        "userData": [
            "string"
        ],
        "vpcId": "string",
        "zoneId": "string"
    },
    "taskId": "string",
    "taskName": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://192.168.3.254:31299/api/v1/guestsTbl/shcheduler' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cloudCredentialInfo": {
        "accessKey": "string",
        "provider": "Aliyun",
        "secretKey": "string",
        "url": "string"
    },
    "data": {
        "accountId": "string",
        "amount": 1,
        "billingCycle": {
            "autoRenew": true,
            "count": 0,
            "unit": "string"
        },
        "dataDisk": [
            {
                "iops": 0,
                "name": "string",
                "sizeGB": 0,
                "storageId": "string",
                "storageType": "string"
            }
        ],
        "description": "string",
        "eipBandwidth": 0,
        "environment": "string",
        "imageId": "string",
        "instanceChargeType": "string",
        "instanceId": "string",
        "instanceTypeInfo": {
            "gpuCount": 0,
            "gpuVendorDevice": "string",
            "instanceType": "string",
            "interfaceManagement": 0,
            "interfaceService": 0,
            "sysDiskCount": 0,
            "sysDiskRaid": "string",
            "sysDiskStorageType": "string",
            "vcpuCount": 0,
            "vmemSize": 0
        },
        "name": "string",
        "networkId": "string",
        "password": "string",
        "regionId": "string",
        "secgroupIds": [
            "string"
        ],
        "sysDisk": {
            "iops": 0,
            "name": "string",
            "sizeGB": 0,
            "storageId": "string",
            "storageType": "string"
        },
        "tenantId": "string",
        "userData": [
            "string"
        ],
        "vpcId": "string",
        "zoneId": "string"
    },
    "taskId": "string",
    "taskName": "string"
}'

返回响应

🟢200OK

application/json

Body

content

object

可选

resources

array[object (model.GuestCreateResp) {3}]

返回列表数据

可选

errorCode

string

失败 code

可选

errorMsg

string

失败信息

可选

msg

string

响应信息，ok

可选

success

boolean

是否操作成功

可选

taskId

string

任务id

可选

taskName

string

任务名称

可选

示例

{
    "content": {
        "resources": [
            {
                "failedReason": "string",
                "index": 0,
                "instanceId": "string"
            }
        ]
    },
    "errorCode": "string",
    "errorMsg": "string",
    "msg": "string",
    "success": true,
    "taskId": "string",
    "taskName": "string"
}

修改于 2024-07-08 06:54:33

[同步] 查看能否创建

[异步] 为用户分配权限(创建挂载点)