跳到主要内容

创建私网连接

创建云厂商私网连接。此接口需要数据源模块权限。

请求地址:/openapi/v1/tunnel/create

请求方法:POST

请求参数​

参数类型是否必填说明
nameString是私网连接名称。
typeString是连接类型:access(自动模式)或 manual(手动模式)。
vendorString是云厂商:aliyun、tencent、huawei、aws、ecloud、gcp 或 baidu。
vendorRegionIdString是云厂商地域 ID,例如 cn-hangzhou。
uidString是云厂商账号 UID。当前接口校验要求 access 和 manual 两种连接类型均传入此字段。
accessIdString否云厂商访问凭证 ID;type 为 access 时必填。
vpcIdString否VPC ID。
vpcNameString否VPC 名称。
gatewayIdString否关联的网关 ID。
endpointIdString否终端节点 ID;type 为 manual 时必填。
endpointIpString否终端节点 IP。

请求示例​

{
"name": "example-tunnel",
"type": "access",
"vendor": "aliyun",
"vendorRegionId": "cn-hangzhou",
"uid": "<cloud-account-uid>",
"accessId": "<accessId>",
"vpcId": "<vpcId>"
}

返回参数​

参数类型说明
successBoolean请求是否成功。
requestIdString请求 ID。
data.tunnelIdString新创建的私网连接 ID。

调用成功示例​

{"success": true, "requestId": "<requestId>", "data": {"tunnelId": "<tunnelId>"}}