翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListCopyJobs
コピージョブに関するメタデータを返します。
リクエストの構文
GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
URI リクエストパラメータ
リクエストは、次のURIパラメータを使用します。
- ByAccountId
-
ジョブを一覧表示するアカウント ID。指定されたアカウント ID に関連付けられたコピージョブのみを返します。
パターン:
^[0-9]{12}$ - ByCompleteAfter
-
Unix 形式と協定世界時 () で表された日付の後に完了したコピージョブのみを返しますUTC。
- ByCompleteBefore
-
Unix 形式と協定世界時 () で表される日付より前に完了したコピージョブのみを返しますUTC。
- ByCreatedAfter
-
指定した日付より後に作成されたコピージョブのみを返します。
- ByCreatedBefore
-
指定した日付より前に作成されたコピージョブのみを返します。
- ByDestinationVaultArn
-
コピー元のソースバックアップボールトを一意に識別する Amazon リソースネーム (ARN）。例:
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault。 - ByMessageCategory
-
これは、入力する値 MessageCategory と一致する を使用してジョブをフィルタリングするために使用できるオプションのパラメータです。
文字列の例としては
AccessDenied、SUCCESS、AGGREGATE_ALL、およびINVALIDPARAMETERSがあります。使用可能な文字列のリストについては、「モニタリング」を参照してください。
値は、すべてのメッセージカテゴリのカウントANYを返します。
AGGREGATE_ALLは、すべてのメッセージカテゴリのジョブ数を集計し、その合計を返します。 - ByParentJobId
-
親ジョブ ID に基づいて子 (ネストされた) ジョブを一覧表示するフィルターです。
- ByResourceArn
-
指定されたリソース Amazon リソースネーム () に一致するコピージョブのみを返しますARN。
- ByResourceType
-
指定されたリソースのバックアップジョブのみを返します。
-
Amazon Aurora の場合は
Aurora -
CloudFormationの AWS CloudFormation -
Amazon DocumentDB (MongoDB 互換性) の場合は
DocumentDB -
Amazon DynamoDB 用の
DynamoDB -
Amazon Elastic Block Store 用の
EBS -
Amazon Elastic Compute Cloud 用の
EC2 -
Amazon Elastic File System 用の
EFS -
FSxAmazon 用 FSx -
Amazon Neptune の場合 用の
Neptune -
Amazon Relational Database Service 用の
RDS -
Amazon Redshift 用の
Redshift -
S3for Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2Amazon Elastic Compute Cloud インスタンス上のSAPHANAデータベース用 -
Storage Gatewayの AWS Storage Gateway -
Amazon Timestream 用の
Timestream -
VirtualMachineVMware仮想マシン用
パターン:
^[a-zA-Z0-9\-\_\.]{1,50}$ -
- ByState
-
指定された状態のコピージョブのみを返します。
有効な値:
CREATED | RUNNING | COMPLETED | FAILED | PARTIAL - MaxResults
-
返されるアイテムの最大数。
有効な範囲: 最小値 は 1 です。最大値は 1000 です。
- NextToken
-
返された項目の一部リストに続く次の項目。例えば、項目 MaxResults 数を返すリクエストが行われた場合、 は次のトークンで指す場所からリスト内のより多くの項目を返す NextToken ことができます。
リクエスト本文
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"CopyJobs": [
{
"AccountId": "string",
"BackupSizeInBytes": number,
"ChildJobsInState": {
"string" : number
},
"CompletionDate": number,
"CompositeMemberIdentifier": "string",
"CopyJobId": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"DestinationBackupVaultArn": "string",
"DestinationRecoveryPointArn": "string",
"IamRoleArn": "string",
"IsParent": boolean,
"MessageCategory": "string",
"NumberOfChildJobs": number,
"ParentJobId": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"SourceRecoveryPointArn": "string",
"State": "string",
"StatusMessage": "string"
}
],
"NextToken": "string"
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。
次のデータは、 サービスによって JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
HTTP ステータスコード: 500
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
