调用CreateVpcPrefixList接口创建前缀列表。

使用说明

CreateVpcPrefixList接口不支持在同一个地域内并发创建前缀列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateVpcPrefixList

系统规定参数。取值：CreateVpcPrefixList。
PrefixListName String 否 name

前缀列表的名称。

名称长度为1～128个字符，不能以http://或https://开头。
PrefixListDescription String 否 description

前缀列表的描述信息。

描述长度为1～256个字符，不能以http://或https://开头。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会创建前缀列表。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建前缀列表。
MaxEntries Integer 否 50

前缀列表中CIDR地址块的最大条目数。默认值为50条。
PrefixListEntries.N.Cidr String 否 192.168.0.0/16

前缀列表的CIDR地址块。
PrefixListEntries.N.Description String 否 CIDR

前缀列表CIDR地址块的描述信息。

描述长度为1～256个字符，不能以http://或https://开头。
ResourceGroupId String 否 rg-bp67acfmxazb4ph****

前缀列表所属的资源组ID。
RegionId String 是 cn-hangzhou

要创建的前缀列表所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

IpVersion String 否 IPv4

IP版本类型。取值：

  • IPv4（默认值）：IPv4类型。
  • IPv6：IPv6类型。

返回数据

名称 类型 示例值 描述
PrefixListId String pl-0b700s2ee3***

前缀列表的实例ID。
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

请求ID。
ResourceGroupId String rg-bp67acfmxazb4ph****

前缀列表所属的资源组ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpcPrefixList
&PrefixListName=name
&PrefixListDescription=description
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&MaxEntries=50
&PrefixListEntries=[{"Cidr":"192.168.0.0/16","Description":"CIDR"}]
&ResourceGroupId=rg-bp67acfmxazb4ph****
&RegionId=cn-hangzhou
&IpVersion=IPv4
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpcPrefixListResponse>
    <PrefixListId>pl-0b700s2ee3***</PrefixListId>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
</CreateVpcPrefixListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PrefixListId" : "pl-0b700s2ee3***",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ResourceGroupId" : "rg-bp67acfmxazb4ph****"
}

错误码

HttpCode 错误码 错误信息 描述
400 UnsupportedFeature.IpVersion The ipversion type is not supported. 输入的ipVersion不支持
400 QuotaExceeded.PrefixListCidrCount The quota of prefixListMaxEntry count is exceeded. 传入的最大entryCount超过阈值
400 OperationFailed.CidrCountExceedMaxCount The operation is failed because of cidrCountExceedMaxCount. 用户传入的cidr数量超过cidrMaxCount
400 IllegalParam.CidrBlock The param of cidrBlock is illegal. cidrBlock参数非法
400 IllegalParam.CidrName The param of cidrName is illegal. 输入的cidrName非法
400 DuplicatedParam.CidrBlock The param of cidrBlock is duplicated. 传入了重复的cidrBlock
400 QuotaExceeded.PrefixListCount The quota of prefixList count is exceeded. 用户可创建的prefixList超过阈值

访问错误中心查看更多错误码。