调用ModifyVpcPrefixList接口修改前缀列表的配置信息。
接口说明
-
ModifyVpcPrefixList 接口属于异步接口，即系统返回一个请求 ID，但该前缀列表实例的配置信息尚未修改成功，系统后台的修改任务仍在进行。您可以调用 ListPrefixLists 查询前缀列表实例的状态。
- 当前缀列表实例处于 Modifying 状态时，表示前缀列表实例的配置信息正在修改中。
- 当前缀列表实例处于 Created 状态时，表示前缀列表实例的配置信息修改成功。
- 前缀列表实例的配置信息修改成功后，您可以调用 GetVpcPrefixListAssociations 接口查询前缀列表的关联关系来确定关联的资源是否使用的是修改后的 CIDR 地址块，当前缀列表的关联状态即 Status 参数取值为 Created 时，表示关联的资源使用的 CIDR 地址块为修改后的 CIDR 地址块。
-
ModifyVpcPrefixList 接口不支持并发修改同一个前缀列表实例的配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ModifyVpcPrefixList | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PrefixListId | string | 是 | 要修改的前缀列表的实例 ID。 | pl-0b7hwu67**** |
| PrefixListName | string | 否 | 修改后的前缀列表的名称。 名称长度为 1～128 个字符，不能以 | newname |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| AddPrefixListEntry | array<object> | 否 | 要添加的前缀列表实例的 CIDR 地址块列表信息。 | |
| object | 否 | 要添加的前缀列表实例的 CIDR 地址块信息。 | ||
| Cidr | string | 否 | 要添加的前缀列表实例的 CIDR 地址块。 说明
如果要添加的 CIDR 地址块已经在前缀列表中存在，则只修改AddPrefixListEntry.N.Description的值，即只修改该 CIDR 地址块的描述信息。
| 172.16.0.0/12 |
| Description | string | 否 | 要添加的前缀列表实例的 CIDR 地址块描述信息。 描述长度为 1～256 个字符，不能以 | newcidr |
| RemovePrefixListEntry | array<object> | 否 | 要删除的前缀列表实例的 CIDR 地址块列表信息。 | |
| object | 否 | 要删除的前缀列表实例的 CIDR 地址块列表信息。 | ||
| Cidr | string | 否 | 要删除的前缀列表实例的 CIDR 地址块。 | 192.168.0.0/16 |
| Description | string | 否 | 要删除的前缀列表的 CIDR 地址块的描述信息。 | cidr |
| RegionId | string | 是 | 要修改配置信息的前缀列表实例所在的地域 ID。 | cn-hangzhou |
| PrefixListDescription | string | 否 | 修改后的前缀列表实例的描述信息。 描述长度为 1～256 个字符，不能以 | newdescription |
| MaxEntries | integer | 否 | 修改后的前缀列表实例的最大 CIDR 地址块条目数。 | 20 |
返回参数
示例
正常返回示例
JSON格式
{
"PrefixListId": "pl-0b7hwu67****",
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ResourceNotFound.PrefixList | The specified resource of prefixList is not found. | 输入的prefixList不存在 |
| 400 | OperationFailed.CidrCountExceedMaxCount | The operation is failed because of cidrCountExceedMaxCount. | 用户传入的cidr数量超过cidrMaxCount |
| 400 | OperationDenied.RemoveCountExceedExistCount | The operation is not allowed because of remove-count exceed exist-count. | 删除cidr数量超过，prefixList拥有的数量 |
| 400 | DuplicatedParam.CidrBlock | The param of cidrBlock is duplicated. | 传入了重复的cidrBlock |
| 400 | IllegalParam.CidrBlock | The param of cidrBlock is illegal. | cidrBlock参数非法 |
| 400 | IllegalParam.CidrName | The param of cidrName is illegal. | 输入的cidrName非法 |
| 400 | OperationDenied.SystemPrefixList | This is not allowed to operate system prefixList. | - |
| 400 | OperationFailed.OperateShareResource | This is not allowed to operate shared prefixList. | 无法操作共享PrefixList |
| 400 | IncorrectStatus.PrefixList | The status of prefixList is incorrect. | PrefixList处于中间态，无法操作 |
| 400 | QuotaExceeded.PrefixListCidrCount | The quota of prefixList entry maxEntry count is exceeded. | prefixList允许的最大路由条目数量超过限制 |
| 400 | QuotaExceeded | Route entry quota exceeded in associated route table. | prefixList最大路由条目数超过关联的路由表允许的最大路由条目 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-08-30 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |