View applications

Last Updated: Dec 07, 2017

Description

List applications in the container cluster.

Request information

Request line (RequestLine)

  1. GET /projects/ HTTP/1.1

Request line parameter (URI Param)

Name Type Required? Description
q string No Application name.
services boolean No Includes service information or not. The default value is true.
containers boolean No Includes service container information or not. The default value is true.

Special request header (RequestHead)

None

Request body (RequestBody)

None

Response information

Response line (ResponseLine)

  1. HTTP/1.1 200 OK

Special response header (ResponseHead)

None

Response body (ResponseBody)

  1. [
  2. {
  3. "name": "string",
  4. "description": "string",
  5. "template": "string",
  6. "version": "string",
  7. "created": "datetime",
  8. "updated": "datetime",
  9. "desired_state": "string",
  10. "current_state": "string",
  11. "environment": {
  12. "key": "value",
  13. ...
  14. }
  15. "services": [
  16. ...
  17. ]
  18. }
  19. ]

Response body explanation

Project format

Name Type Description
name string Name
description string Description
template string Docker Compose template
version string Applicaiton version
created datetime Creation time
updated datetime Update time
desired_state string Expected state
current_state string Current state
environment map Key/value of environment variable
services array List of services

Example

Request example

  1. GET /projects HTTP/1.1

Return example

  1. HTTP/1.1 200 OK
  2. Content-Type:application/json;charset=UTF-8
  3. [
  4. {
  5. "name": "test",
  6. "description": "This is a test application",
  7. "template": "...",
  8. "version": "1.0",
  9. "environment": {
  10. "COMPOSE_PROJECT_NAME": "test"
  11. },
  12. "created": "2016-02-02T07:45:13.113833319Z",
  13. "updated": "2016-02-02T07:45:16.03142154Z",
  14. "desired_state": "running",
  15. "current_state": "running",
  16. "services": [
  17. ...
  18. ]
  19. },
  20. ...
  21. ]
Thank you! We've received your feedback.