Querying the Microservice List

Function

This API is used to query the microservice list.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{cloudProjectId}/component/list/query

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
cloudProjectId	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Definition: Offset where the query starts. Constraints: N/A Value range: The offset value must be no less than 0. Default value: N/A
limit	Yes	Integer	Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A
name	No	String	Definition: Microservice name. Constraints: N/A Value range: N/A Default value: N/A
sort_dir	No	String	Definition: Sorting direction. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
data	Array of ComponentVO objects	Definition: Data details. Value range: N/A
total	Integer	Definition: Total number of records. Value range: N/A

**Table 4** ComponentVO
Parameter	Type	Description
id	String	Definition: Microservice ID. Value range: The value consists of 32 characters, including digits and letters.
name	String	Definition: Microservice name. Value range: N/A
type	String	Definition: Microservice type. Value range: N/A
description	String	Definition: Microservice description. Value range: N/A
status	String	Definition: Microservice status. Value range: N/A
parent_id	String	Definition: Parent ID. Value range: N/A
cloud_project_id	String	Definition: Project ID. Value range: The value consists of 32 characters, including digits and letters.
repos	Array of ComponentRepoVO objects	Definition: Microservice code repository. Value range: N/A
is_followed	Boolean	Definition: Whether the component is added to favorites. Value range: true: The component has been added to favorites. false: The component is not added to favorites.
creator_id	String	Definition: Creator ID. Value range: The value consists of 32 characters, including digits and letters.
creator_name	String	Definition: Creator name. Value range: N/A
create_time	String	Definition: Creation time. Value range: N/A
updater_id	String	Definition: Updater ID. Value range: The value consists of 32 characters, including digits and letters.
updater_name	String	Definition: Updater name. Value range: N/A
update_time	String	Definition: Update time. Value range: N/A

**Table 5** ComponentRepoVO
Parameter	Type	Description
type	String	Definition: Repository type. Value range: N/A
repo_id	String	Definition: Repo ID. Value range: N/A
http_url	String	Definition: HTTP address of the repository. Value range: N/A
git_url	String	Definition: GIT address of the repository. Value range: N/A
branch	String	Definition: Branch. Value range: N/A
language	String	Definition: Language. Value range: N/A
endpoint_id	String	Definition: Endpoint ID. Value range: N/A

Example Requests

GET https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/component/list/query

{
  "offset" : 0,
  "limit" : 10,
  "name" : "",
  "sort_dir" : ""
}

Example Responses

Status code: 200

Response body for querying microservices.

{
  "data" : [ {
    "id" : "f7ced2341b204d2b82c607c6f0de5b4a",
    "name" : "11",
    "type" : "microservice",
    "description" : null,
    "status" : "active",
    "parent_id" : null,
    "cloud_project_id" : "2d09f712e9504b61b034cc8f40e475a8",
    "repos" : null,
    "is_followed" : true,
    "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
    "creator_name" : "north-5",
    "create_time" : "1709260209",
    "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
    "updater_name" : "north-5",
    "update_time" : "1719319144"
  } ],
  "total" : 1
}