All Products
Search
Document Center

GetAppDetail

Last Updated: May 11, 2018

Description

Queries information about a specific version of a private App resource, including parameters and command lines.

Request

  1. GET /apps/{AppName}?Detail=True&Qualifier={Qualifier}

Parameter description

Parameter Type Required Description
AppName String Yes Name of the App
Qualifier String No Alias or version number of the App.If this parameter is not specified, the information about the latest version is queried.

Response

Response status code

  1. HTTP/1.1 200 OK

Response body

  1. {
  2. "Name": string,
  3. "Description": string,
  4. "InputParameters": {
  5. string: {
  6. "Description": string,
  7. "Type": string,
  8. "Default": string,
  9. "LocalPath": string
  10. },
  11. ...
  12. },
  13. "OutputParameters": {
  14. string: {
  15. "Description": string,
  16. "Type": string,
  17. "LocalPath": string
  18. },
  19. ...
  20. },
  21. // begin union
  22. // only one of the following can be specified:
  23. "Docker": {
  24. "Image": string,
  25. "RegistryOSSPath": string
  26. },
  27. "VM": {
  28. "ECSImageId": string
  29. },
  30. // end union
  31. "CommandLine": string,
  32. "EnvVars": {
  33. string: string,
  34. ...
  35. },
  36. "Daemonize": boolean,
  37. "Config": {
  38. "ResourceType": {
  39. "Description": string,
  40. "Default": string,
  41. "Overwritable": boolean
  42. },
  43. "InstanceType": {
  44. "Description": string,
  45. "Default": string,
  46. "Overwritable": boolean
  47. },
  48. "InstanceCount": {
  49. "Description": string,
  50. "Default": number,
  51. "Overwritable": boolean
  52. },
  53. "MinDiskSize": {
  54. "Description": string,
  55. "Default": number,
  56. "Overwritable": boolean
  57. },
  58. "DiskType": {
  59. "Description": string,
  60. "Default": string,
  61. "Overwritable": boolean
  62. },
  63. "MaxRetryCount": {
  64. "Description": string,
  65. "Default": number,
  66. "Overwritable": boolean
  67. },
  68. "Timeout": {
  69. "Description": string,
  70. "Default": number,
  71. "Overwritable": boolean
  72. }
  73. }
  74. }

Response parameters

Attribute Type Description
Name string Name of the App
Description String Detailed description about the App
InputParameters map Input parameter list of the App
OutputParameters map Output parameter list of the App
Docker object(Docker) Configuration related to the Docker image
VM object(VM) Configuration related to the ECS instance
CommandLine String Command line used to run the App
EnvVars map Environmental variable
Daemonize boolean Whether to restart when the App is executed
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
LocalPath String If LocalPath is not empty, the parameter specifies a file or directory in the OSS.During compute analysis, the system maps the OSS file or directory specified by this parameter to a file or directory specified by LocalPath.It supports only UTF-8 encoding. If LocalPath is a directory, it must end with a slash (/).

OutputParameter

Attribute Type Description
Description String Parameter description
Type String Parameter type
LocalPath String If LocalPath is not empty, the parameter specifies a file or directory in the OSS.During compute analysis, the system maps the file or directory specified by LocalPath to a file or directory specified by this parameter.It supports only UTF-8 encoding.If LocalPath is a directory, it must end with a slash (/).

Docker

Attribute Type Description
Image String Docker image
RegistryOSSPath String Root directory of the Docker registry storage in the OSS

VM

Attribute Type Description
ECSImageId String ECS image ID

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 example

  1. GET /apps/myapp?Detail=True&Qualifier=1 HTTP/1.1

Response example

  1. HTTP/1.1 200 OK
  2. {
  3. "CommandLine": "cat ${inputFile} > ${outputFile} ",
  4. "Config": {
  5. "DiskType": {
  6. "Default": "cloud_efficiency",
  7. "Description": "",
  8. "Overwritable": true},
  9. "InstanceCount": {
  10. "Default": 1,
  11. "Description": "",
  12. "Overwritable": true},
  13. "InstanceType": {
  14. "Default": "",
  15. "Description": "",
  16. "Overwritable": true},
  17. "MaxRetryCount": {
  18. "Default": 0,
  19. "Description": "",
  20. "Overwritable": true},
  21. "MinDiskSize": {
  22. "Default": 40,
  23. "Description": "",
  24. "Overwritable": true},
  25. "ResourceType": {
  26. "Default": "OnDemand",
  27. "Description": "",
  28. "Overwritable": true},
  29. "Timeout": {
  30. "Default": 86400,
  31. "Description": "",
  32. "Overwritable": true}},
  33. "Daemonize": false,
  34. "Description": "app description",
  35. "Docker": {
  36. "Image": "myimage",
  37. "RegistryOSSPath": "oss://bucket/registry"},
  38. "EnvVars": {},
  39. "InputParameters": {
  40. "inputFile": {
  41. "Default": null,
  42. "Description": "",
  43. "LocalPath": "/tmp/inputFile",
  44. "Type": "String"}},
  45. "Name": "myapp",
  46. "OutputParameters": {
  47. "outputFile": {
  48. "Description": "",
  49. "LocalPath": "/tmp/outputFile",
  50. "Type": "String"}}}