getNatGatewayInstanceDetail

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

概要

NAT Gatewayインスタンス番号を利用してNAT Gatewayインスタンスの詳細情報を照会します。

リクエスト

リクエストパラメータ

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

レスポンス

レスポンスデータタイプ

NatGatewayInstanceListタイプ

NatGatewayInstanceList extends CommonResponse
private Integer totalRows;
private List natGatewayInstanceList = new ArrayList<>();

NatGatewayInstance
private String vpcNo;
private String vpcName;
private String natGatewayInstanceNo;
private String natGatewayName;
private String publicIp;
private CommonCode natGatewayInstanceStatus;
private String natGatewayInstanceStatusName;
private CommonCode natGatewayInstanceOperation;
private Date createDate;
private String natGatewayDescription;
private String zoneCode;

例

リクエスト例

ncloud vpc getNatGatewayInstanceDetail --regionCode KR --natGatewayInstanceNo ***9734

レスポンス例

<getNatGatewayInstanceDetailResponse>
  <requestId>f692e1b8-b15b-4c39-8911-150263abf71b</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***04</vpcNo>
      <vpcName>test-***</vpcName>
      <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
      <natGatewayName>test-***</natGatewayName>
      <publicIp>***.***.109.101</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>運用中</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2020-08-06T11:47:40+0900</createDate>
      <natGatewayDescription></natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
    </natGatewayInstance>
  </natGatewayInstanceList>
</getNatGatewayInstanceDetailResponse>

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

What's Next

createNatGatewayInstance

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

タグ