Set the snapshot schedule.
    • PDF

    Set the snapshot schedule.

    • PDF

    Article summary

    Available in VPC

    Set the snapshot schedule.

    Request

    Request URL

    POST https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/setSnapshotScheduling/{service-group-instance-no} [KR]
    POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/snapshot/setSnapshotScheduling/{service-group-instance-no} [SGN]
    

    Request header

    Header nameDescription
    x-ncp-apigw-timestampIt indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds.
    If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyValue of access key ID issued on the NAVER Cloud Platform portal
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeIt specifies the request body content type as application/json.
    Content-Type: application/json

    Request parameters

    ParameterTypeRequirement statusDescription
    serviceGroupInstanceNoStringYCluster number for creating snapshot
    snapshotNameStringYSnapshot name
    bucketNameStringYBucket name where the snapshots will be saved
    scheduledDayStringYDay when the schedule will run
    scheduledHourIntegerYHour at which the schedule will run
    0~23
    scheduledMinuteIntegerYMinute at which the schedule will run
    0, 15, 30, 45
    • Available values for scheduled day
    Scheduled DayDescription
    EverydayIt runs every day.
    SundayIt runs on Sundays.
    MondayIt runs on Mondays.
    TuesdayIt runs on Tuesdays.
    WednesdayIt runs on Wednesdays.
    ThursdayIt runs on Thursdays.
    FridayIt runs on Fridays.
    SaturdayIt runs on Saturdays.

    Request examples

    POST https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/setSnapshotScheduling/1531843
    HOST: vpcsearchengine.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
    x-ncp-apigw-timestamp: 1593848345548
    x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
    
    {
      "snapshotName": "my-snapshot",
      "bucketName": "estest",
      "scheduledDay": "Everyday",
      "scheduledHour": 0,
      "scheduledMinute": 0
    }
    
    curl -X POST "https://vpcsearchengine.apigw.ntruss.com/api/v2/snapshot/setSnapshotScheduling/1531843 \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
    -H "x-ncp-apigw-timestamp: 1601971222179" \
    -H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" \
    -d \
    '{
      "snapshotName": "my-snapshot",
      "bucketName": "estest",
      "scheduledDay": "Everyday",
      "scheduledHour": 0,
      "scheduledMinute": 0
     }'
    

    Response examples

    {
      "code": 0,
      "message": "SUCCESS",
      "result": true,
      "requestId": "2757144e-8548-472d-9d65-962406b4efa0"
    }
    

    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.