Classic環境で利用できます。
ロードバランサインスタンスを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /loadbalancer/v2/createLoadBalancerInstance |
リクエストヘッダ
Load Balancer APIで共通して使用されるヘッダの詳細は、Load Balancerのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
loadBalancerName |
String | Optional | 作成するロードバランサの名前
|
loadBalancerAlgorithmTypeCode |
String | Optional | ロードバランシングに使用するアルゴリズムタイプ
|
loadBalancerDescription |
String | Optional | ロードバランサの説明(Byte)
|
networkUsageTypeCode |
String | Optional | ロードバランサのネットワークタイプ
|
serverInstanceNoList.N |
String | Optional | ロードバランサにバインドするサーバインスタンスの番号リスト |
loadBalancerRuleList.N.protocolTypeCode |
String | Required | ロードバランサルールのプロトコルタイプ
|
loadBalancerRuleList.N.loadBalancerPort |
Integer | Required | ロードバランサルールのポート
|
loadBalancerRuleList.N.serverPort |
Integer | Required | ロードバランサルールのサーバポート
|
loadBalancerRuleList.N.l7HealthCheckPath |
String | Conditional | ロードバランサルールのヘルスチェックパス
|
loadBalancerRuleList.N.certificateName |
String | Conditional | ロードバランサの SSL証明書名loadBalancerRuleList.N.protocloTypeCodeがSSLまたはHTTPSの場合、必ず入力 |
loadBalancerRuleList.N.proxyProtocolUseYn |
String | Optional | プロキシプロトコルの使用有無
|
loadBalancerRuleList.N.stickySessionUseYn |
String | Optional | セッション別アクセスの使用有無
|
loadBalancerRuleList.N.http2UseYn |
String | Optional | HTTP/2プロトコルの使用有無
|
loadBalancerRuleList.N.serverProtocolTypeCode |
String | Optional | サーバのプロトコルタイプ
|
regionNo |
String | Optional | ロードバランサ作成対象のリージョン番号 |
zoneNoList |
List[String] | Optional | ロードバランサ作成対象のゾーン番号リスト
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location 'https://ncloud.apigw.ntruss.com/loadbalancer/v2/createLoadBalancerInstance?loadBalancerRuleList.1.l7HealthCheckPath=/&loadBalancerRuleList.1.loadBalancerPort=80&loadBalancerRuleList.1.protocolTypeCode=HTTP&loadBalancerRuleList.1.serverPort=80' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、LoadBalancerInstanceをご参照ください。
レスポンスステータスコード
Load Balancer APIで共通して使用されるレスポンスステータスコードの詳細は、Load Balancerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
<createLoadBalancerInstanceResponse>
<requestId>1e3eac26-c57e-4c8b-b6b0-ba3fe2330a61</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>********</loadBalancerInstanceNo>
<virtualIp>***.***.***.***,**.***.***.***</virtualIp>
<loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
<loadBalancerAlgorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</loadBalancerAlgorithmType>
<loadBalancerDescription></loadBalancerDescription>
<createDate>2024-06-07T19:28:24+0900</createDate>
<domainName>slb-24784632.ncloudslb.com</domainName>
<loadBalancerInstanceStatusName>creating</loadBalancerInstanceStatusName>
<loadBalancerInstanceStatus>
<code>INIT</code>
<codeName>NET INIT state</codeName>
</loadBalancerInstanceStatus>
<loadBalancerInstanceOperation>
<code>USE</code>
<codeName>NET USE OP</codeName>
</loadBalancerInstanceOperation>
<networkUsageType>
<code>PBLIP</code>
<codeName>Public</codeName>
</networkUsageType>
<isHttpKeepAlive>false</isHttpKeepAlive>
<connectionTimeout>60</connectionTimeout>
<certificateName></certificateName>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<zoneList>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>加山 zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</zoneList>
<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>
</createLoadBalancerInstanceResponse>