getServerImageList

VPC環境で利用できます。

サーバイメージリストを照会します。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/getServerImageList

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`serverImageNoList.N`	Array	Optional	サーバイメージ番号リストサーバイメージ番号で絞り込み getServerImageListを参照 <例> `serverImageNoList.1=1234&serverImageNoList.2=2345`
`serverImageName`	String	Optional	サーバイメージ名で絞り込み
`serverImageStatusCode`	String	Optional	サーバイメージの状態コードで絞り込み `INIT` \| `CREAT`
`serverImageTypeCodeList.N`	Array	Optional	サーバイメージタイプコードリスト `SELF` \| `NCP` サーバイメージタイプコードで絞り込み <例> `serverImageTypeCodeList.1=NCP`
`hypervisorTypeCodeList.N`	Array	Optional	ハイパーバイザタイプコードリスト `XEN` \| `KVM` ハイパーバイザタイプコードで絞り込み <例> `hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM`
`osTypeCodeList.N`	Array	Optional	OSタイプコードリスト `CENTOS` \| `UBUNTU` \| `WINDOWS` OSタイプコードで絞り込み <例> `osTypeCodeList.1=CENTOS&osTypeCodeList.2=UBUNTU`
`platformCategoryCodeList.N`	Array	Optional	プラットフォームカテゴリコードリスト `OS` \| `APP` \| `DBMS` \| `GPU` プラットフォームカテゴリコードで絞り込み <例> `platformCategoryCodeList.1=OS&platformCategoryCodeList.2=GPU`
`pageNo`	Integer	Optional	ページ番号 0~N (デフォルト: 0) 最初のページ: `0`または`1`を入力
`pageSize`	Integer	Conditional	ページごとの項目数 1~1000 (デフォルト: 1) `pageNo`入力時、必ず入力
`sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerImageList
?regionCode=KR
&serverImageNoList.1=*****3135
&serverImageName=test-***
&serverImageStatusCode=CREAT
&osTypeCodeList.1=UBUNTU
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getServerImageListResponse": {
        "totalRows": 1,
        "serverImageList": [
            {
                "serverImageNo": "*****3135",
                "serverImageName": "test-***",
                "serverImageType": {
                    "code": "SELF",
                    "codeName": "SELFサーバイメージ"
                },
                "serverImageLifeCyclePhase": {
                    "code": "IN_SERVICE",
                    "codeName": "In Service"
                },
                "hypervisorType": {
                    "code": "KVM",
                    "codeName": "KVM"
                },
                "cpuArchitectureType": {
                    "code": "X86_64",
                    "codeName": "x86 64bit"
                },
                "osCategoryType": {
                    "code": "LINUX",
                    "codeName": "LINUX"
                },
                "osType": {
                    "code": "UBUNTU",
                    "codeName": "UBUNTU"
                },
                "serverImageStatus": {
                    "code": "CREAT",
                    "codeName": "NSI CREATED state"
                },
                "serverImageOperation": {
                    "code": "NULL",
                    "codeName": "NSI NULL OP"
                },
                "serverImageStatusName": "created",
                "shareStatus": {
                    "code": "NULL",
                    "codeName": "NSI Share NULL State"
                },
                "blockStorageMappingList": [
                    {
                        "order": 0,
                        "blockStorageSnapshotInstanceNo": 106384697,
                        "blockStorageSnapshotName": "test-***",
                        "blockStorageSize": 10737418240,
                        "blockStorageVolumeType": {
                            "code": "CB1",
                            "codeName": "Common BlockStorage 1"
                        },
                        "iops": 100,
                        "throughput": 104857600,
                        "isEncryptedVolume": false
                    }
                ],
                "sharedLoginIdList": [],
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "createDate": "2025-06-20T09:59:39+0900",
                "platformCategoryCode": "OS"
            }
        ],
        "requestId": "3530f136-21b0-4588-8ed8-1dab9012b4ac",
        "returnCode": "0",
        "returnMessage": "success"
    }
}