GetMetaLb
    • PDF

    GetMetaLb

    • PDF

    記事の要約

    VPC環境で利用できます。

    Network Traffic Monitoringサービスで使用可能な Load Balancer情報を照会します。

    リクエスト

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

    メソッドURI
    GET/meta/v1/lb

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    pageIntegerRequiredページ番号
    • 0~N
    sizeIntegerRequiredページ表示数
    • 1~100
    ipStringOptionalLoad Balancer IP
    regionCodeStringOptionalリージョンコード
    • KR (デフォルト)

    リクエスト例

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

    curl --location --request GET 'https://vpc-ntm.apigw.ntruss.com/meta/v1/lb?page=0&size=2' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'x-ncp-dmn_cd: PUB' \
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    lbListArray-Load Balancerリスト
    totalInteger-レスポンス結果数

    lbList

    lbListの説明は次の通りです。

    フィールドタイプ必須の有無説明
    networkTrafficMonitoringInstanceNoInteger-Network Traffic Monitoringインスタンス番号
    subscribedBoolean-Network Traffic Monitoringは利用中かどうか
    • true | false
      • true: 利用中
      • false: 利用中ではない
    参考

    Load Balancer情報関連フィールドの詳細は、LoadBalancerInstanceをご参照ください。

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

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

    レスポンス例

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

    {
      "lbList": [
        {
          "instanceNo": 1803849,
          "loadBalancerName": "test-lb",
          "regionNo": 1,
          "regionCode": "KR",
          "regionName": "Korea",
          "instanceStatusCode": "USED",
          "instanceStatusName": "Running",
          "loadBalancerIpList": [
            "***.***.***.***"
          ],
          "ipTypeCode": "PUBLIC",
          "networkTrafficMonitoringInstanceNo": null,
          "subscribed": false
        }
      ],
      "total": 2
    }
    

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

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.