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.

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 Range The list contains 0 to 100 items. Default value N/A
parent_id	No	String	Definition Parent node ID. Constraints N/A 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 Range The value is a string. It contains 1 to 50 characters. Default value N/A
code	No	String	Definition Application code. Constraints N/A 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 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 Range The value can be customized. The value range is 1 to 500. Default value N/A
page_no	No	Integer	Definition Page number. Constraints N/A Range N/A Default value N/A
is_collection	No	Boolean	Definition Whether to add it to favorites. Constraints N/A Range true: The application is added to favorites and can be viewed in my favorites. false: The application 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 Range true: root application false: non-root application Default value N/A
offset	No	String	Definition Offset from which the query starts. Constraints N/A 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 Application list. Range N/A

**Table 3** data
Parameter	Type	Description
id	String	Definition Application ID. Range N/A
name	String	Definition Application name. Range The value can contain 3 to 50 characters, including letters, digits, hyphens (-), and underscores (_).
code	String	Definition Application code. Range N/A
domain_id	String	Definition Tenant ID. Range N/A
parent_id	String	Definition Parent node ID. Range N/A
description	String	Definition Description. Range N/A
path	String	Definition Application path. Range The value is a combination of application IDs.
is_collection	Boolean	Definition Whether an application is added to favorites. Range true: The application is added to favorites. false: The application is not added to favorites.
create_time	String	Definition Creation time. The value is in the ISO 8601 format. Range N/A
update_time	String	Definition Modification time. The value is in the ISO 8601 format. 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"
  } ]
}