computing / Client / create_instance_backup_rule

create_instance_backup_rule

computing.Client.create_instance_backup_rule(**kwargs)

バックアップルールを新規作成します。

バックアップルールを作成するためには、サーバーユニークIDが必要です。

バックアップルール作成時に1つの増分バックアップが作成されます。2つ目以降の増分バックアップは「TimeSlotId」で指定した実行時間帯に作成されます。

手動で増分バックアップを作成する場合は、 `CreateBackupInstances <https://docs.nifcloud.com/cp/api/CreateBackupInstances.htm>`__を実施することで作成できます。

2回目以降の増分バックアップの作成は、初回バックアップの作成完了後に可能となります。

「BackupInstanceMaxCount」で指定した保持する最大世代数を超えた増分バックアップが作成された場合、最も古い増分バックアップは削除されます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_instance_backup_rule(
    BackupInstanceMaxCount=123,
    Description='string',
    InstanceBackupRuleName='string',
    InstanceUniqueId=[
        'string',
    ],
    TimeSlotId='1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'|'10'|'11'|'12'
)

Parameters:

• BackupInstanceMaxCount (integer) – [REQUIRED]

• Description (string) –

• InstanceBackupRuleName (string) –

• InstanceUniqueId (list) –

  [REQUIRED]

  • (string) –

• TimeSlotId (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'InstanceBackupRule': {
        'AvailabilityZone': 'string',
        'BackupInstanceMaxCount': 123,
        'Description': 'string',
        'InstanceBackupRuleId': 'string',
        'InstanceBackupRuleName': 'string',
        'InstancesSet': [
            {
                'BackupInstancesSet': 'string',
                'InstanceId': 'string',
                'InstanceUniqueId': 'string'
            },
        ],
        'RegionName': 'string',
        'Status': 'string',
        'TimeSlotId': 'string'
    },
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

• (dict) –

  • InstanceBackupRule (dict) –

    • AvailabilityZone (string) –

    • BackupInstanceMaxCount (integer) –

    • Description (string) –

    • InstanceBackupRuleId (string) –

    • InstanceBackupRuleName (string) –

    • InstancesSet (list) –

      • (dict) –

        • BackupInstancesSet (string) –

        • InstanceId (string) –

        • InstanceUniqueId (string) –

    • RegionName (string) –

    • Status (string) –

    • TimeSlotId (string) –

  • RequestId (string) –

  • Return (boolean) –