Obtaining All Applications

Function

This API is used to obtain all created applications.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permission listed below is required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

servicestage:app:listApplication

list

-

-

servicestage:app:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:app:listApplication	list	-	-	servicestage:app:list	-

URI

GET /v3/{project_id}/cas/applications

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of query results. Constraints N/A Range 1~100 Default Value 10
offset	No	Integer	Definition Query offset, which indicates the result after the Nth data record is queried. Constraints N/A Range N/A Default Value 0
order_by	No	String	Definition Sorting field. Constraints N/A Range Numerated values: create_time: application creation time. name: application name. update_time: application modification time. If the transferred value is not within the supported enumerated value range, the default sorting field is used. Default Value create_time
order	No	String	Definition Sorting order. Constraints N/A Range desc: descending order asc: ascending order Default Value desc

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A
X-Auth-Token	Yes	String	Definition 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 the token, see Authentication. Constraints N/A Range N/A Default Value N/A

Response

**Table 4** Response parameters
Parameter	Type	Description
count	Integer	Definition Total number of applications. Range N/A
applications	Array of objects	Definition Application information. See Table 5.

**Table 5** applications
Parameter	Type	Description
id	String	Definition Application ID. Range N/A
name	String	Definition Application name. Range N/A
description	String	Definition Application description. Range N/A
creator	String	Definition Application creator. Range N/A
project_id	String	Definition Project ID. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
create_time	Integer	Definition Application creation time. Range N/A
update_time	Integer	Definition Application update time. Range N/A
component_count	Integer	Definition Number of components deployed in an application. Range N/A
labels	Array of objects	Definition Label. You can use TMS to filter resources by labels. See Table 6.

**Table 6** labels
Parameter	Type	Description
key	String	Definition Label name. Range N/A
value	String	Definition Label value. Range N/A

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

Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

Error Code

See ServiceStage Error Codes.

Parent topic: Application

Previous topic: Creating an Application

Next topic: Modifying Application Information Based on the Application ID