You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /边缘计算节点/边缘计算节点/API 参考/私有网络/创建自定义私有网络
创建自定义私有网络
最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 18:00:51
我的收藏

本接口用于创建自定义私有网络。

使用说明

  • 当您创建了一个自定义私有网络后，系统会自动为该私有网络创建一张默认路由表。
  • CreateCustomVPCInstance 属于异步接口。当您调用该接口后，系统会返回一个私有网络 ID，但是私有网络并未创建完成。您可以调用 ListVPCInstances 接口查询创建的私有网络的状态。当私有网络的状态变为可用（available）时，代表私有网络已创建成功。
  • 当前，如需使用自定义私有网络功能，请提交工单进行申请。

请求说明

  • 请求方式：POST
  • 请求地址：https://veenedge.volcengineapi.com/?Action=CreateCustomVPCInstance&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数，请参见公共参数。

Query

参数类型是否必选示例值描述
ActionString是CreateCustomVPCInstance接口名称。当前 API 的名称为 CreateCustomVPCInstance。
VersionString是2021-04-30接口版本。当前 API 的版本为 2021-04-30。

Body

参数类型是否必选示例值描述

vpc_name

String

是

vpc_dev

私有网络的名称。命名规则如下：

  • 允许 5~50 个字符。
  • 支持汉字、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号（"）、反斜线（\）和空格，且不能以正斜线（/）开头。
cluster_nameString是**cm03私有网络所属的节点。

segment

String

是

10.0.0.0/8

私有网络的网段。
推荐您使用RFC标准定义的私有网段10.0.0.0/8、172.16.0.0/12、192.168.0.0/16及其子网。

descString是vpc_dev私有网络的描述信息。您最多可以输入80个字符。
subnets[]Subnets是-子网的信息。

Subnets

参数类型是否必选示例值描述

name

String

是

subnet_dev

子网的名称。命名规则如下：

  • 允许 5~50 个字符。
  • 支持汉字、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
cidrString是10.1.0.0/16子网的网段。
descString是subnet_dev子网的描述。您最多可以输入80个字符。

返回参数

参数类型示例值描述
vpc_instanceVpcInstance见下文说明私有网络的信息。

VpcInstance

参数类型示例值描述
vpc_identityStringvpc-sbjngs****私有网络的 ID。
vpc_nameStringvpc_dev私有网络的名称。
clusterCluster见下文说明私有网络所属的节点。

status

String

available

私有网络的状态：

  • available：可用。
  • modifying：变更中。

is_default

Boolean

false

是否是默认私有网络：

  • true：默认私有网络。
  • false：非默认私有网络。

is_vlan

Boolean

false

是否是 VLAN 私有网络：

  • true：VLAN 私有网络。
  • false：非 VLAN 私有网络。
descStringvpc_dev私有网络的描述。
sub_nets[]SubNets见下文说明子网信息。
resource_statisticResourceStatistic见下文说明资源统计列表。
local_account_vgw_numLong1本账号边缘云网关的数量。
cross_account_vgw_numLong1跨账号边缘云网关的数量。

is_custom

Boolean

true

是否是自定义私有网络：

  • true：自定义私有网络。
  • false：非自定义私有网络。
segmentString172.16.0.0/12私有网络的网段。
create_timeLong1632808736私有网络的创建时间。
update_timeLong1632808736私有网络的更新时间。

Cluster

参数类型示例值描述
cluster_nameString****-zzcu01节点的名称。
countryStringCN国家。
regionStringCentralChina区域。
provinceStringHA省份。
cityString410100城市。
ispStringCUCC运营商。

level

String

2

节点的计费类别：

  • 1：北上广
  • 2：地区中心
  • 3：一般城市
aliasString**联通01节点的中文名称。

SubNets

参数类型示例值描述
subnet_identityStringsubnet-t4qzc7f75gr****子网的 ID。
cidr_ipString172.**.**.128IP 地址。
cidr_maskInteger26前缀长度。
nameStringsubnet_dev子网的名称。
descStringsubnet_dev子网的描述。

status

String

子网的状态：

  • available：可用。
  • modifying：变更中。
create_timeLong1634108663私有网络的创建时间。
update_timeLong1634108663私有网络的更新时间。

ResourceStatistic

参数类型示例值描述
veen_instance_countLong1边缘实例的数量。
veew_sg_instance_countLong1外网防火墙的数量。
veew_lb_instance_countLong1负载均衡实例的数量。
veew_route_table_instance_countLong1路由表的数量。
veew_natgw_instance_countLong1NAT 网关的数量。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateCustomVPCInstance&Version=2021-04-30
&<其他公共参数>
{
    "vpc_name": "vpc_dev",
    "cluster_name": "**cm03",
    "segment": "10.0.0.0/8",
    "desc": "dev01",
    "subnets": [
        {
            "name": "subnet_dev",
            "cidr": "10.1.0.0/16",
            "desc": "dev01"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240307213043BDBD589330F4C493****",
        "Action": "CreateCustomVPCInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "vpc_instance": {
            "account_identity": 210006****,
            "user_identity": 0,
            "vpc_identity": "vpc-twqb9w****",
            "vpc_name": "vpc_dev",
            "vpc_ns": "ns-210006****",
            "cluster_vpc_id": 24**,
            "cluster": {
                "cluster_name": "**cm03",
                "country": "CN",
                "region": "EastChina",
                "province": "ZJ",
                "city": "330100",
                "isp": "CMCC",
                "level": "2",
                "alias": "**移动03"
            },
            "status": "modifying",
            "is_default": false,
            "desc": "dev01",
            "sub_nets": [
                {
                    "account_identity": 210006****,
                    "user_identity": 0,
                    "subnet_identity": "subnet-b8h28fnz9lx****",
                    "cidr_ip": "10.1.0.0",
                    "cidr_mask": 16,
                    "name": "subnet_dev",
                    "desc": "dev01",
                    "status": "modifying",
                    "create_time": 1709818243,
                    "update_time": 1709818243
                }
            ],
            "local_account_vgw_num": 0,
            "cross_account_vgw_num": 0,
            "is_custom": true,
            "segment": "10.0.0.0/8",
            "create_time": 1709818244,
            "update_time": 1709818244
        }
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。