changeNasVolumeSnapshotConfiguration

Prev Next

Classic環境で利用できます。

NASボリュームインスタンスのスナップショット設定を変更できます。

リクエスト

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

メソッド URI
GET, POST /changeNasVolumeSnapshotConfiguration

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
nasVolumeInstanceNo String Required NASボリュームインスタンスの固有番号
snapshotVolumeConfigurationRatio Integer Required ボリューム内スナップショット割り当ての割合の設定(%)
  • 0~99
  • スナップショットの容量が設定した割合の容量を超える場合、過去のスナップショットから削除
  • 0に設定するとスナップショット設定を解除
snapshotVolumeConfigDayOfWeekTypeCode String Optional スナップショット自動作成の有効化と周期の設定
  • -1 (毎日) | 0 (日曜日) | 1 (月曜日) | 2 (火曜日) | 3 (水曜日) | 4 (木曜日) | 5 (金曜日) | 6 (土曜日)
    • スナップショット割り当ての割合が0の場合、無効
    • スナップショット容量の限度内で設定した曜日ごとに自動作成
    		•
    snapshotVolumeConfigTime Integer Conditional スナップショット自動作成の実行時間(時)
    • 0~23
    • スナップショット自動作成を有効化した場合、設定が必要

    リクエスト例

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

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/server/v2/changeNasVolumeSnapshotConfiguration?nasVolumeInstanceNo=00000000&snapshotVolumeConfigurationRatio=4&snapshotVolumeConfigDayOfWeekTypeCode=6&snapshotVolumeConfigTime=0' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <?xml version="1.0" encoding="UTF-8"?>
<changeNasVolumeSnapshotConfigurationResponse>
    <requestId></requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <nasVolumeInstanceList>
        <nasVolumeInstance>
            <nasVolumeInstanceNo>00000000</nasVolumeInstanceNo>
            <nasVolumeInstanceStatus>
                <code>CREAT</code>
                <codeName>NAS create</codeName>
            </nasVolumeInstanceStatus>
            <nasVolumeInstanceOperation>
                <code>NULL</code>
                <codeName>NAS NULL OP</codeName>
            </nasVolumeInstanceOperation>
            <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
            <createDate>2024-04-03T16:23:17+0900</createDate>
            <nasVolumeDescription></nasVolumeDescription>
            <mountInformation>10.250.53.85:/n2795985_hsh</mountInformation>
            <volumeAllotmentProtocolType>
                <code>NFS</code>
                <codeName>NFS</codeName>
            </volumeAllotmentProtocolType>
            <volumeName>n2795985_hsh</volumeName>
            <volumeTotalSize>536870912000</volumeTotalSize>
            <volumeSize>515396075520</volumeSize>
            <snapshotVolumeConfigurationRatio>4.0</snapshotVolumeConfigurationRatio>
            <snapshotVolumeConfigPeriodType>
                <code>WEEK</code>
                <codeName>everyweek</codeName>
            </snapshotVolumeConfigPeriodType>
            <snapshotVolumeConfigDayOfWeekType>
                <code>6</code>
                <codeName>Saturday</codeName>
            </snapshotVolumeConfigDayOfWeekType>
            <snapshotVolumeConfigTime>0</snapshotVolumeConfigTime>
            <snapshotVolumeSize>21474836480</snapshotVolumeSize>
            <isSnapshotConfiguration>true</isSnapshotConfiguration>
            <isEventConfiguration>false</isEventConfiguration>
            <region>
                <regionNo>1</regionNo>
                <regionCode>KR</regionCode>
                <regionName>Korea</regionName>
            </region>
            <zone>
                <zoneNo>3</zoneNo>
                <zoneName>KR-2</zoneName>
                <zoneCode>KR-2</zoneCode>
                <zoneDescription>坪村ゾーン</zoneDescription>
                <regionNo>1</regionNo>
            </zone>
            <isReturnProtection>false</isReturnProtection>
            <nasVolumeInstanceCustomIpList/>
            <nasVolumeServerInstanceList/>
        </nasVolumeInstance>
    </nasVolumeInstanceList>
</changeNasVolumeSnapshotConfigurationResponse>