ニフクラAPI (DevOps with Gitlab: UpdateBackupRule)

UpdateBackupRule

処理概要

指定したバックアップルールの設定を更新します。
リクエストボディパラメーターのいずれか(changedBackupRuleName,description)は指定必須です。

リクエストURL

PUT /v1/backupRules/{BackupRuleName}

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
BackupRuleName	string	バックアップルール名	○

リクエストボディ

パラメーター	型	説明	必須
changedBackupRuleName	string	バックアップルール名 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)
description	string	メモ 使用可能文字: 255文字以内の全角半角

応答フィールド

フィールド (項目)	型	説明
backupRule	object
␣generation	integer	バックアップファイルの世代数（最大保存数）
␣description	string	メモ
␣backupRuleName	string	バックアップルール名
␣instanceId	string	バックアップ対象のDevOpsサーバー名
␣backupTime	string	バックアップ実行時刻（cron表記）

リクエストサンプル

    curl -XPUT https://jp-east-1.devops.api.nifcloud.com/v1/backupRules/gitlab1backuprule
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "changedBackupRuleName":"gitlab1bkrule",
    "description":"production_backup_rule"
}'

  

応答サンプル

    {
    "backupRule":{
        "generation":7,
        "description":"production_backup_rule",
        "backupRuleName":"gitlab1bkrule",
        "instanceId":"gitlab1",
        "backupTime":"5 12 * * *"
    }
}