Updated on 2024-06-14 GMT+08:00

Obtaining All Applications

Function

This API is used to obtain all created applications.

URI

GET /v2/{project_id}/cas/applications

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Number of records to be displayed. The value is 1000 or ranges from 0 to 100. If the specified value is not within the range, value 10 is assigned. In the non-pagination scenario, the value is 1000. In the pagination scenario, the value ranges from 0 to 100.

offset

No

String

Offset, which indicates the result after the Nth data record is queried.

order_by

No

String

Sorting field. By default, query results are sorted by creation time.

Enumerated values: create_time, name, and update_time. If the transferred value is not within the supported enumerated value range, the default sorting field is used.

order

No

String

Sorting order.

  • desc (default)
  • asc

Request

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type or format.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Response

Table 4 Response parameters

Parameter

Type

Description

count

Integer

Total number of applications.

applications

Array of objects

Application information. See Table 5.

Table 5 applications parameters

Parameter

Type

Description

id

String

Application ID.

name

String

Application name.

description

String

Application description.

creator

String

Creator.

project_id

String

Project ID.

enterprise_project_id

String

Enterprise project ID.

create_time

Integer

Creation time.

update_time

Integer

Update time.

unified_model

String

Whether to enable the unified model. Default value: null.

component_count

Integer

Number of components.

Example Request

None

Example Response

{
	"count": 1,
	"applications": [
		{
			"id": "e5213b62-0e3c-476f-9960-3e4108787350",
			"name": "app-xpmtii",
			"description": "test",
			"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
			"enterprise_project_id": "0",
			"creator": "ss-test",
			"create_time": 1610432385245,
			"update_time": 1610432385245,
			"unified_model": null,
			"component_count": 0
		}
	]
}

Status Code

Table 6 Status codes

HTTP Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.