getPublicIpInstanceDetail

Prev Next

VPC環境で利用できます。

概要

グローバルIPインスタンス番号を利用してグローバルIPインスタンスの詳細情報を照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
グローバルIPインスタンスの詳細情報が照会されるリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default:getRegionList照会結果の最初のリージョンを選択
publicIpInstanceNo Yes String 照会するグローバルIPインスタンス番号
publicIpInstanceNoはgetPublicIpInstanceListアクションを通じて取得できます。
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータタイプ

  • PublicIpInstanceListタイプ
PublicIpInstanceList extends CommonResponse
private Integer totalRows;
private List<PublicIpInstance> publicIpInstanceList = new ArrayList<>();
PublicIpInstance
private String publicIpInstanceNo;
private String publicIp;
private String publicIpDescription;
private Date createDate;
private String publicIpInstanceStatusName;
private CommonCode publicIpInstanceStatus;
private String serverInstanceNo;
private String serverName;
private String privateIp;
private Date lastModifyDate;
private CommonCode publicIpInstanceOperation;

リクエスト例

ncloud vserver getPublicIpInstanceDetail --regionCode FKR --publicIpInstanceNo ***7551

レスポンス例

<getPublicIpInstanceDetailResponse>
  <requestId>d9a37d96-eaca-41e0-9878-ffb3085b77ca</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>
</getPublicIpInstanceDetailResponse>