Target Groupリストの照会

Prev Next

VPC環境で利用できます。

使用可能な Auto Scalingグループに接続されたロードバランサ Target Groupリストを照会します。

参考

Target Groupリストを照会するには、Load Balancerサービスで作成した Target Groupが Auto Scalingグループに接続されている必要があります。Auto Scalingグループの作成時、ヘルスチェックの基準で Load Balancerを選択し、Target Groupを指定すると接続されます。リソースの作成と接続方法の詳細は、次をご参照ください。

リクエスト

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

メソッド URI
GET /api/v1/autoscaling/{autoScalingName}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
autoScalingName String Required Auto Scalingグループ名

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.targetGroupList Array - Target Groupリスト

targetGroupList

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

フィールド タイプ 必須の有無 説明
id Number - ロードバランサ Target Group番号
name String - ロードバランサ Target Group名
permission String - 詳細情報の照会権限を持っているか
  • Allow | Deny
    • Allow: 持っている
    • Deny: 持っていない
actionName String - 詳細情報照会権限名

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

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

レスポンス例

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

{
    "result": {
        "targetGroupList": [
            {
                "id": 41****,
                "name": "target-001",
                "permission": "Allow",
                "actionName": "View/getLoadBalancerDetail"
            }
        ]
    }
}