GetMigrationJobList
- Print
- PDF
GetMigrationJobList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Retrieve the migration policy list.
Request
Syntax
GET https://objectmigration.apigw.ntruss.com/migration-api/v1/policies
Request header
Refer to common guide
Request parameters
| Parameter name | Required | Type | Restriction | Description |
|---|---|---|---|---|
| order | No | String | One of "createTime, updateTime, title, sourceBucketName, targetBucketName" must be entered. | Policy listing standards Default value: createTime |
| sortBy | No | String | Either asc or desc must be entered | Sorting method (ascending order, descending order) Default value: asc |
| limit | No | Integer | Number of policies to list at once Default Value : 100 | |
| page | No | Integer | Page of the list to retrieve Default Value : 0 |
Response
Response parameters
| Parameter name | Type | Restriction | Description |
|---|---|---|---|
| title | String | Policy name | |
| sourceBucketName | String | Source bucket name | |
| sourceCspType | String | Source CSP name e.g., AWS or Azure | |
| sourceEndpoint | String | Source endpoint | |
| sourceRegionName | String | Source region code of where the bucket to be migrated is located | |
| sourcePrefix | String | Source prefix | |
| targetBuketName | String | Target bucket name | |
| targetEndpoint | String | Target endpoint | |
| targetRegionName | String | Target region code of where the specific NAVER Cloud Platform bucket is located | |
| targetPrefix | String | Target prefix | |
| jobState | String | Current task status e.g., INITIALIZED, STARTED, PAUSED, DELETED, DONE, ERROR | |
| createTime | Date | Policy creation date | |
| updateTime | String | Policy update date | |
| estimatedDone | Boolean | Listing completion status of the objects corresponding to the prefix of the source bucket | |
| estimatedSize | Long | Total size of the objects corresponding to the prefix of the source bucket | |
| migratedSize | Long | Total size of the objects that have been migrated | |
| skippedSize | Integer | Total size of the objects that have not been migrated due to locked buckets | |
| estimatedObjectNum | Integer | Total size of the objects that have not been migrated due to locked buckets | |
| migratedObjectNum | Integer | Total number of the objects that have been migrated | |
| skippedObjectNum | Integer | Total number of the objects that have not been migrated due to locked buckets |
Example
Request Example
GET https://objectmigration.apigw.ntruss.com/migration-api/v1/policies?limit={limit}&order={order}&page={page}&sortBy={sortBy}
-H "x-ncp-region_code: {regionCode}“
-H "x-ncp-iam-access-key: {AccessKey} "
-H "x-ncp-apigw-timestamp: {current timestamp}"
-H "x-ncp-apigw-signature-v2: {generated signature}"
Response Example
{
"objStrContracted": true,
"num": 1,
"jobList": [
{
"title": "테스트",
"sourceBucketName": "migration-test",
"sourceCspType": "AWS",
"sourceEndpoint": "https://s3.ap-northeast-2.amazonaws.com",
"sourcePrefix": "aws/",
"targetBucketName": "test-bucket",
"targetEndpoint": "https://kr.beta-object.ncloudstorage.com",
"targetRegionName": "KR",
"targetPrefix": "",
"jobState": "INITIALIZED",
"createTime": "2021-08-09T04:37:28.923119",
"updateTime": "2021-12-08T16:51:58.38201",
"estimatedDone": false,
"estimatedSize": 0,
"migratedSize": 0,
"skippedSize": 0,
"estimatedObjectNum": 0,
"migratedObjectNum": 0,
"skippedObjectNum": 0
}]
}
Was this article helpful?