Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getPortForwardingConfigurationList

Prev Next

Classic環境で利用できます。

概要

ポートフォワード設定リストの照会

説明

ポートフォワード設定リスト(Port Forwarding Configuration List)情報を照会します。

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionNo No String - リージョン番号
ポートフォワード設定リスト(Configuation List)が照会されるリージョン(Region)を決定可能
regionNoはgetRegionListアクションを通じて取得できます。
serverInstanceNoList No List<String> - サーバインスタンス番号リスト
指定したサーバインスタンスに該当するポートフォワード設定リストを照会できる
serverInstanceNoは、getServerInstanceListアクションを通じて取得可能
例) serverInstanceNoList 12345 serverInstanceNoList 23456
portForwardingPublicIpList No List<String> - ポートフォワードグローバルIPリスト
ポートフォワードグローバルIPでフィルタリングして照会できる
portForwardingPublicIpは、getServerInstanceListアクションを通じて取得可能
例) portForwardingPublicIpList "192.168.0.1" portForwardingPublicIpList "192.168.0.2"

レスポンスデータのタイプ

  • PortForwardingConfigurationListタイプ
PortForwardingConfigurationList extends CommonResponse
private Integer totalRows;
private List portForwardingConfigurationList = new ArrayList<>();
PortForwardingRule
private String portForwardingConfigurationNo;
private String portForwardingPublicIp;
private ServerInstanceNoList serverInstanceNoList;

呼び出し

ncloud server getPortForwardingConfigurationList

レスポンス

{
  "getPortForwardingConfigurationListResponse": {
    "requestId": "e2068abf-aa0d-46d6-8e7f-8e86c9805f5e",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "portForwardingConfigurationList": [
      {
        "portForwardingConfigurationNo": "***536",
        "portForwardingPublicIp": "***.***.160.56",
        "serverInstanceNoList": [
          "***5058"
        ]
      }
    ]
  }
}
<getPortForwardingConfigurationListResponse>
  <requestId>e2068abf-aa0d-46d6-8e7f-8e86c9805f5e</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <portForwardingConfigurationList>
    <portForwardingConfiguration>
      <portForwardingConfigurationNo>***536</portForwardingConfigurationNo>
      <portForwardingPublicIp>***.***.160.56</portForwardingPublicIp>
      <serverInstanceNoList>
        <serverInstanceNo>***5058</serverInstanceNo>
      </serverInstanceNoList>
    </portForwardingConfiguration>
  </portForwardingConfigurationList>
</getPortForwardingConfigurationListResponse>