getCloudDBImageProductList
- 印刷する
- PDF
getCloudDBImageProductList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
使用できる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 | 除外する商品コード |
productCode | N | string | Min : 1, Max : 20 | 照会する商品コード |
dbKindCode | Y | string | MYSQL , MSSQL , REDIS | DBタイプコード |
regionNo | N | string | リージョン番号 | |
responseFormatType | N | String | responseの結果format設定 |
- exclusionProductCode
- 照会結果から除外しようとする商品コードを入力します。
- productCode
- 照会する商品のコードを入力します。
- dbKindCode
- 照会するCloudDBの種類選択、MSSQL・MySQL・Redisの中で入力します。
- regionNo
- リージョン番号を入力します。
- responseFormatType
- APIの実行結果をレスポンスするformatを決めます。xmlとjsonの中で選択できます。
レスポンス
フィールド名 | タイプ | 説明 | 備考 |
---|---|---|---|
requestId | String | リクエストID値 | |
returnMessage | String | レスポンスメッセージ | |
totalRows | Integer | レスポンス結果rowの数 | |
productList[] | String | 商品リスト情報 |
例示
リクエスト例示
curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBImageProductList?dbKindCode=MSSQL®ionNo=1&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: 1545976216257"
-H "x-ncp-apigw-signature-v2: IM4D9Iepn7kp91QXSGKVdYizh0Uoxd1tVGyZDMqXfWs="
https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBImageProductList?dbKindCode=MSSQL®ionNo=1&responseFormatType=json
リクエストサンプル
- Cloud DB for MSSQLで使用できるイメージリスト照会
{
"dbKindCode": "MSSQL",
"regionNo": "1",
"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
{
"getCloudDBImageProductListResponse": {
"requestId": "a7d58040-5ee9-4895-8921-10383d2a4a99",
"returnCode": "0",
"returnMessage": "success",
"productList": [
{
"productCode": "SPSWMSSQLWINNT01",
"productName": "Windows Server 2012r2 with MSSQL 2016 standard edition",
"productType": {
"code": "WINNT",
"codeName": "Windows NT"
},
"productDescription": "Windows Server 2012r2 with MSSQL 2016 standard edition",
"infraResourceType": {
"code": "SW",
"codeName": "Software"
},
"cpuCount": 0,
"memorySize": 0,
"baseBlockStorageSize": 53687091200,
"platformType": {
"code": "WND64",
"codeName": "Windows 64 Bit"
},
"osInformation": "Windows Server 2012r2 with MSSQL 2016 standard edition",
"dbKindCode": "MSSQL",
"addBlockStorageSize": 0
}
],
"totalRows": 1
}
}
エラーコード
Cloud DB APIのリクエストが間違っているか、処理中にエラーが発生する場合、HTTPステータスコードで成功/失敗を返却し、JSONの形式で詳細メッセージを返却します。
エラーコードはCloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の二つです。
エラーコード | レスポンスメッセージ | 説明 |
---|---|---|
200 | Ok | |
500 | Server Error |
この記事は役に立ちましたか?