StartMigrationJob
- Print
- PDF
StartMigrationJob
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Run (start) a migration task.
Request
Syntax
POST https://objectmigration.apigw.ntruss.com/migration-api/v1/policy/{title}/start
Request header
Refer to common guide
Request parameters
| Parameter name | Required | Type | Restriction | Description |
|---|---|---|---|---|
| title | Yes | String | The special characters other than ".", "-", and "_" can't be used. (Up to 100 bytes) | Policy name |
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
POST https://objectmigration.apigw.ntruss.com/migration-api/v1/policy/{title}/start
-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
{
"title": "테스트",
"sourceBucketName": "object-migration-test-bucket",
"sourceCspType": "AWS",
"sourceEndpoint": "https://s3.ap-northeast-2.amazonaws.com",
"sourcePrefix": "a/test/test",
"targetBucketName": "test-bucket",
"targetEndpoint": "https://kr.beta-object.ncloudstorage.com",
"targetRegionName": "KR",
"targetPrefix": "a-test/test",
"jobState": "STARTED",
"createTime": "2022-02-11T04:41:29.840998",
"updateTime": "2022-02-11T04:41:29.84126",
"estimatedDone": false,
"estimatedSize": 0,
"migratedSize": 0,
"skippedSize": 0,
"estimatedObjectNum": 0,
"migratedObjectNum": 0,
"skippedObjectNum": 0
}
Was this article helpful?