PauseMigrationJob
    • PDF

    PauseMigrationJob

    • PDF

    Article summary

    Stop the migration task.

    Request

    Syntax

    POST  https://objectmigration.apigw.ntruss.com/migration-api/v1/policy/{title}/pause
    

    Request header

    Refer to common guide

    Request parameters

    Parameter nameRequiredTypeRestrictionDescription
    titleYesStringThe special characters other than ".", "-", and "_" can't be used.
    (Up to 100 bytes)
    Policy name

    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

    POST https://objectmigration.apigw.ntruss.com/migration-api/v1/policy/{title}/pause
    -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?

    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.