调用CreatePrefixList创建一个前缀列表。
接口说明
-
前缀列表是一些网络前缀(即 CIDR 地址块)的集合,您可以在配置其他资源的网络规则时引用前缀列表。关于前缀列表的详细说明,请参见前缀列表概述。
-
创建前缀列表时:
- 您必须为该前缀列表指定地址族(IPv4 或 IPv6),同一前缀列表中的条目只能属于同一地址族,且地址族创建后不能修改。
- 您必须为该前缀列表设置最大条目容量,且创建后不能修改。
- 您可以为该前缀列表指定一些条目,条目由 CIDR 地址块和描述构成,条目数量不能超过您设置的最大条目容量。
-
关于前缀列表及其他资源的使用限制说明,请参见使用限制。
-
通过 RAM 用户可以让您避免与其他用户共享阿里云账号密钥,按需为用户分配最小权限,从而降低企业的信息安全风险。关于如何为 RAM 用户授予前缀列表相关权限的具体操作,请参见为 RAM 用户授予前缀列表相关权限。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:CreatePrefixList | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-chengdu |
MaxEntries | integer | 是 | 前缀列表支持的最大条目容量。取值范围:1~200。 | 10 |
AddressFamily | string | 是 | 前缀列表的地址族。取值范围:
| IPv4 |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 | 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
PrefixListName | string | 是 | 前缀列表的名称。长度为 2~128 个字符,必须以大小字母或中文开头,不能以 | PrefixListNameSample |
Description | string | 否 | 前缀列表的描述信息。长度为 2~256 个英文或中文字符,不能以 | This is description. |
Entry | array<object> | 否 | 前缀列表条目信息。 | |
object | 否 | |||
Description | string | 否 | 前缀列表条目的描述信息。长度为 2~32 个英文或中文字符,不能以 | Description Sample 01 |
Cidr | string | 是 | 前缀列表条目的 CIDR 地址块信息。N 的取值范围:0~200。注意事项:
关于 CIDR 地址块的详细信息,请参见什么是 CIDR。 默认值:空。 | 192.168.1.0/24 |
返回参数
示例
正常返回示例
JSON
格式
{
"PrefixListId": "pl-x1j1k5ykzqlixdcy****",
"RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | %s | 缺失参数,请检查参数是否完整。 |
400 | InvalidParameter.AddressFamily | The parameter AddressFamily should be IPv4 or IPv6. | 地址族应为IPv4或IPv6。 |
400 | InvalidParameter | %s | 无效的参数。 |
400 | InvalidParameter.PrefixListName | The parameter PrefixListName is not valid. | 前缀列表名称不合法。 |
400 | InvalidDescription.Malformed | The specified Description is wrongly formed. | 指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。 |
400 | InvalidClientToken.ValueNotSupported | The ClientToken provided is invalid. | 指定的 ClientToken 不合法。 |
400 | InvalidParameter.CidrMalformed | %s | 指定的CIDR地址块不合法。 |
400 | InvalidParameter.CidrDuplicated | %s | 指定的 CIDR 地址块重复。 |
400 | LimitExceed.Entry | The number of entries added or removed exceeds the limit. | 单次增加或删除的条目数量超出限制。 |
400 | LimitExceed.MaxEntries | The number of entries exceeds the MaxEntries of the specified prefix list. | 条目数量超出指定前缀列表支持的最大条目数。 |
404 | LimitExceed.PrefixListPerRegion | The number of prefix lists in the region exceeds the limit. | 在当前地域下的前缀列表数量超出限制。 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-11-13 | OpenAPI 错误码发生变更 | 查看变更详情 |