prosEO Facility Manager REST Services API API documentation

/facilities

/facilities get post

get

Get processing facilities by mission and facility name

post

Create a new processing facility

Get processing facilities by mission and facility name

Request
Response

Query Parameters

name: (string)
The processing facility name (unique key)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: RestProcessingFacility

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

[
    {
        "name": "PF1",
        "description": "Processing Facility 1",
        "facilityState": "RUNNING",
        "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
        "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
        "maxJobsPerNode": 4,
        "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
        "externalStorageManagerUrl": "http://prip1.proseo-domain.de/proseo/storage-mgr/v0.1",
        "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
        "storageManagerUser": "smuser1",
        "storageManagerPassword": "smpwd1-but-that-would-be-way-too-short",
        "defaultStorageType": "S3"
    },
    {
        "name": "PF2",
        "description": "Processing Facility 2",
        "facilityState": "DISABLED",
        "processingEngineUrl": "https://procfac2.proseo-domain.de/kubernetes",
        "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…y0-xUBMA7kJqHrdXRWtaUyFN7w",
        "storageManagerUrl": "http://procfac2.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v1.1",
        "externalStorageManagerUrl": "http://prip2.proseo-domain.de/proseo/storage-mgr/v0.1",
        "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v1.1",
        "storageManagerUser": "smuser2",
        "storageManagerPassword": "smpwd2-but-that-would-be-way-too-short",
        "defaultStorageType": "S3"
    }
]

HTTP status code 400

The request sent to the server contains data which is not as expected e.g. invalid location URI

Headers

Warning: required(string - pattern: ^\d{3} proseo-facmgr $.\d+$ .+$)
An error code and a plain text error message
Example:
```
199 proseo-facmgr (E1005) Facility ID not set
```

HTTP status code 404

The requested resource was not found

Headers

Warning: required(string - pattern: ^\d{3} proseo-facmgr $.\d+$ .+$)
An error code and a plain text error message
Example:
```
199 proseo-facmgr (E1005) Facility ID not set
```

Create a new processing facility

Request
Response

Body

Media type: application/json

Type: object

Properties

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

/facilities/{id} get patch delete

get

Get a processing facility by ID

patch

Update a processing facility by ID

delete

Delete a processing facility by ID

Get a processing facility by ID

Request
Response

URI Parameters

id: required(integer)
The persistent id of this object

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

Update a processing facility by ID

Request
Response

URI Parameters

id: required(integer)
The persistent id of this object

Body

Media type: application/json

Type: object

Properties

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

HTTP status code 304

Body

Media type: application/json

Type: object

Properties

id: (integer - default: 0)
The persistent id of this object
version: (integer - default: 1)
A version identifier to track updates to the object (especially to detect concurrent update attempts)
name: required(string)
The facility name (unique key)
facilityState: required(string - default: DISABLED)
The run state the facility currently is in, one of { DISABLED, STOPPED, STARTING, RUNNING, STOPPING }
description: (string)
A short description of the processing facility
processingEngineUrl: (string)
The URL to access this facility's processing engine (Kubernetes instance)
processingEngineToken: (string)
Authentication token for connecting to this facility's processing engine (Kubernetes instance)
maxJobsPerNode: (integer - default: 1)
Maximum number of jobs schedulable per worker node (default 1)
storageManagerUrl: required(string)
The URL to access this facility's storage manager from the control instance
externalStorageManagerUrl: required(string)
The URL to access this facility's storage manager from an external client (via PRIP API)
localStorageManagerUrl: (string)
URL of the locally accessible Storage Manager
storageManagerUser: required(string)
User name for connecting to the Storage Manager (locally and from external services)
storageManagerPassword: required(string)
Password for connecting to the Storage Manager (locally and from external services)
defaultStorageType: required(string - pattern: ^(S3|ALLUXIO|POSIX|OTHER)$)
The type of the storage

Example:

{
    "name": "Test",
    "description": "Processing Facility 1",
    "facilityState": "RUNNING",
    "processingEngineUrl": "https://procfac1.proseo-domain.de/kubernetes",
    "processingEngineToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlBpM…jjzckxFyH9d8ggu-EYFJWLFY5g",
    "storageManagerUrl": "http://procfac1.proseo-domain.de/api/v1/namespaces/default/services/storage-mgr-service:service/proxy/proseo/storage-mgr/v0.1",
    "externalStorageManagerUrl": "http://prip.proseo-domain.de/proseo/storage-mgr/v0.1",
    "localStorageManagerUrl": "https://%NODE_IP%:30001/proseo/storage-mgr/v0.1",
    "storageManagerUser": "smuser",
    "storageManagerPassword": "smpwd-but-that-would-be-way-too-short",
    "defaultStorageType": "S3"
}

prosEO Facility Manager REST Services API API documentation version v0.1

/facilities

/facilities get post

get /facilities

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Headers

HTTP status code 404

Headers

post /facilities

Body

HTTP status code 201

Body

/facilities/{id} get patch delete

get /facilities/{id}

URI Parameters

HTTP status code 200

Body

patch /facilities/{id}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 304

Body

delete /facilities/{id}

URI Parameters

HTTP status code 204