IPアドレスプールの属性を変更します。

使用上の注意

  • 必要な権限を持つユーザーのみがElastic IP address (EIP) のIPアドレスプール機能を使用できます。 必要な権限を申請するには、チケットを起票してください。

  • UpdatePublicIpAddressPoolAttributeを繰り返し呼び出して、指定された期間内にIPアドレスプールの属性を変更することはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 UpdatePublicIpAddressPoolAttribute

実行する操作です。 値をUpdatePublicIpAddressPoolAttributeに設定します。

PublicIpAddressPoolId String 必須 pippool-6wetvn6fumkgycssx ****

IPアドレスプールのID。

名前 String 任意 AddressPoolName

IPアドレスプールの名前。

このパラメーターはオプションです。 名前を入力する場合、名前は1 ~ 128文字で、数字、ピリオド (.) 、アンダースコア (_) 、ハイフン (-) を使用できます。 名前は文字で始める必要がありますが、http:// またはhttps:// で始めることはできません。

説明　 String 任意 AddressPoolDescription

IPアドレスプールの説明。

このパラメーターはオプションです。 説明を入力する場合、説明の長さは2〜256文字である必要があり、http:// またはhttps:// で始めることはできません。

ClientToken String 任意 123e4567-e89b-12d3-a456-426655440000

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 クライアントトークンにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、システムはRequestIdをClientTokenとして使用します。 RequestIdは、APIリクエストごとに異なる場合があります。
DryRun Boolean いいえ false

操作を実行せずにリクエストをチェックするかどうかを指定します。 有効な値：

  • true: 操作を実行せずにリクエストをチェックします。 システムは、必要なパラメーター、要求構文、および制限をチェックします。 要求がチェックに合格しなかった場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false (デフォルト): リクエストを送信します。 リクエストが事前チェックに合格すると、HTTP 2xxステータスコードが返され、操作が実行されます。
RegionId String 必須 cn-chengdu

変更するIPアドレスプールのリージョンID。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

リクエストの ID です。

例

リクエストの例

http(s):// [エンドポイント]/? アクション=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"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。