setNatGatewayDescription

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

概要

NAT Gatewayの説明を修正します。

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制約事項	説明
regionCode	No	String		リージョンコード説明を修正するNAT Gatewayインスタンスのリージョン(Region)を決定できます。 regionCodeはgetRegionListアクションを通じて取得できます。 Default：getRegionList照会結果の最初のリージョンを選択
natGatewayInstanceNo	Yes	String		説明を修正するNAT Gatewayインスタンス番号 natGatewayInstanceNoはgetNatGatewayInstanceListアクションを通じて取得できます。
natGatewayDescription	No	String	Min : 0, Max : 1000 Bytes	修正するNAT Gatewayに関する説明
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 setNatGatewayDescription --regionCode KR --natGatewayInstanceNo ***38 --natGatewayDescription test-description

レスポンス例

<setNatGatewayDescriptionResponse>
  <requestId>bbe69135-359f-443a-8a32-d38d590e2c87</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-06-24T08:58:20+0900</createDate>
      <natGatewayDescription>test-description</natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
    </natGatewayInstance>
  </natGatewayInstanceList>
</setNatGatewayDescriptionResponse>

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

What's Next

getVpcPeeringInstanceList

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

タグ