VPC環境で利用できます。
サーバスペックの詳細情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | POST | /vserver/v2/getServerSpecDetail |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode |
String | Optional | リージョンコード
|
serverSpecCode |
String | Required | サーバスペックコード |
responseFormatType |
String | Optional | レスポンスデータの形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerSpecDetail
?regionCode=KR
&serverSpecCode=c2-g3
&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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
getServerSpecDetailResponse |
Object | - | レスポンス結果 |
getServerSpecDetailResponse.requestId |
String | - | リクエスト ID
|
getServerSpecDetailResponse.returnCode |
String | - | レスポンスコード |
getServerSpecDetailResponse.returnMessage |
String | - | レスポンスメッセージ |
レスポンスステータスコード
Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"getServerSpecDetailResponse": {
"totalRows": 1,
"serverSpecList": [
{
"serverSpecNo": 821,
"serverSpecCode": "c2-g3",
"hypervisorType": {
"code": "KVM",
"codeName": "KVM"
},
"generationCode": "G3",
"cpuArchitectureType": {
"code": "X86_64",
"codeName": "x86 64bit"
},
"cpuCount": 2,
"memorySize": 4294967296,
"blockStorageMaxCount": 20,
"blockStorageMaxIops": 5250,
"blockStorageMaxThroughput": 81,
"networkPerformance": 1000000000,
"networkInterfaceMaxCount": 3,
"serverSpecDescription": "vCPU 2EA, Memory 4GB",
"serverProductCode": "SVR.VSVR.HICPU.C002.M004.G003"
}
],
"requestId": "aaf1d334-****-****-****-53b352ba878e",
"returnCode": "0",
"returnMessage": "success"
}
}