edit-icon download-icon

View application list

Last Updated: Jan 09, 2018

Description

View the list of all your created applications in a 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 The application name.
services boolean No Whether or not includes the application service information. The default value is true.
containers boolean No Whether or not includes the service container information. 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 The application name.
description string The application description.
template string The application Compose template.
version string The application version.
created datetime The created time of the application.
updated datetime The updated time of the application.
desired_state string The expected status (if the current status is the intermediate status, the expected status indicates the final status of the change).
current_state string The current status.
environment map The environment variable key/value.
services array The service list.

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.