getMemberServerImageInstanceList

Prev Next

VPC環境で利用できます。

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

参考

KVMベースのサーバイメージはサポートしません。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/getMemberServerImageInstanceList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
memberServerImageInstanceNoList.N Array Optional サーバイメージインスタンス番号リスト
  • getMemberServerImageInstanceListを参照
  • サーバイメージインスタンス番号で絞り込み
  • <例> memberServerImageInstanceNoList.1=1234&memberServerImageInstanceNoList.2=2345
memberServerImageName String Optional サーバイメージ名で絞り込み
memberServerImageInstanceStatusCode String Optional サーバイメージの状態コードで絞り込み
  • INIT | CREAT
platformTypeCodeList.N Array Optional プラットフォームタイプコードリスト
  • プラットフォームタイプコードで絞り込み
  • LNX32 | LNX64 | WND32 | WND64 | UBD64 | UBS64
  • <例> platformTypeCodeList.1=LNX32&platformTypeCodeList.2=LNX64
pageNo Integer Optional ページ番号
  • 0~N (デフォルト: 0)
  • 最初のページ: 0または1を入力
pageSize Integer Conditional ページごとの項目数
  • 1~1000 (デフォルト: 1)
  • pageNo入力時、必ず入力
sortedBy String Optional ソート基準
  • memberServerImageName: 会員サーバイメージ名 (有効値)
sortingOrder String Optional ソート順序
  • ASC (デフォルト) | DESC
    • ASC: 昇順
    • DESC: 降順
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getMemberServerImageInstanceList
?regionCode=KR
&memberServerImageInstanceNoList.1=*****2264
&memberServerImageName=test-***
&memberServerImageInstanceStatusCode=CREAT
&platformTypeCodeList.1=UBD64
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getMemberServerImageInstanceListResponse": {
        "totalRows": 1,
        "memberServerImageInstanceList": [
            {
                "memberServerImageInstanceNo": "*****2264",
                "memberServerImageName": "test-***",
                "originalServerInstanceNo": "*****2010",
                "originalServerImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050",
                "memberServerImageInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "NSI CREATED state"
                },
                "memberServerImageInstanceOperation": {
                    "code": "NULL",
                    "codeName": "NSI NULL OP"
                },
                "memberServerImageInstanceStatusName": "created",
                "createDate": "2025-06-26T11:09:07+0900",
                "memberServerImageBlockStorageTotalRows": 1,
                "memberServerImageBlockStorageTotalSize": 53687091200,
                "shareStatus": {
                    "code": "NULL",
                    "codeName": "NSI Share NULL State"
                },
                "sharedLoginIdList": []
            }
        ],
        "requestId": "19ca615c-faa2-4e05-9bd1-c4ecf8f2c7b2",
        "returnCode": "0",
        "returnMessage": "success"
    }
}