UpdateMigrationJob

Prev Next

Classic/VPC環境で利用できます。

移行ポリシーの内容を更新します。入力した内容で既存のポリシーが上書きされます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /migration-api/v1/policy/{title}

リクエストヘッダ

Object Migration APIで共通して使用されるヘッダの詳細は、Object Migrationのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
title String Required 移行ポリシー名

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
title String Required 移行ポリシー名
  • 100Byte以内で入力
  • 記号の「.」、「-」、「_」は使用可能
source Object Required ソース情報
source.sourceCspType String Required ソースの CSPタイプ
  • AWS | Azure
source.regionName String Required ソースのリージョンコード
source.bucketName String Required ソースのバケット名
source.prefix String Optional ソースデータの接頭辞
  • 特定のファイルグループのみ移行する場合、入力
source.accessKey String Required ソース CSP情報
  • AWS: アカウントの Access Key
  • Azure: ストレージアカウント名
source.secretKey String Required ソース CSP情報
  • AWS: アカウントの Secret Key
  • Azure: アカウントの Access Key
target Object Required ターゲット情報
target.bucketName String Required ターゲットバケット名
target.prefix String Optional 接頭辞
  • 特定のパスに移行する場合、入力

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://objectmigration.apigw.ntruss.com/migration-api/v1/policy/mypolicy' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data '{
            "title": "migrationpolicy",
            "source": {
                "sourceCspType": "AWS",
                "regionName": "ap-southeast-2",
                "bucketName": "testformigration135",
                "prefix": "",
                "accessKey": "****************",
                "secretKey": "****************************"
            },
            "target": {
                "bucketName": "migrationbucket",
                "prefix": "data/"
            }
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
title String - 移行ポリシー名
sourceBucketName String - ソースのバケット名
sourceRegionName String - ソースのリージョンコード
sourceCspType String - ソースの CSPタイプ
  • AWS | Azure
sourceEndpoint String - ソースのエンドポイント
sourcePrefix String - ソースデータの接頭辞
  • バケット内の詳細パスと区切り文字
targetBucketName String - ターゲットバケット名
targetRegionName String - ターゲットリージョンコード
targetEndpoint String - ターゲットエンドポイント
targetPrefix String - 接頭辞
  • バケット内の詳細パスと区切り文字
jobState String - ジョブの状態
  • INITIALIZED | STARTED | PAUSED | DELETED | DONE | ERROR
    • INITIALIZED: 準備完了
    • STARTED: 移行中
    • PAUSED: 停止
    • DELETED: 削除
    • DONE: 完了
    • ERROR: エラー
createTime String - ポリシーの作成日時
  • ISO 8601形式
updateTime String - ポリシーの更新日時
  • ISO 8601形式
estimatedDone Boolean - ソースオブジェクトリストは完了したか
  • true | false
    • true: 完了
    • false: 完了していない
estimatedSize Number - ソースデータの総容量
migratedSize Number - 移行されたデータ容量
skippedSize Integer - 移行されていないデータ容量
estimatedObjectNum Integer - ソースオブジェクト数
migratedObjectNum Integer - 移行されたオブジェクト数
skippedObjectNum Integer - 移行されていないオブジェクト数

レスポンスステータスコード

Object Migration APIで共通して使用されるレスポンスステータスコードの詳細は、Object Migrationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "title": "migrationpolicy",
    "sourceBucketName": "migration135",
    "sourceRegionName": "ap-southeast-2",
    "sourceCspType": "AWS",
    "sourceEndpoint": "https://s3.ap-southeast-2.amazonaws.com",
    "sourcePrefix": "",
    "targetBucketName": "migrationbucket",
    "targetRegionName": "KR",
    "targetEndpoint": "https://kr.object.ncloudstorage.com",
    "targetPrefix": "data/",
    "jobState": "INITIALIZED",
    "createTime": "2025-07-15T00:32:36.480+00:00",
    "updateTime": "2025-07-15T00:32:36.480+00:00",
    "estimatedDone": false,
    "estimatedSize": 0,
    "migratedSize": 0,
    "skippedSize": 0,
    "estimatedObjectNum": 0,
    "migratedObjectNum": 0,
    "skippedObjectNum": 0
}