GetMigrationJobList

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

移行ポリシーリストを照会します。

リクエスト

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

メソッド	URI
GET	/migration-api/v1/policies

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`order`	String	Optional	ソート対象 `createTime` (デフォルト) \| `updateTime` \| `title` \| `sourceBucketName` \| `targetBucketName` `createTime`: ポリシー作成日時 `updateTime`: ポリシー更新日時 `title`: 移行ポリシー名 `sourceBucketName`: ソースバケット名 `targetBucketName`: ターゲットバケット名
`sortBy`	String	Optional	ソート順序 `asc` (デフォルト) \| `desc` `asc`: 昇順 `desc`: 降順
`limit`	Integer	Optional	ページごとの項目数 1~N (デフォルト: 100)
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)

リクエスト例

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

curl --location --request GET 'https://objectmigration.apigw.ntruss.com/migration-api/v1/policies?order=title&sortBy=asc&limit=3&page=0' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`objStrContracted`	Boolean	-	Object Storageサービスは申し込み済みか
`num`	Integer	-	移行ポリシー数
`jobList`	Array	-	移行ポリシーリスト

`jobList`

jobListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`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のレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "objStrContracted": true,
    "num": 1,
    "jobList": [
                {
                    "title": "policy",
                    "sourceBucketName": "migration135",
                    "sourceRegionName": "ap-southeast-2",
                    "sourceCspType": "AWS",
                    "sourceEndpoint": "https://s3.ap-southeast-2.amazonaws.com",
                    "sourcePrefix": "",
                    "targetBucketName": "databucket",
                    "targetRegionName": "KR",
                    "targetEndpoint": "https://kr.object.ncloudstorage.com",
                    "targetPrefix": "",
                    "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
                }
    ]
}