调用 ModifyPrefixList 接口，修改前缀列表。 ## 调用说明 ModifyPrefixList 为异步接口，即返回请求ID时，系统后台仍在配置。您可调用 [DescribePrefixLists](https://www.volcengine.com/docs/6401/1124629) 查看网卡的状态，`Pending`表示配置中，`Available` 表示修改完成。 ## 调试 ## 请求参数 |参数名称 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Action |String |是 |ModifyPrefixList |要执行的操作，取值：ModifyPrefixList。 | |Version |String |是 |2020\-04\-01 |API版本信息，取值为：2020\-04\-01。 | |PrefixListId |String |是 |pl\-bp1fg655nh68xyz9\*\*\*\* |要修改的前缀列表的ID。|\ | | | | |您可以调用 [DescribePrefixLists](https://www.volcengine.com/docs/6401/1124629) 接口，查询前缀列表的ID。 | |PrefixListName |String |否 |PrefixList\-1 |前缀列表的名称。|\ | | | | ||\ | | | | |* 长度限制为1 ~ 128个字符。|\ | | | | |* 需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（\-）。 | |Description |String |否 |PrefixList_Common |前缀列表的描述。|\ | | | | ||\ | | | | |* 长度限制为0~ 255个字符。|\ | | | | |* 需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（\-）、中文逗号（，）、中文句号（。）。 | |MaxEntries |Integer |否 |100 |最大条目数，即前缀列表最多可添加条目的数量。|\ | | | | ||\ | | | | |* 若前缀列表未关联资源，则最大条目数不大于200条。|\ | | | | |* 若前缀列表已关联资源，则最大条目数除了不大于200条外，还受已关联资源的配额限制。|\ | | | | ||\ | | | | |:::tip|\ | | | | |前缀列表的最大条目数会占用其关联资源的配额。修改最大条目数，可能导致待关联前缀列表的资源无法关联，请充分评估业务后，谨慎操作。|\ | | | | ||\ | | | | |:::| |AddPrefixListEntries.N.Cidr |String |否 |AddPrefixListEntries.1.Cidr=1.XX.XX.0/24&AddPrefixListEntries.2.Cidr=2.XX.XX.0/24 |要添加前缀列表条目的CIDR。|\ | | | | ||\ | | | | |* 参数 \- N：表示前缀列表条目的序号，取值范围：1～`MaxEntries`，且N应按照连续的从小到大的顺序。|\ | | | | |* 多个CIDR之间用&分隔。|\ | | | | ||\ | | | | |:::tip|\ | | | | |若添加的CIDR已存在，则仅修改`AddPrefixListEntries.N.Description`的值，即只修改该CIDR地址块的描述信息。|\ | | | | ||\ | | | | |:::| |AddPrefixListEntries.N.Description |String |否 |AddPrefixListEntries.1.Description=CIDR_A&AddPrefixListEntries.2.Description=CIDR_B |要添加前缀列表条目的描述。|\ | | | | ||\ | | | | |* 参数 \- N：表示前缀列表条目的序号，取值范围：1～`MaxEntries`，且N应按照连续的从小到大的顺序。|\ | | | | |* 多个描述之间用&分隔。|\ | | | | |* 长度限制为0~ 255个字符。|\ | | | | |* 不填默认为空字符串。|\ | | | | |* 需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（\-）、中文逗号（，）、中文句号（。）。 | |RemovePrefixListEntries.N.Cidr |String |否 |RemovePrefixListEntries.1.Cidr=192.168.0.0/16 |要删除的前缀列表条目。|\ | | | | ||\ | | | | |* 参数 \- N：表示前缀列表条目的序号，取值范围：1～`MaxEntries`，且N应按照连续的从小到大的顺序。|\ | | | | |* 多个描述之间用&分隔。 | |ClientToken |String |否 |123e4567\-e89b\-12d3\-a456\-42665544\*\*\*\* |客户端Token，用于保证请求幂等性。|\ | | | | ||\ | | | | |* 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。|\ | | | | |* 仅支持ASCII字符，且不能超过64个字符。|\ | | | | |* 若不传入ClientToken，则此次API调用不进行幂等校验。 | |DryRun |Boolean |否 |false |是否只预检此次请求。|\ | | | | |请严格按照以下枚举值的大小写输入，不要传入其他取值。|\ | | | | ||\ | | | | |* true：发送检查请求，不会修改前缀列表。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。|\ | | | | |* false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改前缀列表。 | ## 返回数据 |参数名称 |类型 |示例值 |描述 | |---|---|---|---| |RequestId |String |2021062415303301022514515207C4\*\*\*\* |请求ID。 | ## 请求示例 ```Plain Text GET /?Action=ModifyPrefixList&Version=2020-04-01&PrefixListId=pl-bp1fg655nh68xyz9****&AddPrefixListEntries.1.Cidr=1.XX.XX.0/24&AddPrefixListEntries.2.Cidr=2.XX.XX.0/24 HTTP/1.1 Host: open.volcengineapi.com Service: vpc Region: cn-beijing ``` ## 返回示例 ```Plain Text { "ResponseMetadata": { "RequestId": "2021062415303301022514515207C4****", "Action": "ModifyPrefixList", "Version": "2020-04-01", "Service": "vpc", "Region": "cn-beijing" }, "Result": { "RequestId": "2021062415303301022514515207C4****" } } ``` ## 错误码此处仅展示当前API的错误码，更多错误码请参见[公共错误码](https://www.volcengine.com/docs/6401/70814)。 |HttpCode |错误码 |错误信息 |描述 | |---|---|---|---| |400 |DryRunOperation |Exception raised to indicate a successfully authorized action when the DryRun flag is set to true. |该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。 | |400 |IdempotentParameterMismatch |Arguments on this idempotent request are inconsistent with arguments used in previous request(s). |此幂等请求的参数与前一个请求中使用的参数不一致。 | |400 |InvalidCidr.Malformed |The specified cidr block is malformed. |指定的网段格式不合法。 | |400 |InvalidCidr.ProtocolMismatch |The specified cidr block mismatch the protocol type. |指定的网段格式和协议类型不匹配。 | |400 |InvalidDescription.Malformed |The specified description is malformed. Ensure the maximum length of description is 255. |指定的描述格式不合法。描述长度不能超过255个字符。 | |400 |InvalidDescription.Malformed |The specified description is malformed. |指定的描述格式不合法。请修复描述格式后重试。 | |400 |InvalidMaxEntries.Malformed |The maximum number of entries is malformed. |最大条目数格式错误。 | |400 |InvalidName.Malformed |The specified name is malformed. Ensure the maximum length of name is 128. |指定的名称格式不合法。名称长度不能超过128个字符。 | |400 |InvalidName.Malformed |The specified name is malformed. |指定的名称格式不合法。请修复名称格式后重试。 | |400 |InvalidParameter.CidrCountExceedMaxCount |The number of CIDR blocks exceeded the maximum number of entries allowed. |网段数量超过前缀列表的最大条目数。 | |400 |InvalidParameter.ClientTokenMalformed |The specified parameter ClientToken is malformed. |指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。 | |400 |InvalidPrefixList.InvalidStatus |The specified prefix list is not in the correct status for the request. |指定的前缀列表所处状态无法响应该请求。 | |400 |InvalidPrefixListEntry.Conflict |The specified CIDR block conflicts with another one in the specified prefix list. |指定的前缀列表条目中存在重复的CIDR地址块。 | |400 |InvalidVpc.InvalidStatus |The specified VPC is not in the correct status for the request. |指定的VPC所处状态无法响应该请求。 | |400 |LimitExceeded.MaxEntries |You've reached the limit on the number of MaxEntries per prefix list that you can assign. |已达到前缀列表支持配置的最大CIDR地址块条目数。 | |404 |InvalidPrefixList.NotFound |The specified prefix list does not exist. |指定的前缀列表不存在。 | |409 |InvalidOperation.Conflict |The specified resource operation conflicts. |指定的资源操作冲突。 | |409 |InvalidRouteCidr.Conflict |The specified CIDR block conflicts with that of another route in your route table. |指定的CIDR地址块与所属路由表中另一个规则CIDR地址块冲突。 | |412 |IdempotentProcessing |The request uses the same client token as a previous one that is still in process. |幂等请求处理中。 |

私有网络