Querying an Application

Function

This API is used to query applications.

Application information is displayed on the Overview page to improve O&M efficiency.

The request parameter limit (number of records) is mandatory. The maximum number of records that can be queried at a time is 500.

The returned information includes the application ID, application name, application code, application description, tenant ID, parent node ID, application layer path, and whether the application is added to favorites.

Authorization Information

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

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
coc:application:list	List	application *	-	-	-

URI

GET /v1/applications

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
id_list	No	Array of strings	Definition: List of application IDs. Constraints: N/A Value range: The list contains 0 to 100 items. Default value: N/A
parent_id	No	String	Definition: Parent node ID Constraints: N/A Value range: If you query the projects created by yourself, the project ID of the region is returned. Default value: N/A
name_like	No	String	Definition: Application name. Fuzzy match by application name is supported. Constraints: N/A Value range: The value contains 1 to 50 characters. Default value: N/A
code	No	String	Definition: Application code Constraints: N/A Value range: The value is a string. It contains 3 to 50 characters. Default value: N/A
marker	No	String	Definition: Pagination query parameter, which is the last ID of the request on the previous page. Constraints: N/A Value range: The value is a string. It contains 24 characters. Default value: N/A
limit	Yes	Integer	Definition: Number of items displayed on each page when the pagination query is performed. Constraints: N/A Value range: It is user-defined. The value ranges from 1 to 500. Default value: N/A
page_no	No	Integer	Definition: Page number. Constraints: N/A Value range: N/A Default value: N/A
is_collection	No	Boolean	Definition: Whether to add it to favorites. Constraints: N/A Value range: true: The application is successfully added to favorites and can be viewed in my favorites. false:It is not added to favorites. Default value: By default, it is not added to favorites.
is_root	No	Boolean	Definition: Whether the application is a root application. Constraints: N/A Value range: true: root application false: non-root application Default value: N/A
offset	No	String	Definition: Offset for pagination query, indicating that the query starts from this offset. Constraints: N/A Value range: 0 to 2147483647 Default value: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
data	Array of data objects	Definition: Applications. Value Range: N/A

**Table 3** data
Parameter	Type	Description
id	String	Definition: Application ID Value Range: N/A
name	String	Definition: Application name. Value Range: The value can contain 3 to 50 characters, including letters, digits, hyphens (-), and underscores (_).
code	String	Definition: App code. Value Range: N/A
domain_id	String	Definition: Tenant ID. Value Range: N/A
parent_id	String	Definition: Parent node ID. Value Range: N/A
description	String	Definition: Description. Value Range: N/A
path	String	Definition: Application path. Value Range: The value is combined by the application ID using a period (.).
is_collection	Boolean	Definition: Whether an application is added to favorites. Value Range: true: The content is successfully added to favorites. False: The program is not added to favorites.
create_time	String	Definition: Creation time. The value is in the ISO 8601 format. Value Range: N/A
update_time	String	Definition: Modification time. The value is in the ISO 8601 format. Value Range: N/A

Example Requests

The following uses a region as an example to describe how to query details about an application in the region.

GET https://{endpoint}/v1/applications?id_list={id_list}&parent_id={parent_id}&name_like={name_like}&code={code}&marker={marker}&limit={limit}

{
  "id_list" : [ 1, 2 ],
  "name_like" : "coc",
  "limit" : 200
}

Example Responses

Status code: 200

Application list details.

{
  "data" : [ {
    "id" : "64898bf60224b9730ccb577f",
    "name" : "testApplication",
    "code" : "testApplication",
    "description" : "dfdfdfd66",
    "domain_id" : "dc2d76541f754d68a4c8d150262d92c2",
    "parent_id" : null,
    "path" : "64898bf60224b9730ccb577f",
    "is_collection" : null,
    "create_time" : "2023-06-14T09:44:22.116+00:00",
    "update_time" : "2025-01-21T03:51:02.767+00:00"
  } ]
}