All Products
Search
Document Center

GetApp

Last Updated: May 11, 2018

GetApp

Queries a public or private App resource.

Request

  1. 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

  1. 200

Response body

  1. {
  2. "Name": string,
  3. "Description": string,
  4. "CreationTime": string,
  5. "InputParameters": {
  6. string: {
  7. "Description": string,
  8. "Type": string,
  9. "Default": string
  10. },
  11. ...
  12. },
  13. "OutputParameters": {
  14. string: {
  15. "Description": string,
  16. "Type": string
  17. },
  18. ...
  19. },
  20. "Config": {
  21. "ResourceType": {
  22. "Description": string,
  23. "Default": string,
  24. "Overwritable": boolean
  25. },
  26. "InstanceType": {
  27. "Description": string,
  28. "Default": string,
  29. "Overwritable": boolean
  30. },
  31. "InstanceCount": {
  32. "Description": string,
  33. "Default": number,
  34. "Overwritable": boolean
  35. },
  36. "MinDiskSize": {
  37. "Description": string,
  38. "Default": number,
  39. "Overwritable": boolean
  40. },
  41. "DiskType": {
  42. "Description": string,
  43. "Default": string,
  44. "Overwritable": boolean
  45. },
  46. "MaxRetryCount": {
  47. "Description": string,
  48. "Default": number,
  49. "Overwritable": boolean
  50. },
  51. "Timeout": {
  52. "Description": string,
  53. "Default": number,
  54. "Overwritable": boolean
  55. }
  56. }
  57. }

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:

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

Response:

  1. HTTP/1.1 200 OK
  2. {
  3. "Config": {
  4. "DiskType": {
  5. "Default": "cloud_efficiency",
  6. "Description": "",
  7. "Overwritable": true},
  8. "InstanceCount": {
  9. "Default": 1,
  10. "Description": "",
  11. "Overwritable": true},
  12. "InstanceType": {
  13. "Default": "",
  14. "Description": "",
  15. "Overwritable": true},
  16. "MaxRetryCount": {
  17. "Default": 0,
  18. "Description": "",
  19. "Overwritable": true},
  20. "MinDiskSize": {
  21. "Default": 40,
  22. "Description": "",
  23. "Overwritable": true},
  24. "ResourceType": {
  25. "Default": "OnDemand",
  26. "Description": "",
  27. "Overwritable": true},
  28. "Timeout": {
  29. "Default": 86400,
  30. "Description": "",
  31. "Overwritable": true}},
  32. "CreationTime": "2017-08-14T07:10:41.281465Z",
  33. "Description": "app description",
  34. "InputParameters": {
  35. "inputFile": {
  36. "Default": null,
  37. "Description": "",
  38. "Type": "String"}},
  39. "Name": "myapp",
  40. "OutputParameters": {
  41. "outputFile": {
  42. "Description": "",
  43. "Type": "String"}},
  44. "OwnerId": 123456}