Updated on 2023-07-19 GMT+08:00

Obtaining All Applications

Function

This API is used to obtain all created applications.

URI

GET /v3/{project_id}/cas/applications

Table 1 Path parameter

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

integer

Number of records to be queried. Value range: 0–100.

offset

No

intege

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 object

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.

component_count

Integer

Number of components.

labels

Array of objects

Label. You can use TMS to filter resources by labels. See Table 6.

Table 6 labels parameters

Parameter

Type

Description

key

String

Label name.

value

String

Label value.

Example Request

None

Example Response

{
    "count": 1,
    "applications": [
        {
            "id": "dae29983-c1e9-437d-a6be-5256076fe605",
            "name": "app-xpmtii",
            "description": "test",
            "project_id": "063a3158b1a34710b36ad208b9497d00",
            "enterprise_project_id": "0",
            "creator": "ss-test",
            "create_time": 1679468852302,
            "update_time": 1679468852302,
            "labels": [
                {
                    "key": "key",
                    "value": "var"
                }
            ],
            "component_count": 0
        }
    ]
}

Status Code

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