概要
使用できる CloudDB商品リストを照会します。
リクエスト
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなすx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | APIGWから発行されたキー値、v2を使用する場合、api-keyは使用しないx-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | NAVERクラウドプラットフォームポータルで発行された Access Key ID値x-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Access Key ID値と Secret Keyで暗号化した署名x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Request body content typeを application/jsonに指定Content-Type: application/json |
リクエストボディ
APIリクエスト時にフィールド名の大文字・小文字の区別が必要です
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| exclusionProductCode | N | string | Min : 1, Max : 20 | 除外する商品コード |
| cloudDBImageProductCode | Y | string | 照会するイメージ商品コード | |
| productCode | N | string | 照会する商品コード | |
| regionNo | N | string | リージョン番号 | |
| zoneNo | N | string | ゾーン番号 | |
| responseFormatType | N | String | responseの結果 format設定 |
- exclusionProductCode
- 照会結果から除外しようとする商品コードを入力します。
- cloudDBImageProductCode
- 照会しようとする商品のイメージコードを入力します。
- getCloudDBImageProductListを通じて取得できます。
- productCode
- 照会しようとする商品コードを入力します。
- regionNo
- リージョン番号を入力します。
- zoneNo
- Zone番号を入力します。
- responseFormatType
- API実行結果のレスポンスを受ける formatを決めます。 xmlと jsonの中から選択できます。
レスポンス
| フィールド名 | タイプ | 説明 | 備考 |
|---|---|---|---|
| requestId | String | リクエスト ID値 | |
| returnCode | Integer | レスポンスコード値 | |
| returnMessage | String | レスポンスメッセージ | |
| productList[] | String | 商品リスト情報 |
例
リクエスト例
curl
-X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBProductList?cloudDBImageProductCode=SPSWMYSQLLINUX01&responseFormatType=json"
-H "accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-H "x-ncp-apigw-api-key: 25bpuog9sz"
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
-H "x-ncp-apigw-timestamp: 1545982751940"
-H "x-ncp-apigw-signature-v2: z2nVurpvxfctfQ9csfzgo2qKD2+iOsJhUTdniuaJVCI="
https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBProductList?cloudDBImageProductCode=SPSWMYSQLLINUX01&responseFormatType=json
リクエストサンプル
- Cloud DB for MySQL商品リスト照会
{
"cloudDBImageProductCode": "SPSWMYSQLLINUX01",
"responseFormatType": "json"
}
レスポンス例
connection: keep-alive
content-type: application/json;charset=UTF-8
date: Mon, 24 Dec 2018 08:59:40 GMT
server: nginx
transfer-encoding: chunked
x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2
{
"getCloudDBProductListResponse": {
"requestId": "e8531972-c127-4ec0-aa32-86e6ad98a82c",
"returnCode": "0",
"returnMessage": "success",
"productList": [
{
"productCode": "SPSVRDBAAS000001",
"productName": "vCPU 2EA, Memory 4GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 2EA, Memory 4GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 2,
"memorySize": 4294967296,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000005",
"productName": "vCPU 2EA, Memory 8GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 2EA, Memory 8GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 2,
"memorySize": 8589934592,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000002",
"productName": "vCPU 4EA, Memory 8GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 4EA, Memory 8GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 4,
"memorySize": 8589934592,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000006",
"productName": "vCPU 4EA, Memory 16GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 4EA, Memory 16GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 4,
"memorySize": 17179869184,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000003",
"productName": "vCPU 8EA, Memory 16GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 8EA, Memory 16GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 8,
"memorySize": 17179869184,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000007",
"productName": "vCPU 8EA, Memory 32GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 8EA, Memory 32GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 8,
"memorySize": 34359738368,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000004",
"productName": "vCPU 16EA, Memory 32GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "vCPU 16EA, Memory 32GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 16,
"memorySize": 34359738368,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000020",
"productName": "vCPU 8EA, Memory 64GB",
"productType": {
"code": "HIMEM",
"codeName": "High Memory"
},
"productDescription": "vCPU 8EA, Memory 64GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 8,
"memorySize": 68719476736,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000021",
"productName": "vCPU 16EA, Memory 64GB",
"productType": {
"code": "HIMEM",
"codeName": "High Memory"
},
"productDescription": "vCPU 16EA, Memory 64GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 16,
"memorySize": 68719476736,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000022",
"productName": "vCPU 16EA, Memory 128GB",
"productType": {
"code": "HIMEM",
"codeName": "High Memory"
},
"productDescription": "vCPU 16EA, Memory 128GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 16,
"memorySize": 137438953472,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000023",
"productName": "vCPU 32EA, Memory 128GB",
"productType": {
"code": "HIMEM",
"codeName": "High Memory"
},
"productDescription": "vCPU 32EA, Memory 128GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 32,
"memorySize": 137438953472,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
},
{
"productCode": "SPSVRDBAAS000024",
"productName": "vCPU 32EA, Memory 256GB",
"productType": {
"code": "HIMEM",
"codeName": "High Memory"
},
"productDescription": "vCPU 32EA, Memory 256GB",
"infraResourceType": {
"code": "DBAAS",
"codeName": "Cloud DB"
},
"cpuCount": 32,
"memorySize": 274877906944,
"baseBlockStorageSize": 53687091200,
"osInformation": "",
"diskType": {
"code": "NET",
"codeName": "Network Storage"
},
"dbKindCode": "",
"addBlockStorageSize": 0
}
],
"totalRows": 12
}
}
エラーコード
Cloud DB APIリクエストに誤りがあるか、処理中にエラーが発生した場合、HTTPステータスコードで成功/失敗を、JSON形式で詳細メッセージを返します
エラーコードには、Cloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の2種類があります
| エラーコード | レスポンスメッセージ | 説明 |
|---|---|---|
| 200 | Ok | |
| 500 | Server Error |