ロードバランサリストの照会

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタのブローカーノードの Public Endpointで連携可能なロードバランサリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/cluster/getLoadBalancerInstanceList/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v1/cluster/getLoadBalancerInstanceList/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v1/cluster/getLoadBalancerInstanceList/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

Cloud Data Streaming Service APIで共通して使用されるヘッダの詳細は、Cloud Data Streaming Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getLoadBalancerInstanceList/1009*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.loadBalancerInstanceList Array - ロードバランサリスト
requestId String - リクエスト ID
  • UUID形式

result.loadBalancerInstanceList

result.loadBalancerInstanceListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
loadBalancerIp String - ロードバランサ IPアドレス
loadBalancerName String - ロードバランサの名前
loadBalancerDomain String - ロードバランサのアクセス情報
instanceNo Integer - ロードバランサインスタンス番号
permission String - ロードバランサの使用可否

レスポンスステータスコード

Cloud Data Streaming Service APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Data Streaming Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "loadBalancerInstanceList": [
            {
                "loadBalancerIp": "101.***.***.***",
                "loadBalancerName": "lblblb",
                "loadBalancerDomain": "lblblb-*********-****************.naverncp.com",
                "instanceNo": 1009*****,
                "permission": "allow"
            }
        ]
    },
    "requestId": "9d1329a1-****-****-****-15fdc05dbcda"
}