Querying the List of Application, Component, and Group Names

Function

This API is used to search for applications, sub-applications, components, and groups by name.

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/application-view/search

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
name_like	No	String	Definition: Fuzzy match by name is supported. Constraints: N/A Value range: N/A Default value: N/A
code_list	No	Array of strings	Definition: Application, component, and group code. Constraints: N/A Value range: N/A 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: N/A 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: Query applications, components, and groups in my favorites. The default value is true. false: (Optional) Query applications, components, and groups from all applications. Default value: By default, it is not added to favorites.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
data	Array of data objects	Query the list of application, component, and group names.

**Table 3** data
Parameter	Type	Description
id	String	Definition: UUID allocated by CloudCMDB. Value Range: N/A
name	String	Definition: Name of an application, group, or component. Value Range: The value is a string. It can contain 3 to 50 characters.
code	String	Definition: Application, group, or component code. Value Range: The value is a string. It can contain 3 to 50 characters.
type	String	Definition: component: component application: application group: Value Range: N/A
parent_id	String	Definition: Parent node ID, that is, the parent node ID of the path where the query result is located. Value Range: The value is a string with 24 characters.
component_id	String	Definition: Component ID. Value Range: The value is a string of 24 characters.
application_id	String	Definition: Application ID Value Range: The value is a string with 24 characters.
path	String	Definition: Path of the node, which consists of the application, component, and group IDs. Value Range: N/A
vendor	String	Definition: Cloud vendor information. Value Range: RMS: Huawei Cloud ALI: Alibaba Cloud vendor OTHER: other vendors
related_domain_id	String	Definition: ID of the domain to which the cross-account resource belongs. Value Range: N/A

Example Requests

This API is used to query the list of applications, components, and group names.

GET https://{Endpoint}/v1/application-view/search?limit=120&name_like=6690f166b78301337589c28c&is_collection=true

Example Responses

Status code: 200

The application, component, and group names are queried.

{
  "data" : [ {
    "id" : "6863870e521f2d5e06e41deb",
    "name" : "test component_test55",
    "code" : "6863870e521f2d5e06e41deb",
    "type" : "component",
    "parent_id" : "686386a9521f2d5e06e41de8",
    "path" : "686386a9521f2d5e06e41de8.6863870e521f2d5e06e41deb",
    "component_id" : null,
    "application_id" : "686386a9521f2d5e06e41de8",
    "vendor" : null,
    "related_domain_id" : null
  } ]
}