getNasVolumeInstanceRatingList

Prev Next

Classic環境で利用できます。

特定の期間の NASボリュームインスタンスのサイズを、設定した測定間隔で照会します。

リクエスト

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

メソッド URI
GET, POST /getNasVolumeInstanceRatingList

リクエストヘッダ

NAS APIで共通して使用されるヘッダの詳細は、NASの共通ヘッダをご参照ください。

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

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
nasVolumeInstanceNo String Required ボリュームサイズの測定リストを照会する NASボリュームインスタンス番号
startTime String Required 測定開始日時
  • yyyy-MM-dd'T'HH:mm:ssZ形式
    • <例> 2024-04-01'T'00:00:00+0900
  • GET方式利用時、URLエンコードが必要
endTime String Required 測定終了日時
  • yyyy-MM-dd'T'HH:mm:ssZ形式
    • <例> 2024-04-01'T'23:59:59+0900
  • GET方式利用時、URLエンコードが必要
interval String Required 測定間隔
  • 5m | 6h | 1d | 1M
    • 5m: 5分
    • 6h: 6時間
    • 1d: 1日
    • 1M: 1か月
  • 測定間隔に応じて最大照会期間(startTime~endTime)が制限
    • 5m: 最大3日
    • 6h: 最大1か月
    • 1d: 最大2年
    • 1M: 最大5年

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/server/v2/getNasVolumeInstanceRatingList?nasVolumeInstanceNo=23420000&startTime=2024-04-07T00%3A00%3A00%2B0000&endTime=2024-04-08T00%3A00%3A00%2B0000&interval=1d' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、NasVolumeInstanceRatingをご参照ください。

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

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "getNasVolumeInstanceRatingListResponse": {
        "totalRows": 1,
        "nasVolumeInstanceRatingList": [
            {
                "ratingTime": "20240407",
                "averageVolumeSize": 536870912000,
                "averageVolumeUseSize": 380928,
                "averageVolumeUseRatio": 0.0,
                "maxVolumeUseSize": 380928,
                "maxVolumeUseRatio": 0.0,
                "minVolumeUseSize": 380928,
                "minVolumeUseRatio": 0.0,
                "snapshotAverageVolumeSize": 0,
                "snapshotAverageVolumeUseSize": 0,
                "snapshotMaxVolumeUseSize": 0,
                "snapshotMaxVolumeUseRatio": 0.0,
                "snapshotMinVolumeUseSize": 0,
                "snapshotMinVolumeUseRatio": 0.0
            }
        ],
        "requestId": "0000bdf-ceaa-4f9f-b6a6-da1352110000",
        "returnCode": "0",
        "returnMessage": "success"
    }
}