getLoadBalancerInstanceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

概要

ロードバランサーインスタンスを照会します。

リクエスト

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表したものです。 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなします。
x-ncp-apigw-api-key	API Gatewayから発行されたキー(v2バージョンでは入れる必要がありません。)
x-ncp-iam-access-key	Naverクラウドプラットフォームから発行されたAPI KeyまたはIAMから発行されたAccessKey
x-ncp-apigw-signature-v2	BodyをAccessKeyとマッピングされるSecretKeyで暗号化した署名 HMAC暗号化のアルゴリズムはHmacSHA256を使用

リクエストパラメータ

パラメータ名	必須	タイプ	制約事項	説明
loadBalancerInstanceNoList.N	No	String	重複不可	ロードバランサーインスタンス番号リストロードバランサー番号をリストで受け取って、照会時にフィルタリングできます。 ex)loadBalancerInstanceNoList.1=123&loadBalancerInstanceNoList.2=345
networkUsageTypeCode	No	String	Min : 1 Max : 5	ネットワーク用途区分コードを受け取って、照会時にフィルタリングできます。(グローバルIPロードバランサー/プライベートIPロードバランサー) `PBLIP(Public)` `PRVT(Private)`
regionNo	No	String		リージョン番号を受け取って、照会時に該当するリジョンのみフィルタリングできます。リージョン番号はgetRegionListアクションを通じて取得できます。 `default : 1 (KR)`
zoneNo	No	String		ゾーン番号を受け取って、照会時に該当するゾーンのみフィルタリングできます。ゾーン番号はgetZoneListアクションを通じて取得できます。リージョン番号とゾーン番号をすべて入力する場合はゾーン番号を基準に照会します。
	No	Integer	Min : 0 Max : 2147483647	ページングされた結果のページ番号結果値を`pageNo` `pageSize`を利用してページング処理することが可能です。
pageSize	No	Integer	Min : 0 Max : 2147483647	ページングする時に表示する各ページサイズ結果値を `pageNo` `pageSize`を利用してページング処理することが可能です。
sortedBy	No	String		リスト結果に対するソート対象設定ができます。 `loadBalancerName(ロードバランサー名)` `loadBalancerInstanceNo(ロードバランサーインスタンス番号)` `default :loadBalancerInstanceNo(ロードバランサーインスタンス番号)` `大小文字区分なし`
sortingOrder	No	String		アセンディング、ディセンディングに対するリスト結果にorderingを設定できます。 `ascending(アセンディング)` `descending(ディセンディング)` `default : ascending(アセンディング)` `大小文字区分なし`

レスポンス

レスポンスボディ

LoadBalancerInstance

例示

リクエスト例示

GET {LOADBALANCER_API_URL}/loadbalancer/v2/getLoadBalancerInstanceList?loadBalancerInstanceNoList.1=757593

レスポンス例示

以下のエラーコードは、このアクション(Action)で特徴的に発生するエラーです。共通的に発生するエラーに対する詳細な説明はNAVER Cloud Platform APIをご参考ください。

<getLoadBalancerInstanceListResponse>
  <requestId>9a1fd360-8f49-4842-b0fa-2f06d28234b4</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstance>
      <loadBalancerInstanceNo>1083108</loadBalancerInstanceNo>
      <virtualIp>49.236.150.32,49.236.151.188</virtualIp>
      <loadBalancerName>penguin</loadBalancerName>
      <zoneList>
        <zone>
          <zoneNo>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>カサンzone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
        <zone>
          <zoneNo>3</zoneNo>
          <zoneName>KR-2</zoneName>
          <zoneCode>KR-2</zoneCode>
          <zoneDescription>平村zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
      </zoneList>
      <region>
        <regionNo>1</regionNo>
        <regionCode>KR</regionCode>
        <regionName>Korea</regionName>
      </region>
      <loadBalancerAlgorithmType>
        <code>RR</code>
        <codeName>Round Robin</codeName>
      </loadBalancerAlgorithmType>
      <loadBalancerDescription></loadBalancerDescription>
      <createDate>2018-11-26T11:04:31+0900</createDate>
      <domainName>slb-1083108.ncloudslb.com</domainName>
      <loadBalancerInstanceStatusName>used</loadBalancerInstanceStatusName>
      <loadBalancerInstanceStatus>
        <code>USED</code>
        <codeName>NET USED state</codeName>
      </loadBalancerInstanceStatus>
      <loadBalancerInstanceOperation>
        <code>NULL</code>
        <codeName>NET NULL OP</codeName>
      </loadBalancerInstanceOperation>
      <networkUsageType>
        <code>PBLIP</code>
        <codeName>Public</codeName>
      </networkUsageType>
      <isHttpKeepAlive>false</isHttpKeepAlive>
      <connectionTimeout>60</connectionTimeout>
      <certificateName></certificateName>
      <loadBalancerRuleList>
        <loadBalancerRule>
          <protocolType>
            <code>HTTP</code>
            <codeName>http</codeName>
          </protocolType>
          <loadBalancerPort>80</loadBalancerPort>
          <serverPort>80</serverPort>
          <l7HealthCheckPath>/</l7HealthCheckPath>
          <certificateName></certificateName>
          <proxyProtocolUseYn>N</proxyProtocolUseYn>
          <stickySessionUseYn>N</stickySessionUseYn>
          <http2UseYn>N</http2UseYn>
        </loadBalancerRule>
      </loadBalancerRuleList>
      <loadBalancedServerInstanceList/>
    </loadBalancerInstance>
  </loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>

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

What's Next

getLoadBalancerTargetServerInstanceList

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

タグ

Load Balancer