调用UpdatePublicIpAddressPoolAttribute接口修改地址池属性。

使用说明

UpdatePublicIpAddressPoolAttribute接口不支持并发修改同一个地址池的属性。

调试

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

请求参数

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

系统规定参数。取值：UpdatePublicIpAddressPoolAttribute。
PublicIpAddressPoolId String 是 pippool-6wetvn6fumkgycssx****

IP地址池的实例ID。
Name String 否 AddressPoolName

地址池实例的名称。

描述可以为空，或输入1~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以http://或https://开头。
Description String 否 AddressPoolDescription

地址池实例的描述。

描述可以为空，或输入长度为2~256个中英文字符，不能以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状态码并直接进行操作。
RegionId String 是 cn-chengdu

要修改的IP地址池所在的地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdatePublicIpAddressPoolAttribute
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&Name=AddressPoolName
&Description=AddressPoolDescription
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&RegionId=cn-chengdu
&公共请求参数

正常返回示例

XML格式

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

<UpdatePublicIpAddressPoolAttributeResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</UpdatePublicIpAddressPoolAttributeResponse>

JSON格式

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

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.Description The param of Description [%s] is illegal. 参数Description 不合法，请根据请求参数规定重新输入。
400 ResourceNotFound.PublicIpAddressPool The specified resource of PublicIpAddressPool [%s] is not found. 指定的公网IP地址池实例不存在
400 OperationDenied.OperateSharedResource The operation is not allowed because of the PublicIpAddressPool is a shared resource. 该公网IP地址池实例是共享资源，不允许修改。

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