VPN网关订购 - 混合云OpenAPI4.0

请求参数

Body 参数application/json

clientToken

string

可选

客户端存根，用于保证订单幂等性

regionID

string

资源池id

必需

name

string

VPN网关名称

必需

vpcId

string

VPC ID

必需

bandwidth

integer <int32>

带宽大小

必需

connectionLimit

integer <int32>

必需

VPN网关连接数限制

onDemand

boolean

可选

是否按需下单。默认为False

cycleType

string

可选

包周期类型，YEAR/MONTH。onDemand为False时，必须指定

cycleCount

integer <int32>

可选

包周期数。onDemand为False时必须指定。周期最大长度不能超过36个月

description

string

描述

可选

示例

{
    "clientToken": "23213",
    "regionID": "TestRegionID",
    "name": "vpn-041001",
    "vpcId": "vpc-thqt7cx3ib",
    "bandwidth": "10",
    "connectionLimit": 5,
    "onDemand": false,
    "cycleType": "month",
    "cycleCount": 3
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v4/vpn/gateway/new' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientToken": "23213",
    "regionID": "TestRegionID",
    "name": "vpn-041001",
    "vpcId": "vpc-thqt7cx3ib",
    "bandwidth": "10",
    "connectionLimit": 5,
    "onDemand": false,
    "cycleType": "month",
    "cycleCount": 3
}'

返回响应

🟢200successful operation

application/json

Body

statusCode

integer <int32>

请求状态码(800为成功，900为失败)

可选

message

string

错误说明

可选

description

string

描述

可选

errorCode

string

错误码

可选

returnObj

object

响应对象

可选

masterOrderID

string

订单ID

可选

masterOrderNO

string

订单号

可选

masterResourceID

string

主资源ID

可选

regionID

string

资源所属资源池ID

可选

resources

object

资源明细信息

可选

示例

成功示例异常示例

{
    "statusCode": 800,
    "errorCode": null,
    "message": null,
    "description": "SUCCESS",
    "returnObj": {
        "masterOrderID": null,
        "masterOrderNO": "20230411000009",
        "masterResourceID": null,
        "regionID": null,
        "resources": [
            {
                "resourceID": "1e5d54013c934e2697dbf1c6109560be"
            }
        ]
    }
}