getPublicIpInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

概要

グローバルIPインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	説明
regionCode	No	String	リージョンコードグローバルIPインスタンスのリストが照会されるリージョン(Region)を決定できます。 regionCodeはgetRegionListアクションを通じて取得できます。 Default：getRegionList照会結果の最初のリージョンを選択
publicIpInstanceNoList.N	No	List<String>	グローバルIPインスタンス番号リストグローバルIPインスタンス番号でフィルタリングして検索できます。 publicIpInstanceNoはgetPublicIpInstanceListアクションを通じて取得できます。 ex) publicIpInstanceNoList.1=1234&publicIpInstanceNoList.2=2345
publicIp	No	String	グローバルIPアドレスグローバルIPアドレスでフィルタリングして検索できます。
privateIp	No	String	プライベートIPアドレスグローバルIPインスタンスが割り当てられたサーバインスタンスのeth0プライベートIPアドレスでフィルタリングして検索できます。
isAssociated	No	Boolean	割り当ての有無サーバインスタンスに割り当てられたグローバルIPと割り当てられていないグローバルIPでフィルタリングして検索できます。 Options : true \| false
serverName	No	String	サーバ名グローバルIPインスタンスが割り当てられたサーバ名でフィルタリングして検索できます。
publicIpInstanceStatusCode	No	String	グローバルIPインスタンスのステータスコードグローバルIPインスタンスのステータスコードでフィルタリングして検索できます。 Options : INIT \| SET \| RUN \| TERMTING
pageNo	No	Integer	ページングされた結果のページ番号結果値をpageNo、pageSizeを利用してページング処理できます。
pageSize	Conditional	Integer	ページングする時に表示する各ページサイズ結果値をpageNo、pageSizeを利用してページング処理できます。 pageNoを入力する時、必ず入力しなければなりません。
vpcNo	No	String	VPC番号 VPC番号でフィルタリングして検索できます。 vpcNoはgetVpcListアクションを通じて取得できます。
responseFormatType	No	String	レスポンス結果のフォーマットタイプ Options : xml \| json Default : xml

レスポンス

レスポンスボディ

PublicIpInstanceList

例

リクエスト例

GET {API_URL}/getPublicIpInstanceList
?regionCode=KR
&publicIpInstanceNoList.1=***7551
&publicIp=***.***.111.215
&privateIp=***.***.1.6
&isAssociated=true
&serverName=test-***
&publicIpInstanceStatusCode=RUN
&vpcNo=***04

レスポンス例

<getPublicIpInstanceListResponse>
  <requestId>ff28f839-00f2-4d07-bd6b-b172596eebf8</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <publicIpInstanceList>
    <publicIpInstance>
      <publicIpInstanceNo>***7551</publicIpInstanceNo>
      <publicIp>***.***.111.215</publicIp>
      <publicIpDescription></publicIpDescription>
      <createDate>2020-08-19T14:34:41+0900</createDate>
      <publicIpInstanceStatusName>運用中</publicIpInstanceStatusName>
      <publicIpInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </publicIpInstanceStatus>
      <serverInstanceNo>***4299</serverInstanceNo>
      <serverName>test-***</serverName>
      <privateIp>***.***.1.6</privateIp>
      <publicIpInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </publicIpInstanceOperation>
    </publicIpInstance>
  </publicIpInstanceList>
</getPublicIpInstanceListResponse>

この記事は役に立ちましたか?

What's Next

getPublicIpInstanceDetail

概要
リクエスト
レスポンス
例

タグ