翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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
-
たとえば、
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultなどのバックアップボールトを一意に識別する Amazon リソースネーム (ARN) です。 - 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 -
Amazon FSx の場合 用の
FSx -
Amazon Neptune の場合 用の
Neptune -
Amazon Relational Database Service 用の
RDS -
Amazon Redshift 用の
Redshift -
Amazon Simple Storage Service (Amazon S3) 用の
S3 -
Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の
SAP HANA on Amazon EC2 -
Storage Gatewayの AWS Storage Gateway -
Amazon Timestream 用の
Timestream -
VMware 仮想マシン用の
VirtualMachine
パターン:
^[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",
"BackupPlanName": "string",
"BackupPlanVersion": "string",
"BackupRuleCron": "string",
"BackupRuleId": "string",
"BackupRuleName": "string",
"BackupRuleTimezone": "string"
},
"CreationDate": number,
"DestinationBackupVaultArn": "string",
"DestinationEncryptionKeyArn": "string",
"DestinationRecoveryPointArn": "string",
"DestinationRecoveryPointLifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"DestinationVaultLockState": "string",
"DestinationVaultType": "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"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
- Context
- Type
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
- Context
- Type
HTTP ステータスコード: 500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
