getLaunchConfigurationList

Prev Next

VPC環境で利用できます。

Launch Configurationリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vautoscaling/v2/getLaunchConfigurationList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
launchConfigurationNoList.N Array Optional Launch Configuration番号リスト
  • Launch Configuration番号で絞り込み
  • <例> launchConfigurationNoList.1=1234&launchConfigurationNoList.2=2345
launchConfigurationNameList.N Array Optional Launch Configuration名リスト
  • Launch Configuration名で絞り込み
  • <例> launchConfigurationNameList.1=test1&launchConfigurationNameList.2=test2
pageNo Integer Optional ページ番号
  • 1~N
pageSize Integer Conditional ページごとの項目数
  • 1~N
  • pageNo入力時、必ず入力
sortList.N.sortedBy String Optional ソート対象
  • launchConfigurationName: Launch Configuration名 (有効値)
  • <例> sortList.1.sortedBy=launchConfigurationName
sortList.N.sortingOrder String Optional ソート順序
  • ASC (デフォルト) | DESC
    • ASC: 昇順
    • DESC: 降順
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/getLaunchConfigurationList
?regionCode=KR
&sortList.1.sortedBy=launchConfigurationName
&sortList.1.sortingOrder=ASC
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
getLaunchConfigurationListResponse Object - レスポンス結果
getLaunchConfigurationListResponse.requestId String - リクエスト ID
  • UUID形式
getLaunchConfigurationListResponse.returnCode String - レスポンスコード
getLaunchConfigurationListResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "getLaunchConfigurationListResponse": {
        "totalRows": 2,
        "launchConfigurationList": [
            {
                "regionCode": "KR",
                "launchConfigurationNo": "5891",
                "launchConfigurationName": "launchconfig",
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2204.B050",
                "serverProductCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002",
                "loginKeyName": "ncp-loginkey",
                "createDate": "2025-05-15T09:48:51+0900",
                "launchConfigurationStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "initScriptNo": "",
                "isEncryptedVolume": false,
                "serverImageNo": "3182409",
                "osInformation": "ubuntu-22.04",
                "serverSpecNo": "621",
                "serverSpecCode": "s2-g2-s50",
                "serverSpecDescription": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB"
            },
            {
                "regionCode": "KR",
                "launchConfigurationNo": "5995",
                "launchConfigurationName": "launchconfigtest",
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "serverProductCode": "SVR.VSVR.CPU.C002.M004.G003",
                "loginKeyName": "ncp-loginkey",
                "createDate": "2025-06-12T14:52:56+0900",
                "launchConfigurationStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "initScriptNo": "",
                "isEncryptedVolume": false,
                "serverImageNo": "100614134",
                "osInformation": "ubuntu-24.04",
                "serverSpecNo": "1916",
                "serverSpecCode": "ci2-g3",
                "serverSpecDescription": "vCPU 2EA, Memory 4GB"
            }
        ],
        "requestId": "5eff1b17-****-****-****-f3ee2492d679",
        "returnCode": "0",
        "returnMessage": "success"
    }
}