Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMssqlImageProductList

Prev Next

Available in VPC

Get the list of Cloud DB for MSSQL product codes.

Commands

The command statement is as follows:

ncloud vmssql getCloudMssqlImageProductList [regionCode] [productCode] [exclusionProductCode] [generationCode] [output]

Parameter

The following describes the parameters.

Parameter Type Required Description Restrictions
regionCode String N Region code
  • regionCode can be obtained through the getRegionList action.
  • Default: Select the first Region of the getRegionList query result.
-
productCode String N Cloud DB for MSSQL image product code to query -
exclusionProductCode String N Cloud DB for MSSQL image product code to exclue -
generationCode String N Filter by generation code.
  • G2 | G3
-
output String N Respond result's format type
  • Options: xml | json
  • Default: json
-

Response

Response data type

  • ProductList type

    ProductList extends CommonResponse Description
    private Integer totalRows;
    private List<Product> productList = new ArrayList<>();
  • Product type

    Product Description
    private String productCode;
    private String productName;
    private CommonCode productType;
    private String productDescription;
    private CommonCode infraResourceType;
    private CommonCode infraResourceDetailType;
    private Integer cpuCount;
    private Long memorySize;
    private Long baseBlockStorageSize;
    private CommonCode platformType;
    private String osInformation;
    private CommonCode diskType;
    private String dbKindCode;
    private Long addBlockStorageSize;
    private String generationCode;
    private String engineVersionCode;

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vmssql getCloudMssqlImageProductList --regionCode KR --productCode SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100 --generationCode G2

Response example

The response example is as follows:

When response result format type (output) is JSON

The following is an example when the response result format type (output) is JSON.

{
  "getCloudMssqlImageProductListResponse": {
    "requestId": "c5d74898-60f7-4ac2-a9a8-23485ed70feb",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 3,
    "productList": [
      {
        "productCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.EE.B100",
        "productName": "MSSQL 15.0.2000.5 Enterprise Edition",
        "productType": {
          "code": "WINNT",
          "codeName": "Windows NT"
        },
        "productDescription": "Windows Server 2016 with MSSQL 2019 RTM (15.0.2000.5) Enterprise English Edition",
        "infraResourceType": {
          "code": "SW",
          "codeName": "Software"
        },
        "baseBlockStorageSize": 107374182400,
        "platformType": {
          "code": "WND64",
          "codeName": "Windows 64 Bit"
        },
        "osInformation": "Windows Server 2016 with MSSQL 15.0.2000.5 Enterprise Edition",
        "generationCode": "G2",
        "engineVersionCode": "15.0.2000.5"
      },
      {
        "productCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15041982.SE.B100",
        "productName": "MSSQL 15.0.4198.2 Standard Edition",
        "productType": {
          "code": "WINNT",
          "codeName": "Windows NT"
        },
        "productDescription": "Windows Server 2016 with MSSQL 2019 RTM (15.0.4198.2) Standard English Edition",
        "infraResourceType": {
          "code": "SW",
          "codeName": "Software"
        },
        "baseBlockStorageSize": 107374182400,
        "platformType": {
          "code": "WND64",
          "codeName": "Windows 64 Bit"
        },
        "osInformation": "Windows Server 2016 with MSSQL 15.0.4198.2 Standard Edition",
        "generationCode": "G2",
        "engineVersionCode": "15.0.4198.2"
      },
      {
        "productCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15041982.EE.B100",
        "productName": "MSSQL 15.0.4198.2 Enterprise Edition",
        "productType": {
          "code": "WINNT",
          "codeName": "Windows NT"
        },
        "productDescription": "Windows Server 2016 with MSSQL 2019 RTM (15.0.4198.2) Enterprise English Edition",
        "infraResourceType": {
          "code": "SW",
          "codeName": "Software"
        },
        "baseBlockStorageSize": 107374182400,
        "platformType": {
          "code": "WND64",
          "codeName": "Windows 64 Bit"
        },
        "osInformation": "Windows Server 2016 with MSSQL 15.0.4198.2 Enterprise Edition",
        "generationCode": "G2",
        "engineVersionCode": "15.0.4198.2"
      }
    ]
  }
}

When response result format type (responseFormatType) is XML

The following is an example when the response result format type (responseFormatType) is XML.

<getCloudMssqlImageProductListResponse>
    <requestId>c5d74898-60f7-4ac2-a9a8-23485ed70feb</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <productList>
        <product>
            <productCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.EE.B100</productCode>
            <productName>MSSQL 15.0.2000.5 Enterprise Edition</productName>
            <productType>
                <code>WINNT</code>
                <codeName>Windows NT</codeName>
            </productType>
            <productDescription>Windows Server 2016 with MSSQL 2019 RTM (15.0.2000.5) Enterprise English Edition</productDescription>
            <infraResourceType>
                <code>SW</code>
                <codeName>Software</codeName>
            </infraResourceType>
            <baseBlockStorageSize>107374182400</baseBlockStorageSize>
            <platformType>
                <code>WND64</code>
                <codeName>Windows 64 Bit</codeName>
            </platformType>
            <osInformation>Windows Server 2016 with MSSQL 15.0.2000.5 Enterprise Edition</osInformation>
            <generationCode>G2</generationCode>
            <engineVersionCode>15.0.2000.5</engineVersionCode>
        </product>
        <product>
            <productCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15041982.SE.B100</productCode>
            <productName>MSSQL 15.0.4198.2 Standard Edition</productName>
            <productType>
                <code>WINNT</code>
                <codeName>Windows NT</codeName>
            </productType>
            <productDescription>Windows Server 2016 with MSSQL 2019 RTM (15.0.4198.2) Standard English Edition</productDescription>
            <infraResourceType>
                <code>SW</code>
                <codeName>Software</codeName>
            </infraResourceType>
            <baseBlockStorageSize>107374182400</baseBlockStorageSize>
            <platformType>
                <code>WND64</code>
                <codeName>Windows 64 Bit</codeName>
            </platformType>
            <osInformation>Windows Server 2016 with MSSQL 15.0.4198.2 Standard Edition</osInformation>
            <generationCode>G2</generationCode>
            <engineVersionCode>15.0.4198.2</engineVersionCode>
        </product>
        <product>
            <productCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15041982.EE.B100</productCode>
            <productName>MSSQL 15.0.4198.2 Enterprise Edition</productName>
            <productType>
                <code>WINNT</code>
                <codeName>Windows NT</codeName>
            </productType>
            <productDescription>Windows Server 2016 with MSSQL 2019 RTM (15.0.4198.2) Enterprise English Edition</productDescription>
            <infraResourceType>
                <code>SW</code>
                <codeName>Software</codeName>
            </infraResourceType>
            <baseBlockStorageSize>107374182400</baseBlockStorageSize>
            <platformType>
                <code>WND64</code>
                <codeName>Windows 64 Bit</codeName>
            </platformType>
            <osInformation>Windows Server 2016 with MSSQL 15.0.4198.2 Enterprise Edition</osInformation>
            <generationCode>G2</generationCode>
            <engineVersionCode>15.0.4198.2</engineVersionCode>
        </product>
    </productList>
</getCloudMssqlImageProductListResponse>