All Products
Search
Document Center

ListApps

Last Updated: May 11, 2018

Description

Lists Apps, including public and private Apps.

Request

  1. GET /apps?Scope={Scope}&Marker={Marker}&MaxItemCount={MaxItemCount}

Request parameters

Query Parameters

Parameter Type Required or not Description
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.
Marker String No Marker used for paging query.Default value: null
MaxItemCount Number No Maximum number of items queried this time.It must be an integer between 1 and 100.Default value: 50

Response

Response Status Code

  1. HTTP/1.1 200 OK

Response Body

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

Response parameters

Attribute Type Description
Items object(App)[] List of resources that meet the query conditions
NextMarker String No Marker used for the next paging query

App

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

OutputParameter

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

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?Scope=Public HTTP/1.1

Response example

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