调用ModifyVpcPrefixList接口修改前缀列表实例的配置信息。

使用说明

  • ModifyVpcPrefixList接口属于异步接口，即系统返回一个请求ID，但该前缀列表实例的配置信息尚未修改成功，系统后台的修改任务仍在进行。您可以调用ListPrefixLists查询前缀列表实例的状态。
    • 当前缀列表实例处于Modifying状态时，表示前缀列表实例的配置信息正在修改中。
    • 当前缀列表实例处于Created状态时，表示前缀列表实例的配置信息修改成功。
    • 前缀列表实例的配置信息修改成功后，您可以调用GetVpcPrefixListAssociations接口查询前缀列表的关联关系来确定关联的资源是否使用的是修改后的CIDR地址块，当前缀列表的关联状态即Status参数取值为Created时，表示关联的资源使用的CIDR地址块为修改后的CIDR地址块。
  • ModifyVpcPrefixList接口不支持并发修改同一个前缀列表实例的配置信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyVpcPrefixList

系统规定参数。取值：ModifyVpcPrefixList。

PrefixListId String 是 pl-0b7hwu67****

要修改的前缀列表的实例ID。
PrefixListName String 否 newname

修改后的前缀列表的名称。

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

ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean 否 false

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

  • true：发送检查请求，不会修改前缀列表的配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改前缀列表的配置信息。
AddPrefixListEntry.N.Cidr String 否 172.16.0.0/12

要添加的前缀列表实例的CIDR地址块。

说明 如果要添加的CIDR地址块已经在前缀列表中存在，则只修改AddPrefixListEntry.N.Description的值，即只修改该CIDR地址块的描述信息。
AddPrefixListEntry.N.Description String 否 newcidr

要添加的前缀列表实例的CIDR地址块描述信息。

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

RemovePrefixListEntry.N.Cidr String 否 192.168.0.0/16

要删除的前缀列表实例的CIDR地址块。
RemovePrefixListEntry.N.Description String 否 cidr

要删除的前缀列表的CIDR地址块的描述信息。
RegionId String 是 cn-hangzhou

要修改配置信息的前缀列表实例所在的地域ID。
PrefixListDescription String 否 newdescription

修改后的前缀列表实例的描述信息。

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

MaxEntries Integer 否 20

修改后的前缀列表实例的最大CIDR地址块条目数。

返回数据

名称 类型 示例值 描述
PrefixListId String pl-0b7hwu67****

前缀列表的实例ID。
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyVpcPrefixList
&PrefixListId=pl-0b7hwu67****
&PrefixListName=newname
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&AddPrefixListEntry=[{"Cidr":"172.16.0.0/12","Description":"newcidr"}]
&RemovePrefixListEntry=[{"Cidr":"192.168.0.0/16","Description":"cidr"}]
&RegionId=cn-hangzhou
&PrefixListDescription=newdescription
&MaxEntries=20
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyVpcPrefixListResponse>
    <PrefixListId>pl-0b7hwu67****</PrefixListId>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
</ModifyVpcPrefixListResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PrefixListId" : "pl-0b7hwu67****",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

错误码

HttpCode 错误码 错误信息 描述
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 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最大路由条目数超过关联的路由表允许的最大路由条目

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