文档

CreateVpcPrefixList - 创建前缀列表

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CreateVpcPrefixListcreate
  • PrefixList
    acs:vpc:{#regionId}:{#accountId}:prefixlist/*

请求参数

名称类型必填描述示例值
PrefixListNamestring

前缀列表的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

name
PrefixListDescriptionstring

前缀列表的描述信息。

描述长度为 1~256 个字符,不能以http://https://开头。

description
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
DryRunboolean

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

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

前缀列表中 CIDR 地址块的最大条目数。默认值为 50 条。

50
PrefixListEntriesarray<object>

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

object

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

Cidrstring

前缀列表的 CIDR 地址块。

192.168.0.0/16
Descriptionstring

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

描述长度为 1~256 个字符,不能以http://https://开头。

CIDR
ResourceGroupIdstring

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

rg-bp67acfmxazb4ph****
RegionIdstring

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

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

cn-hangzhou
IpVersionstring

IP 版本类型。取值:

  • IPv4(默认值):IPv4 类型。
  • IPv6:IPv6 类型。
IPv4
Tagarray<object>

标签列表。

object

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

前缀列表的实例 ID。

PrefixListIdstring

前缀列表的实例 ID。

pl-0b700s2ee3***
RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
ResourceGroupIdstring

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

rg-bp67acfmxazb4ph****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400UnsupportedFeature.IpVersionThe ipversion type is not supported.输入的ipVersion不支持
400QuotaExceeded.PrefixListCidrCountThe quota of prefixListMaxEntry count is exceeded.传入的最大entryCount超过阈值
400OperationFailed.CidrCountExceedMaxCountThe operation is failed because of cidrCountExceedMaxCount.用户传入的cidr数量超过cidrMaxCount
400IllegalParam.CidrBlockThe param of cidrBlock is illegal.cidrBlock参数非法
400IllegalParam.CidrNameThe param of cidrName is illegal.输入的cidrName非法
400DuplicatedParam.CidrBlockThe param of cidrBlock is duplicated.传入了重复的cidrBlock
400QuotaExceeded.PrefixListCountThe quota of prefixList count is exceeded.用户可创建的prefixList超过阈值

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

变更历史

变更时间变更内容概要操作
2023-07-05OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情