IfsMoverRest

개요

용도

IfsMover를 구동하기 위한 REST Server.

전제 조건

IfsMover-0.2.6+ 설치되어 있어야 합니다.

API

UserId는 임의의 문자열입니다.
ifsmoverRest의 모든 동작은 UserId로 구분됩니다.
UserId는 사용자가 관리합니다.

Check

type, source, target 정보에 대한 검사 결과를 리턴합니다.

URL : /api/Check
Request

{
    "Type":"string",    // file, s3, swift
    "Source":{
        "Mountpoint":"string",
        "Endpoint":"string",
        "Access":"string",
        "Secret":"string",
        "Bucket":"string",
        "Prefix":"string",
        "Move_size":"string"
    },
    "Target":{
        "Endpoint":"string",
        "Access":"string",
        "Secret":"string",
        "Bucket":"string",
        "Prefix":"string"
    }
}

Return

{
    "Result":"string",// success, failed
    "Message":"string"
}

Test

curl -H "Content-Type:application/json" "http://localhost:7123/api/Check" -d "{\"Type\":\"s3\", \"Source\":{\"Mountpoint\":null, \"Endpoint\":\"http://localhost:8080\", \"Access\":\"your_access_key\", \"Secret\":\"your_secret_key\", \"Bucket\":\"mover-test-source\", \"Prefix\":null, \"Move_size\":null}, \"Target\":{\"Endpoint\":\"http://localhost:8080\", \"Access\":\"your_access_key\", \"Secret\":\"your_secret_key\", \"Bucket\":\"mover-test-target-01\", \"Prefix\":\"05-18-001\"}}"

Start

ifsmover를 실행합니다. -check 옵션으로 먼저 수행한 후에 에러가 없으면 job을 수행하고 그렇지 않으면 failed를 리턴합니다.

URL : /api/Start
Request

{
    "UserId":"string",
    "Type":"string",    // file, s3
    "Source":{
        "Mountpoint":"string",
        "Endpoint":"string",
        "Access":"string",
        "Secret":"string",
        "Bucket":"string",
        "Prefix":"string",
        "Move_size":"string"
    },
    "Target":{
        "Endpoint":"string",
        "Access":"string",
        "Secret":"string",
        "Bucket":"string",
        "Prefix":"string"
    }
}

Return

{
    "Result":"string",  // success, failed
    "Message":"string",
    "JobId":0
}

Test

curl -H "Content-Type:application/json" "http://localhost:7123/api/Start" -d "{\"UserId\":\"1234\", \"Type\":\"s3\", \"Source\":{\"Mountpoint\":null, \"Endpoint\":\"http://localhost:8080\", \"Access\":\"your_access_key\", \"Secret\":\"your_secret_key\", \"Bucket\":\"mover-test-source\", \"Prefix\":null, \"Move_size\":null}, \"Target\":{\"Endpoint\":\"http://localhost:8080\", \"Access\":\"your_access_key\", \"Secret\":\"your_secret_key\", \"Bucket\":\"mover-test-target-01\", \"Prefix\":\"05-18-001\"}}"

Stop

UserId와 JobId에 해당하는 작업을 중지 시킵니다.

URL : /api/Stop/{UserId}/{JobId}
Return

{
    "Result":"string",// success, failed
    "Message":"string"
}

test

curl http://localhost:7123/api/Stop/1234/1

Rerun

UserId와 JobId에 해당하는 작업을 다시 수행합니다. JobId에 해당하는 작업이 진행 중이면 강제로 종료하고 다시 시작합니다.

URL : /api/Rerun/{UserId}/{JobId}
Request

{
    "Source":{
        "Mountpoint":"string",
        "Endpoint":"string",
        "Access":"string",
        "Secret":"string",
        "Bucket":"string",
        "Prefix":"string",
        "Move_size":"string"
    },
    "Target":{
        "Endpoint":"string",
        "Access":"string",
        "Secret":"string",
        "Bucket":"string",
        "Prefix":"string"
    }
}

Return

{
    "Result":"string",// success, failed
    "Message":"string"
}

Test

curl -H "Content-Type:application/json" "http://localhost:7123/api/Rerun/1234/1" -d "{\"Source\":{\"Mountpoint\":null, \"Endpoint\":\"http://localhost:8080\", \"Access\":\"your_access_key\", \"Secret\":\"your_secret_key\", \"Bucket\":\"mover-test-source\", \"Prefix\":null, \"Move_size\":null}, \"Target\":{\"Endpoint\":\"http://192.168.13.13:9090\", \"Access\":\"your_access_key\", \"Secret\":\"your_secret_key\", \"Bucket\":\"mover-test-target-01\", \"Prefix\":\"05-18-001\"}}"

Remove

UserId와 JobId에 해당하는 작업을 삭제합니다. 진행 중인 작업은 삭제할 수 없습니다. 먼저 Stop을 한 후에 Remove를 해야 합니다.

URL : /api/Remove/{UserId}/{JobId}
Return

{
    "Result":"string",// success, failed
    "Message":"string"
}

Test

curl "http://localhost:7123/api/Remove/1234/1"

Status

UserId에 해당하는 모든 Job에 대한 진행 정보를 가져옵니다.

URL : /api/Status/{UserId} -> 해당 UserId에 대한 모든 Job Status
URL : /api/Status/{UserId}?JobId=1&SrcBucket=bucket1&DstBucket=bucket2
Request
Return

{
    "Result":"string", // success, failed
    "Message":null,
    "Items":[
        {
            "JobId":0,
            "Status":"string",
            "Source":"string",
            "Target":"string",
            "StartTime":"string",
            "EndTime":"string",
            "ErrorDesc":"string",
            "TotalCount":0,
            "TotalSize":"string",
            "MovedCount":0,
            "MovedSize":"string",
            "SkippedCount":0,
            "SkippedSize":"string",
            "FailedCount":0,
            "FailedSize":"string",
            "Progress":"string"
        },
    ]
}
// Status
    INIT
    MOVE
    COMPLETE
    STOP
    RERUN INIT
    RERUN MOVE
    ERROR

Test

curl "http://localhost:7123/api/Status/1234"

curl "http://localhost:7123/api/Status/1234?JobId=4"

curl "http://localhost:7123/api/Status/1234?SrcBucket=bucket"

curl "http://localhost:7123/api/Status/1234?DstBucket=bucket"

curl "http://localhost:7123/api/Status/1234?SrcBucket=bucket1&DstBucket=bucket2"

구동 환경

JDK 11+

How to Get Started

git clone https://github.com/infinistor/ifsmoverrest.git

How to Build

Maven 설치

Maven이 설치되어 있는지 확인해야 합니다.
mvn -v 로 설치되어 있는지 확인하세요.
설치가 되어 있지 않으면 다음 명령어로 설치를 해야 합니다.
sudo apt install maven

Build

pom.xml 파일이 있는 위치에서 mvn package 명령어를 입력하시면 빌드가 되고, 빌드가 완료되면 target이라는 폴더에 ifsmoverRest.jar가 생성됩니다.

How to Use (빌드한 경우)

ifsmoverRest를 실행시키기 위하여 필요한 파일은 4개입니다.
target/ifsmoverRest.jar - 소스 빌드 후, 생성된 실행 파일
script/ifsmoverRest.sh - ifsmoverRest.jar를 실행시켜 주는 스크립트
script/ifsmoverRest.conf - ifsmoverRest.jar의 config 파일
script/ifsmoverRestLog.xml - log 관련 설정
4개의 파일을 실행시킬 위치에 복사합니다.
target/ifsmoverRest.jar -> 실행시킬 위치/lib/ifsmoverRest.jar
script/ifsmoverRest.sh -> 실행시킬 위치/lib/ifsmoverRest.sh
script/ifsmoverRest.conf -> 실행시킬 위치/etc/ifsmoverRest.conf
script/ifsmoverRestLog.xml -> 실행시킬 위치/etc/ifsmoverRestLog.xml
ifsmoverRest.sh의 실행 권한을 확인합니다.
ifsmoverRest.sh의 실행 권한이 없는 경우 실행권한을 부여합니다.
chmod +x ifsmoverRest.sh
실행시킬 위치/etc/ifsmoverRest.conf에 ifsmoverRest 설정 정보를 입력합니다.

endpoint=http://0.0.0.0:7123   // ifsmoverRest Server가 사용할 http port number
secure-endpoint=https://0.0.0.0:7333    // ifsmverRest Server가 사용할 https port number
keystore-path=  // 인증서 위치, ** 인증서는 .jks만 지원합니다.
keystore-passwords= // 인증서 암호
ifsmover_path=/usr/local/pspace/bin/ifsmover-0.2.6  // ifsmover가 설지된 디렉토리
db_repository=mariadb   // [sqlite, mariadb] *주의 ifsmover와 설정이 같아야 합니다.
db_host=    // mariadb 시, host ip
db_name=    // mariadb 시, database name
db_port=    // mariadb 시, port
db_user=    // mariadb 시, user name
db_password=    // mariadb 시, user passwords
db_pool_size=5  // mariadb 시, connection pool size

ifsmoverRest.sh를 실행합니다.
./ifsmoverRest.sh

How to Use (배포판의 경우)

아래 배포판 페이지의 "Asset" 항목을 펼쳐서 ifsmoverRest-x.x.x.tar.gz 파일 링크를 미리 복사하세요.
- 배포판 페이지 : https://github.com/infinistor/ifsmoverrest/releases
배포판을 다운로드하고 압축을 풀어 설치합니다.

# mkdir /usr/local/pspace
# mkdir /usr/local/pspace/bin
# cd /usr/local/pspace/bin
# wget "https://github.com/infinistor/ifsmover/releases/download/v0.x.x/ifsmoverRest-0.x.x.tar.gz"
# tar -xvf ifsmoverRest-0.x.x.tar.gz
# mv ifsmoverRest-0.x.x ifsmoverRest

설치 경로로 이동합니다.
cd /usr/local/pspace/bin/ifsmoverRest
/usr/local/pspace/bin/ifsmoverRest/etc/ifsmoverRest.conf에 ifsmoverRest 설정 정보를 입력합니다.

endpoint=http://0.0.0.0:7123   // ifsmoverRest Server가 사용할 http port number
secure-endpoint=https://0.0.0.0:7333    // ifsmverRest Server가 사용할 https port number
keystore-path=  // 인증서 위치, ** 인증서는 .jks만 지원합니다.
keystore-passwords= // 인증서 암호
ifsmover_path=/usr/local/pspace/bin/ifsmover-0.2.6  // ifsmover가 설지된 디렉토리

ifsmoverRest.sh를 실행합니다.
./ifsmoverRest.sh

Name		Name	Last commit message	Last commit date
Latest commit History 49 Commits
src		src
LICENSE		LICENSE
README.md		README.md
pom.xml		pom.xml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

IfsMoverRest

개요

용도

전제 조건

API

Check

Start

Stop

Rerun

Remove

Status

구동 환경

How to Get Started

How to Build

Maven 설치

Build

How to Use (빌드한 경우)

How to Use (배포판의 경우)

About

Releases 4

Packages

Contributors 2

Languages

License

infinistor/ifsmoverrest

Folders and files

Latest commit

History

Repository files navigation

IfsMoverRest

개요

용도

전제 조건

API

Check

Start

Stop

Rerun

Remove

Status

구동 환경

How to Get Started

How to Build

Maven 설치

Build

How to Use (빌드한 경우)

How to Use (배포판의 경우)

About

Resources

License

Stars

Watchers

Forks

Releases 4

Packages 0

Contributors 2

Languages

Packages