API 文档

创建VPC

最近更新时间:2020-08-18 08:02:13

1. 接口描述

接口请求域名: ecm.tencentcloudapi.com 。

创建私有网络

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateVpc。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
VpcName String vpc名称,最大长度不能超过60个字节。
CidrBlock String vpc的cidr,只能为10.*.0.0/16,172.[16-31].0.0/16,192.168.0.0/16这三个内网网段内。
EcmRegion String ECM 地域
EnableMulticast String 是否开启组播。true: 开启, false: 不开启。暂不支持
DnsServers.N Array of String DNS地址,最多支持4个,暂不支持
DomainName String 域名,暂不支持
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]
Description String 描述信息

3. 输出参数

参数名称 类型 描述
Vpc VpcInfo Vpc对象。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建VPC

输入示例

https://ecm.tencentcloudapi.com/?Action=CreateVpc
&VpcName=vpc名称
&CidrBlock=10.10.0.0/28
&EcmRegion=ap-hangzhou-ecm
&Description=vpc描述
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6c7eda30-1b66-4296-857e-183f6094063f",
    "Vpc": {
      "EnableDhcp": true,
      "VpcId": "vpc-gynsaui3",
      "Description": "vpc描述",
      "DomainName": "",
      "Ipv6CidrBlock": "",
      "Region": "ap-hangzhou-ecm",
      "DhcpOptionsId": "",
      "InstanceCount": 0,
      "DnsServerSet": [],
      "EnableMulticast": false,
      "VpcName": "vpc名称",
      "AssistantCidrSet": null,
      "TagSet": null,
      "SubnetCount": 0,
      "CreatedTime": "2020-08-14 10:58:26",
      "CidrBlock": "10.10.0.0/28",
      "IsDefault": false,
      "RegionName": "杭州一区"
    }
  }
}

示例2 创建实例指定tag

输入示例

https://ecm.tencentcloudapi.com/?Action=CreateVpc
&VpcName=vpc名称
&CidrBlock=192.168.0.0/18
&EcmRegion=ap-hangzhou-ecm
&Tags.0.Key=标签键
&Tags.0.Value=标签值
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "23b74de1-185b-4e02-9531-a4c53010e5d8",
    "Vpc": {
      "EnableDhcp": true,
      "VpcId": "vpc-hqhu0suj",
      "Description": "",
      "DomainName": "",
      "Ipv6CidrBlock": "",
      "Region": "ap-hangzhou-ecm",
      "DhcpOptionsId": "",
      "InstanceCount": 0,
      "DnsServerSet": [],
      "EnableMulticast": false,
      "VpcName": "vpc名称",
      "AssistantCidrSet": null,
      "TagSet": [
        {
          "Value": "标签值",
          "Key": "标签键"
        }
      ],
      "SubnetCount": 0,
      "CreatedTime": "2020-08-14 11:28:20",
      "CidrBlock": "192.168.0.0/18",
      "IsDefault": false,
      "RegionName": "杭州一区"
    }
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
InvalidParameterValue.InvalidRegion ecm region不合法。
InvalidParameterValue.LimitExceeded 参数值超出限制。
InvalidParameterValue.TooLong 参数值太长。
LimitExceeded 超过配额限制。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
目录