全部产品
Search
文档中心

云服务器 ECS:CreatePrefixList - 创建前缀列表

更新时间:Feb 04, 2024

调用CreatePrefixList创建一个前缀列表。

接口说明

  • 前缀列表是一些网络前缀(即 CIDR 地址块)的集合,您可以在配置其他资源的网络规则时引用前缀列表。关于前缀列表的详细说明,请参见前缀列表概述

  • 创建前缀列表时:

    • 您必须为该前缀列表指定地址族(IPv4 或 IPv6),同一前缀列表中的条目只能属于同一地址族,且地址族创建后不能修改。
    • 您必须为该前缀列表设置最大条目容量,且创建后不能修改。
    • 您可以为该前缀列表指定一些条目,条目由 CIDR 地址块和描述构成,条目数量不能超过您设置的最大条目容量。
  • 关于前缀列表及其他资源的使用限制说明,请参见使用限制

  • 通过 RAM 用户可以让您避免与其他用户共享阿里云账号密钥,按需为用户分配最小权限,从而降低企业的信息安全风险。关于如何为 RAM 用户授予前缀列表相关权限的具体操作,请参见为 RAM 用户授予前缀列表相关权限

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-chengdu
MaxEntriesinteger

前缀列表支持的最大条目容量。取值范围:1~200。

10
AddressFamilystring

前缀列表的地址族。取值范围:

  • IPv4。
  • IPv6。
IPv4
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

0c593ea1-3bea-11e9-b96b-88e9fe637760
PrefixListNamestring

前缀列表的名称。长度为 2~128 个字符,必须以大小字母或中文开头,不能以http://https://com.aliyuncom.alibabacloud开头。可以包含中文、英文、数字、半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

PrefixListNameSample
Descriptionstring

前缀列表的描述信息。长度为 2~256 个英文或中文字符,不能以http://https://开头。

This is description.
Entryobject []

前缀列表条目信息。

Descriptionstring

前缀列表条目的描述信息。长度为 2~32 个英文或中文字符,不能以http://https://开头。N 的取值范围:0~200。

Description Sample 01
Cidrstring

前缀列表条目的 CIDR 地址块信息。N 的取值范围:0~200。注意事项:

  • 前缀列表的条目数量不能大于最大条目容量(MaxEntries)。
  • 条目中的 CIDR 地址块类型根据地址族决定,一个前缀列表不能同时包含 IPv4 和 IPv6 的 CIDR 地址块。
  • 多个条目中的 CIDR 地址块不能重复。例如,您不能设置两个 192.168.1.0/24。
  • 支持设置单 IP 地址,系统会自动转换为 CIDR 地址块。例如,您设置 192.168.1.100,系统会自动转换成 192.168.1.100/32。
  • 如果使用 IPv6 CIDR 地址块,系统会自动转换成零压缩表示形式且字母转换为小写。例如,您设置 2001:0DB8:0000:0000:0000:0000:0000:0000/32,系统会自动转换成 2001:db8::/32。

关于 CIDR 地址块的详细信息,请参见什么是 CIDR

默认值:空。

192.168.1.0/24

返回参数

名称类型描述示例值
object
PrefixListIdstring

前缀列表 ID。

pl-x1j1k5ykzqlixdcy****
RequestIdstring

请求 ID。

38793DB8-A4B2-4AEC-BFD3-111234E9188D

示例

正常返回示例

JSON格式

{
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter%s缺失参数,请检查参数是否完整。
400InvalidParameter.AddressFamilyThe parameter AddressFamily should be IPv4 or IPv6.地址族应为IPv4或IPv6。
400InvalidParameter%s无效的参数。
400InvalidParameter.PrefixListNameThe parameter PrefixListName is not valid.前缀列表名称不合法。
400InvalidDescription.MalformedThe specified Description is wrongly formed.指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。
400InvalidClientToken.ValueNotSupportedThe ClientToken provided is invalid.指定的 ClientToken 不合法。
400InvalidParameter.CidrMalformed%s指定的CIDR地址块不合法。
400InvalidParameter.CidrDuplicated%s指定的 CIDR 地址块重复。
400LimitExceed.EntryThe number of entries added or removed exceeds the limit.单次增加或删除的条目数量超出限制。
400LimitExceed.MaxEntriesThe number of entries exceeds the MaxEntries of the specified prefix list.条目数量超出指定前缀列表支持的最大条目数。
404LimitExceed.PrefixListPerRegionThe number of prefix lists in the region exceeds the limit.在当前地域下的前缀列表数量超出限制。
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。

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

变更历史

变更时间变更内容概要操作
2023-11-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400