MENU
      GetMigrationJobList
        • PDF

        GetMigrationJobList

        • PDF

        Article summary

        Retrieve the migration policy list.

        Request

        Syntax

        GET  https://objectmigration.apigw.ntruss.com/migration-api/v1/policies
        HTTP

        Request header

        Refer to common guide

        Request parameters

        Parameter nameRequiredTypeRestrictionDescription
        orderNoStringOne of "createTime, updateTime, title, sourceBucketName, targetBucketName" must be entered.Policy listing standards
        Default value: createTime
        sortByNoStringEither asc or desc must be enteredSorting method (ascending order, descending order)
        Default value: asc
        limitNoIntegerNumber of policies to list at once
        Default Value : 100
        pageNoIntegerPage of the list to retrieve
        Default Value : 0

        Response

        Response parameters

        Parameter nameTypeRestrictionDescription
        titleStringPolicy name
        sourceBucketNameStringSource bucket name
        sourceCspTypeStringSource CSP name
        e.g., AWS or Azure
        sourceEndpointStringSource endpoint
        sourceRegionNameStringSource region code of where the bucket to be migrated is located
        sourcePrefixStringSource prefix
        targetBuketNameStringTarget bucket name
        targetEndpointStringTarget endpoint
        targetRegionNameStringTarget region code of where the specific NAVER Cloud Platform bucket is located
        targetPrefixStringTarget prefix
        jobStateStringCurrent task status
        e.g., INITIALIZED, STARTED, PAUSED, DELETED, DONE, ERROR
        createTimeDatePolicy creation date
        updateTimeStringPolicy update date
        estimatedDoneBooleanListing completion status of the objects corresponding to the prefix of the source bucket
        estimatedSizeLongTotal size of the objects corresponding to the prefix of the source bucket
        migratedSizeLongTotal size of the objects that have been migrated
        skippedSizeIntegerTotal size of the objects that have not been migrated due to locked buckets
        estimatedObjectNumIntegerTotal size of the objects that have not been migrated due to locked buckets
        migratedObjectNumIntegerTotal number of the objects that have been migrated
        skippedObjectNumIntegerTotal 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}"
        HTTP

        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
            }]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.