GetApp

Queries a public or private App resource.

Request

GET /apps/{AppName}?Scope={Scope}

Parameter description

Parameter	Type	Required	Description
AppName	String	Yes	Name of the App
Scope	String	No	Optional values include Public and Private.If the value is Public, public Apps are queried. If the value is Private or not specified, private Apps are queried.

Response

Response status code

Response body

{
    "Name": string,
    "Description": string,
    "CreationTime": string,
    "InputParameters": {
        string: {
            "Description": string,
            "Type": string,
            "Default": string
        },
        ...
    },
    "OutputParameters": {
        string: {
            "Description": string,
            "Type": string
        },
        ...
    },
    "Config": {
        "ResourceType": {
            "Description": string,
            "Default": string,
            "Overwritable": boolean
        },
        "InstanceType": {
            "Description": string,
            "Default": string,
            "Overwritable": boolean
        },
        "InstanceCount": {
            "Description": string,
            "Default": number,
            "Overwritable": boolean
        },
        "MinDiskSize": {
            "Description": string,
            "Default": number,
            "Overwritable": boolean
        },
        "DiskType": {
            "Description": string,
            "Default": string,
            "Overwritable": boolean
        },
        "MaxRetryCount": {
            "Description": string,
            "Default": number,
            "Overwritable": boolean
        },
        "Timeout": {
            "Description": string,
            "Default": number,
            "Overwritable": boolean
        }
    }
}

Response parameters

Attribute	Type	Description
Name	string	Name of the App
Description	String	Detailed description about the App
CreationTime	string	Resource creation time
InputParameters	map	Input parameter list of the App
OutputParameters	map	Output parameter list of the App
Config	object(Config)	Runtime parameters when the job is submitted

InputParameter

Attribute	Type	Description
Description	String	Parameter description
Type	String	Parameter type
Default	String	Default value of the parameter

OutputParameter

Attribute	Type	Description
Description	String	Parameter description
Type	String	Parameter type

Config

Attribute	Type	Description
ResourceType	object(ResourceType)	Resource type
InstanceType	object(InstanceType)	Instance type
InstanceCount	object(InstanceCount)	Number of instances
MinDiskSize	object(MinDiskSize)	Minimum disk size (GB)
DiskType	object(DiskType)	Disk type
MaxRetryCount	object(MaxRetryCount)	Maximum number of retries after an instance fails
Timeout	object(Timeout)	Timeout of an instance, in seconds

ResourceType

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	String	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

InstanceType

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	String	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

InstanceCount

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	Number	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

MinDiskSize

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	Number	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

DiskType

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	String	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

MaxRetryCount

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	Number	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

Timeout

Attribute	Type	Description
Description	String	Detailed description provided for App users
Default	Number	Default value of the parameter
Overwritable	Boolean	Specifies whether the default value can be overwritten when a user uses this App to submit a job.

Examples

Request:

GET /apps/myapp?Scope=Public HTTP/1.1

Response:

HTTP/1.1 200 OK
{
    "Config": {
        "DiskType": {
            "Default": "cloud_efficiency",
            "Description": "",
            "Overwritable": true},
        "InstanceCount": {
            "Default": 1,
            "Description": "",
            "Overwritable": true},
        "InstanceType": {
            "Default": "",
            "Description": "",
            "Overwritable": true},
        "MaxRetryCount": {
            "Default": 0,
            "Description": "",
            "Overwritable": true},
        "MinDiskSize": {
            "Default": 40,
            "Description": "",
            "Overwritable": true},
        "ResourceType": {
            "Default": "OnDemand",
            "Description": "",
            "Overwritable": true},
        "Timeout": {
            "Default": 86400,
            "Description": "",
            "Overwritable": true}},
    "CreationTime": "2017-08-14T07:10:41.281465Z",
    "Description": "app description",
    "InputParameters": {
        "inputFile": {
            "Default": null,
            "Description": "",
            "Type": "String"}},
    "Name": "myapp",
    "OutputParameters": {
        "outputFile": {
            "Description": "",
            "Type": "String"}},
    "OwnerId": 123456}