getServerImageProductList

Prev Next

VPC環境で利用できます。

NAVERクラウドプラットフォームが提供するサーバイメージ商品リストを照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
blockStorageSize Integer Optional ブロックストレージ容量(GB)
  • 50 | 100
  • サーバイメージの基本ブロックストレージ容量で絞り込み
exclusionProductCode String Optional 除外する商品コード
productCode String Optional 照会対象の商品コード
platformTypeCodeList.N Array Optional プラットフォームタイプコードリスト
  • LNX32 | LNX64 | WND32 | WND64 | UBD64 | UBS64
  • プラットフォームタイプで絞り込み
  • <例> platformTypeCodeList.1=LNX32&platformTypeCodeList.2=LNX64
infraResourceDetailTypeCode String Optional インフラリソースの詳細タイプコード
  • BM: ベアメタルサーバ
    • BMを除いたタイプ (デフォルト)
  • 特定のタイプのイメージを照会
  • 現在、ベアメタルサーバのみ照会可能
  • <例> infraResourceDetailTypeCode=BM
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerImageProductList
?regionCode=KR
&blockStorageSize=50
&exclusionProductCode=SW.VSVR.OS.LNX64.ROCKY.0808.B050
&productCode=SW.VSVR.OS.LNX64.ROCKY.0810.B050
&platformTypeCodeList.1=LNX64
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getServerImageProductListResponse": {
    "totalRows": 1,
    "productList": [
      {
        "productCode": "SW.VSVR.OS.LNX64.ROCKY.0810.B050",
        "productName": "Rocky Linux 8.10",
        "productType": {
          "code": "LINUX",
          "codeName": "Linux"
        },
        "productDescription": "Rocky Linux 8.10",
        "infraResourceType": {
          "code": "SW",
          "codeName": "Software"
        },
        "cpuCount": 0,
        "memorySize": 0,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "osInformation": "Rocky Linux 8.10",
        "dbKindCode": "",
        "addBlockStorageSize": 0,
        "generationCode": "G2"
      }
    ],
    "requestId": "bcb42041-****-****-****-829b41c4dca4",
    "returnCode": "0",
    "returnMessage": "success"
  }
}