getLoadBalancerInstanceList
- 印刷する
- PDF
getLoadBalancerInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
ユーザーが指定した条件に基づいてロードバランサインスタンスのリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /getLoadBalancerInstanceList |
リクエストヘッダ
Load Balancer APIで共通して使用されるヘッダの詳細は、Load Balancerの共通ヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | リスト照会対象のロードバランサインスタンスのリージョンコード
|
vpcNo | String | Optional | リスト照会対象のロードバランサインスタンスの VPC番号
|
loadBalancerTypeCode | String | Optional | ロードバランサのタイプ
|
loadBalancerNetworkTypeCode | String | Optional | ロードバランサのネットワークタイプ
|
loadBalancerInstanceNoList.N | List<String> | Optional | ロードバランサインスタンスの番号リスト
|
pageNo | Integer | Optional | ページング処理された結果のページ番号 |
pageSize | Integer | Conditional | ページごとに表示する結果数
|
sortList.N.sortedBy | String | Optional | ソート基準
|
sortList.N.sortingOrder | String | Optional | ソート順序
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/getLoadBalancerInstanceList
?regionCode=KR
&vpcNo=*****
&loadBalancerTypeCode=APPLICATION
&loadBalancerNetworkTypeCode=PRIVATE
&loadBalancerInstanceNoList.1=********'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、LoadBalancerInstanceListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
<getLoadBalancerInstanceListResponse>
<requestId>b946dee5-4699-43b8-8e85-2e409d689166</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>********</loadBalancerInstanceNo>
<loadBalancerInstanceStatus>
<code>USED</code>
<codeName>LB USED state</codeName>
</loadBalancerInstanceStatus>
<loadBalancerInstanceOperation>
<code>NULL</code>
<codeName>LB NULL OP</codeName>
</loadBalancerInstanceOperation>
<loadBalancerInstanceStatusName>Running</loadBalancerInstanceStatusName>
<loadBalancerDescription></loadBalancerDescription>
<createDate>2024-06-03T17:09:52+0900</createDate>
<loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
<loadBalancerDomain>***.com</loadBalancerDomain>
<loadBalancerIpList>
<loadBalancerIp>**.*.*.*</loadBalancerIp>
</loadBalancerIpList>
<loadBalancerType>
<code>APPLICATION</code>
<codeName>Application Load Balancer</codeName>
</loadBalancerType>
<loadBalancerNetworkType>
<code>PRIVATE</code>
<codeName>Private</codeName>
</loadBalancerNetworkType>
<throughputType>
<code>SMALL</code>
<codeName>Small</codeName>
</throughputType>
<idleTimeout>60</idleTimeout>
<vpcNo>*****</vpcNo>
<regionCode>KR</regionCode>
<subnetNoList>
<subnetNo>******</subnetNo>
</subnetNoList>
<loadBalancerSubnetList>
<loadBalancerSubnet>
<zoneCode>KR-1</zoneCode>
<subnetNo>******</subnetNo>
<publicIpInstanceNo></publicIpInstanceNo>
</loadBalancerSubnet>
</loadBalancerSubnetList>
<loadBalancerListenerNoList>
<loadBalancerListenerNo>******</loadBalancerListenerNo>
</loadBalancerListenerNoList>
</loadBalancerInstance>
</loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>
この記事は役に立ちましたか?