Create a snapshot schedule

指定したアーカイブストレージ(NFS)のスナップショットスケジュールを作成します。

APIエンドポイント

リージョン	APIエンドポイント
東日本リージョン3の場合	https://filestorage.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI

POST

/v1/archive/{project_id}/snapshots/schedule

HTTPステータスコード

正常時：201

エラー時：401, 403, 404, 500

リクエストパラメータの説明

名前	In	Type	デフォルト値 /必須指定	説明
project_id	path	string	必須	プロジェクトID
storage_id	body	string	必須	スナップショットスケジュールを作成するストレージのID
schedule	body	object	必須	スケジュールオブジェクト
name	body	string	必須	スナップショットスケジュールの名称 - 指定可能文字種：半角英字、半角数字、半角スペース( )、半角記号（!#$%&()*+,-./:;<=>?@[\]^_{|}~） - 指定可能文字数：1～200
month	body	array	必須	月(Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec,all) - 複数指定する場合はカンマ(,)で区切ります。 - 指定可能な数は、12個です。 - 毎月(all)を指定した場合、複数指定（個別の月指定）はできません。
day	body	array	必須	日(1 ～ 31,all) - 複数指定する場合はカンマ(,)で区切ります。 - 指定可能な数は、31個です。 - 毎日(all)を指定した場合、複数指定（個別の日指定）はできません。
dayofweek	body	array	必須	週(Mon,Tue,Wed,Thu,Fri,Sat,Sun,all) - 複数指定する場合はカンマ(,)で区切ります。 - 指定可能な数は、7個です。 - 毎日(all)を指定した場合、複数指定（個別の曜日指定）はできません。
hour	body	array	必須	時(0 ～ 23,all) - 複数指定する場合はカンマ(,)で区切ります。 - 指定可能な数は、24個です。 - 毎時(all)を指定した場合、複数指定（個別の時指定）はできません。
minute	body	array	必須	分(0 ～ 59) - 複数指定する場合はカンマ(,)で区切ります。 - 指定可能な数は、12個です。

レスポンスボディ（正常系）の説明

名前	Type	説明
job	object	ジョブオブジェクト
api_name	string	API名称
created_at	string	ジョブの作成日時
id	integer	ジョブID
project_id	string	プロジェクトID
request_parameter	object	API実行時のリクエストパラメータ
status	string	ステータス情報

リクエスト例

リクエスト

POST /v1/archive/948ab26d2e7140f18852b6b2f26369c4/snapshots/schedule

リクエストボディ

{
    "schedule": {
        "storage_id": "12a8fed6-1624-4b46-9c65-96e341d04104",
        "name": "schedule0527",
        "month": [
          "May"
        ],
        "day": [
          "all"
        ],
        "dayofweek": [
          "Mon"
        ],
        "hour": [
          "1"
        ],
        "minute": [
          "1"
        ]
    }
}

レスポンス例

レスポンスボディ

{
    "job": {
      "api_name": "Create a snapshot schedule",
      "created_at": "2021-05-27T06:20:18Z",
      "id": 14416,
      "project_id": "948ab26d2e7140f18852b6b2f26369c4",
      "request_parameter": {
        "schedule": {
          "storage_id": "12a8fed6-1624-4b46-9c65-96e341d04104",
          "name": "schedule0527",
          "dayofweek": [
            "Mon"
          ],
          "minute": [
            "1"
          ],
          "hour": [
            "1"
          ],
          "day": [
            "all"
          ],
          "month": [
            "May"
          ]
        }
      },
      "status": "EXECUTING"
    }
}