本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListBackupJobSummaries
這是最近 30 天內建立或執行的備份任務摘要請求。您可以包括 AccountID、狀態、、 ResourceType、、 MessageCategory AggregationPeriod MaxResults、或參數 NextToken 來篩選結果。
此要求會傳回包含內含工作的「區域」、「帳戶」 ResourceType MessageCategory、「州/省」 StartTime EndTime、、和「計數」的摘要。
請求語法
GET /audit/backup-job-summaries?AccountId=AccountId
&AggregationPeriod=AggregationPeriod
&MaxResults=MaxResults
&MessageCategory=MessageCategory
&NextToken=NextToken
&ResourceType=ResourceType
&State=State
HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- AccountId
-
傳回指定帳戶的任務計數。
如果要求是從成員帳戶或不屬於 Organ AWS izations 的帳戶傳送,則會傳回要求者帳戶內的工作。
根、管理員和委派管理員帳戶可以使用 ANY 值,傳回組織中每個帳戶的任務計數。
AGGREGATE_ALL
彙總已驗證組織內所有帳戶的任務計數,然後傳回總和。模式:
^[0-9]{12}$
- AggregationPeriod
-
傳回結果的期間。
-
ONE_DAY
-前 14 天的每日工作計數。 -
SEVEN_DAYS
-前 7 天的彙總工作計數。 -
FOURTEEN_DAYS
-之前 14 天的彙總工作計數。
有效值:
ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS
-
- MaxResults
-
所要傳回的項目數量上限。
值是整數。可接受值的範圍是從 1 到 500。
有效範圍:最小值為 1。最大值為 1000。
- MessageCategory
-
此參數會傳回指定訊息類別的任務計數。
接受的字串範例包括
AccessDenied
、Success
和InvalidParameters
。如需接受 MessageCategory 字串的清單,請參閱監視。該值 ANY 會傳回所有訊息類別的計數。
AGGREGATE_ALL
彙總所有訊息類別的任務計數,並傳回總和。 - NextToken
-
所傳回資源部分清單之後的下一個項目。例如,如果請求傳回
MaxResults
個數量的資源,則NextToken
允許您從下一個字符指向的位置開始傳回列表中的更多項目。 - ResourceType
-
傳回指定資源類型的任務計數。使用請求
GetSupportedResourceTypes
取得支援資源類型的字串。該值 ANY 會傳回所有資源類型的計數。
AGGREGATE_ALL
彙總所有資源類型的任務計數,並傳回總和。要備份的 AWS 資源類型;例如,亞馬遜彈性區塊存放區 (Amazon EBS) 磁碟區或 Amazon Relational Database Service 服務 (Amazon RDS) 資料庫。
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
- State
-
此參數會傳回具有指定狀態之任務的任務計數。
該值 ANY 會傳回所有狀態的計數。
AGGREGATE_ALL
彙總所有狀態的任務計數,並傳回總和。Completed with issues
是僅在 AWS Backup 主控台中找到的狀態。對於 API,此狀態是指狀態為COMPLETED
且值不是SUCCESS
之MessageCategory
的任務;也就是說,狀態為已完成,但出現狀態訊息。若要取得Completed with issues
的任務計數,請執行兩個 GET 請求,並減去第二個較小的數字:獲取/審計/?backup-job-summaries AggregationPeriod= 十四天和狀態 = 已完成
獲取/審計/?backup-job-summaries AggregationPeriod= 十四天 = MessageCategory 成功和狀態 = 已完成
有效值:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"AggregationPeriod": "string",
"BackupJobSummaries": [
{
"AccountId": "string",
"Count": number,
"EndTime": number,
"MessageCategory": "string",
"Region": "string",
"ResourceType": "string",
"StartTime": number,
"State": "string"
}
],
"NextToken": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AggregationPeriod
-
傳回結果的期間。
-
ONE_DAY
-前 14 天的每日工作計數。 -
SEVEN_DAYS
-前 7 天的彙總工作計數。 -
FOURTEEN_DAYS
-之前 14 天的彙總工作計數。
類型:字串
-
- BackupJobSummaries
-
摘要資訊。
類型:BackupJobSummary 物件陣列
- NextToken
-
所傳回資源部分清單之後的下一個項目。例如,如果請求傳回
MaxResults
個數量的資源,則NextToken
允許您從下一個字符指向的位置開始傳回列表中的更多項目。類型:字串
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
HTTP 狀態碼:500
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: