本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> DescribeInstanceBackupRuleActivities

DescribeInstanceBackupRuleActivities

処理概要

指定したバックアップルールのイベントログ情報を取得します。

バックアップルールを指定するためには、バックアップルールIDが必要です。削除済みのバックアップルールIDを指定した、管理外のバックアップルールIDを指定したなど、無効なバックアップルールIDを指定した場合は、エラーが返されます。

取得するイベントログ情報は、イベント開始日時の降順となります。

指定するパラメーター

パラメーター 説明 必須
InstanceBackupRuleId string バックアップルールID
Duration integer イベントログ取得時間
単位: 分
値: 60~14400
Default: 10080
EndDateTime string イベントログ取得終了日時(JST)
値: yyyymmdd hh:mm:ss | yyyy-mm-dd hh:mm:ss | yyyy/mm/dd hh:mm:ss
Default: 実行日時
MaxRecords integer イベントログ最大取得件数
値: 1~1000
Default: 100

応答フィールド

フィールド (項目) 説明
DescribeInstanceBackupRuleActivitiesResponse DescribeInstanceBackupRuleActivitiesResponseType DescribeInstanceBackupRuleActivitiesレスポンス
Ancestor: なし
Children: requestId | instanceBackupRuleId | instanceBackupRuleName | activitiesSet
requestId string リクエスト識別子
Ancestor: DescribeInstanceBackupRuleActivitiesResponse
Children: なし
instanceBackupRuleId string バックアップルールID
Ancestor: DescribeInstanceBackupRuleActivitiesResponse
Children: なし
instanceBackupRuleName string バックアップルール名
Ancestor: DescribeInstanceBackupRuleActivitiesResponse
Children: なし
activitiesSet DescribeInstanceBackupRuleActivitiesSetType バックアップイベントログ情報
Ancestor: DescribeInstanceBackupRuleActivitiesResponse
Children: item
item DescribeInstanceBackupRuleActivitiesItemType
Ancestor: activitiesSet
Children: backupInstanceUniqueId | instanceUniqueId | startDateTime | endDateTime | status | detail | operation
backupInstanceUniqueId string バックアップサーバーユニークID
Ancestor: item
Children: なし
instanceUniqueId string バックアップ元サーバーユニークID
Ancestor: item
Children: なし
startDateTime string イベント開始日時
Ancestor: item
Children: なし
endDateTime string イベント終了日時
Ancestor: item
Children: なし
status string イベント結果
値: success(成功) | failed(失敗) | processing(処理中)
Ancestor: item
Children: なし
detail string イベント詳細(status=failed(失敗)以外は空を返却)
値: Client.ForbiddenBackup.TooLargeIncrementSize(更新差分量が上限を超えている) | Server.Maintenance(メンテナンス中) | Server.ResourceIncorrectState.BackupInstanceRule.Updating(バックアップルール更新中) | Server.ResourceIncorrectState.BackupInstance.Deleting(期限切れ増分バックアップ削除中) | Server.ResourceIncorrectState.BackupInstance.Creating(増分バックアップ実施中) | Server.ResourceIncorrectState.FromBackupInstance.Copying(バックアップからのコピー実施中) | Server.ProcessingFailure.InstanceBackup(設定した時間帯での増分バックアップ失敗) | Server.InternalError.BKE00001(システムエラー) | Server.Exception(システムエラー)
Ancestor: item
Children: なし
operation string 操作
値: create_full_backup(フルバックアップ) | create_backup_instance(増分バックアップ) | copy_from_backup_instance(バックアップサーバーからのコピー) | delete_backup_instance(世代保持数以上のバックアップサーバーの削除) | refresh_backup(バックアップルール再作成)
Ancestor: item
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
Action=DescribeInstanceBackupRuleActivities
&InstanceBackupRuleId=ibr-00000000
&CommonParams
  

応答サンプル

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DescribeInstanceBackupRuleActivitiesResponse xmlns="https://cp.cloud.nifty.com/api/3.0/">
  <requestId>7b755af7-56f0-4176-b736-29586a16faba</requestId>
  <instanceBackupRuleId>ibr-00000000</instanceBackupRuleId>
  <instanceBackupRuleName>backup</instanceBackupRuleName>
  <activitiesSet>
    <item>
      <backupInstanceUniqueId>bi-05qch410</backupInstanceUniqueId>
      <instanceUniqueId>i-0gl439y1</instanceUniqueId>
      <startDateTime>2018-11-19T12:32:55.000+09:00</startDateTime>
      <endDateTime>2018-11-19T12:33:46.000+09:00</endDateTime>
      <status>success</status>
      <detail/>
      <operation>create_backup_instance</operation>
    </item>
    <item>
      <backupInstanceUniqueId/>
      <instanceUniqueId>i-0gl439y1</instanceUniqueId>
      <startDateTime>2018-11-19T12:32:54.000+09:00</startDateTime>
      <endDateTime>2018-11-19T12:33:47.000+09:00</endDateTime>
      <status>success</status>
      <detail/>
      <operation>create_full_backup</operation>
    </item>
  </activitiesSet>
</DescribeInstanceBackupRuleActivitiesResponse>

  

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上