概要
ロードバランサインスタンスリスト照会
説明
ロードバランサインスタンスリストを照会します。
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| loadBalancerInstanceNoList | No | List |
重複不可 | 照会するロードバランサインスタンス番号リスト |
| networkUsageTypeCode | No | String | Min : 1, Max : 5 | ネットワーク用途区分コード PBLIP(Public), PRVT(Private) |
| regionNo | No | String | 入力できるステータスはgetRegionListアクションを通じて取得できます。 | |
| pageNo | No | Integer | Min : 0, Max : 2147483647 | 件数が多い場合はページサイズに該当するページ番号 |
| pageSize | No | Integer | Min : 0, Max : 2147483647 | 一つのページで照会するページサイズ |
| sortedBy | No | String | リスト結果に対するソートコラムを決定できます。 ロードバランサ名(loadBalancerName) | ロードバランサインスタンス番号(loadBalancerInstanceNo) [大小文字区分なし] Default: ロードバランサインスタンス番号(loadBalancerInstanceNo) |
|
| sortingOrder | No | String | アセンディング、ディセンディングに対する、リスト結果のorderingを決定できます。 アセンディング(ascending) | ディセンディング(descending) [大小文字区分なし] Default: アセンディング(ascending) |
レスポンスデータタイプ
- LoadBalancerInstanceListタイプ
| LoadBalancerInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| LoadBalancerInstance |
|---|
| private String loadBalancerInstanceNo; |
| private String virtualIp; |
| private String loadBalancerName; |
| private CommonCode loadBalancerAlgorithmType; |
| private String loadBalancerDescription; |
| private Date createDate; |
| private String domainName; |
| private String loadBalancerInstanceStatusName; |
| private CommonCode loadBalancerInstanceStatus; |
| private CommonCode loadBalancerInstanceOperation; |
| private CommonCode networkUsageType; |
| private Boolean isHttpKeepAlive; |
| private Integer connectionTimeout; |
| private String certificateName; |
| private List |
| private List |
例示
呼び出し
ncloud loadbalancer getLoadBalancerInstanceList --networkUsageTypeCode PRVT
レスポンス
{
"getLoadBalancerInstanceListResponse": {
"requestId": "d3a5be52-2003-4243-a037-3a1734210140",
"returnCode": 0,
"returnMessage": "success",
"totalRows": 1,
"loadBalancerInstanceList": [
{
"loadBalancerInstanceNo": 428577,
"virtualIp": "10.39.10.76",
"loadBalancerName": "cdb",
"loadBalancerAlgorithmType": {
"code": "RR",
"codeName": "Round Robin"
},
"loadBalancerDescription": "",
"createDate": "0133-10-23T21:01:41+0900",
"domainName": "",
"loadBalancerInstanceStatusName": "used",
"loadBalancerInstanceStatus": {
"code": "USED",
"codeName": "NET USED state"
},
"loadBalancerInstanceOperation": {
"code": "NULL",
"codeName": "NET NULL OP"
},
"networkUsageType": {
"code": "PRVT",
"codeName": "Private "
},
"isHttpKeepAlive": false,
"connectionTimeout": 60,
"certificateName": "",
"loadBalancerRuleList": [
{
"protocolType": {
"code": "HTTP",
"codeName": "http"
},
"loadBalancerPort": 88,
"serverPort": 88,
"l7HealthCheckPath": "/l7check.html",
"certificateName": "",
"proxyProtocolUseYn": "N",
"stickySessionUseYn": "N",
"http2UseYn": "N"
}
],
"loadBalancedServerInstanceList": [
""
]
}
]
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<getLoadBalancerInstanceListResponse>
<requestId>d3a5be52-2003-4243-a037-3a1734210140</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstanceNo>428577</loadBalancerInstanceNo>
<virtualIp>10.39.10.76</virtualIp>
<loadBalancerName>cdb</loadBalancerName>
<loadBalancerAlgorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</loadBalancerAlgorithmType>
<loadBalancerDescription></loadBalancerDescription>
<createDate>0133-10-23T21:01:41+0900</createDate>
<domainName></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>PRVT</code>
<codeName>Private </codeName>
</networkUsageType>
<isHttpKeepAlive>false</isHttpKeepAlive>
<connectionTimeout>60</connectionTimeout>
<certificateName></certificateName>
<loadBalancerRuleList>
<protocolType>
<code>HTTP</code>
<codeName>http</codeName>
</protocolType>
<loadBalancerPort>88</loadBalancerPort>
<serverPort>88</serverPort>
<l7HealthCheckPath>/l7check.html</l7HealthCheckPath>
<certificateName></certificateName>
<proxyProtocolUseYn>N</proxyProtocolUseYn>
<stickySessionUseYn>N</stickySessionUseYn>
<http2UseYn>N</http2UseYn>
</loadBalancerRuleList>
<loadBalancedServerInstanceList></loadBalancedServerInstanceList>
</loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>