OSタイプの照会(G3)

Prev Next

VPC環境で利用できます。

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

参考

KVMハイパーバイザタイプの第3世代サーバ専用の APIです。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
generationCode String Optional サーバの世代コード
  • G3: 第3世代 (有効値)

リクエスト例

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

curl --location --request GET 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterServerImageList' \
--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.serverImageList Array - OSタイプリスト
requestId String - リクエスト ID
  • UUID形式

serverImageList

serverImageListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serverImageNo Integer - OSの登録番号
softwareProductCode String - OSタイプコード
serverName String - OSのバージョン名
参考

orderはレスポンス結果に表示される場合がありますが、ユーザーが参照すべきフィールドではありません。

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "serverImageList": [
            {
                "serverImageNo": 3188144,
                "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.07.G003",
                "order": 2,
                "serverName": "centos-7.8-cdss"
            },
            {
                "serverImageNo": 100059417,
                "softwareProductCode": "SW.VCDSS.OS.LNX64.ROCKY.08.G003",
                "order": 3,
                "serverName": "Rocky Linux 8"
            }
        ]
    },
    "requestId": "c580da21-****-****-****-f2a2cd556ce5"
}