OSタイプの照会

Prev Next

VPC環境で利用できます。

使用可能な OSタイプを照会します。

リクエスト

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

メソッド URI
GET /api/v2/cluster/getOsProductList (韓国リージョン)
GET /api/sgn-v2/cluster/getOsProductList (シンガポールリージョン)
GET /api/jpn-v2/cluster/getOsProductList (日本リージョン)

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getOsProductList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

result.productList

result.productListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
productCode String - OSタイプコード
productName String - OSのバージョン名
productType2Code String - OS区分
productEnglishDesc String - OSバージョンの説明
infraResourceTypeCode String - インフラリソースタイプ
softwareTypeCode String - ソフトウェアタイプ

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "productList": [
            {
                "productCode": "SW.VELST.OS.LNX64.CNTOS.0708.B050",
                "productName": "centos-7.8-64",
                "productType2Code": "LINUX",
                "productEnglishDesc": "CentOS 7.8 (64-bit)",
                "infraResourceTypeCode": "SW",
                "softwareTypeCode": "VELST"
            },
            {
                "productCode": "SW.VELST.OS.LNX64.ROCKY.0808.B050",
                "productName": "Rocky Linux 8.8",
                "productType2Code": "LINUX",
                "productEnglishDesc": "Rocky Linux 8.8",
                "infraResourceTypeCode": "SW",
                "softwareTypeCode": "VELST"
            }
        ]
    },
    "requestId": "117f624e-****-****-****-37637bae7cea"
}