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.
URI
GET /v1/application-view/search
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name_like |
No |
String |
Definition Fuzzy match by name is supported. Constraints N/A Range N/A Default value N/A |
|
code_list |
No |
Array of strings |
Definition Application, component, and group code. Constraints N/A 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 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 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
Default value By default, it is not added to favorites. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
data |
Array of data objects |
Query the list of application, component, and group names. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Definition UUID allocated by CloudCMDB Range N/A |
|
name |
String |
Definition Name of an application, group, or component. Range The value is a string. It contains 3 to 50 characters. |
|
code |
String |
Definition Code of an application, group, or component. Range The value is a string. It contains 3 to 50 characters. |
|
type |
String |
Definition
Range N/A |
|
parent_id |
String |
Definition Parent node ID, that is, the ID of the parent node of the path where the query result is located. Range The value is a string. It contains 24 characters. |
|
component_id |
String |
Definition Component ID. Range The value is a string. It contains 24 characters. |
|
application_id |
String |
Definition Application ID. Range The value is a string. It contains 24 characters. |
|
path |
String |
Definition Path of the node, which consists of the IDs of the application, component, and group. Range N/A |
|
vendor |
String |
Definition Cloud vendor information. Range
|
|
related_domain_id |
String |
Definition ID of the domain to which the cross-account resource belongs. Range N/A |
Example Requests
Query the list of application, component, 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
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The application, component, and group names are queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot