getServerImageDetail

Prev Next

Available in VPC

Get server image details.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vserver/v2/getServerImageDetail
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Server APIs, see Server request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
serverImageNo String Required Server image number
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerImageDetail
?regionCode=KR
&serverImageNo=***3135
&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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
getServerImageDetailResponse Object - Response result
getServerImageDetailResponse.requestId String - ID for the request
  • UUID format
getServerImageDetailResponse.returnCode String - Response code
getServerImageDetailResponse.returnMessage String - Response message

Response status codes

For information about the response status codes common to all Server APIs, see Server response status codes.

Response example

The response example is as follows:

{
    "getServerImageDetailResponse": {
        "totalRows": 1,
        "serverImageList": [
            {
                "serverImageNo": "*****3135",
                "serverImageName": "test-***",
                "serverImageType": {
                    "code": "SELF",
                    "codeName": "SELF server image"
                },
                "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": *****4697,
                        "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": "9a30e5b1-859b-4ea9-8c96-a7458a9a9357",
        "returnCode": "0",
        "returnMessage": "success"
    }
}