文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 微服务管理/ 查询微服务列表
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询微服务列表

功能介绍

查询微服务列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

cloudProjectId

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

offset大于等于0。

默认取值：

不涉及。

limit

是

Integer

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

name

否

String

参数解释：

微服务名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort_dir

否

String

参数解释：

排序方向。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

Array of ComponentVO objects

参数解释：

数据详情。

取值范围：

不涉及。

total

Integer

参数解释：

记录总数。

取值范围：

不涉及。
表4 ComponentVO

参数

参数类型

描述

id

String

参数解释：

微服务ID。

取值范围：

32位字符，由数字和字母组成。

name

String

参数解释：

微服务名称。

取值范围：

不涉及。

type

String

参数解释：

微服务类型。

取值范围：

不涉及。

description

String

参数解释：

微服务描述。

取值范围：

不涉及。

status

String

参数解释：

微服务状态。

取值范围：

不涉及。

parent_id

String

参数解释：

父ID。

取值范围：

不涉及。

cloud_project_id

String

参数解释：

项目ID。

取值范围：

32位字符，由数字和字母组成。

repos

Array of ComponentRepoVO objects

参数解释：

微服务代码仓。

取值范围：

不涉及。

is_followed

Boolean

参数解释：

组件是否被收藏。

取值范围：

  • true：收藏。

  • false：未收藏。

creator_id

String

参数解释：

创建人ID。

取值范围：

32位字符，由数字和字母组成。

creator_name

String

参数解释：

创建人名称。

取值范围：

不涉及。

create_time

String

参数解释：

创建时间。

取值范围：

不涉及。

updater_id

String

参数解释：

更新人ID。

取值范围：

32位字符，由数字和字母组成。

updater_name

String

参数解释：

更新人名称。

取值范围：

不涉及。

update_time

String

参数解释：

更新时间。

取值范围：

不涉及。
表5 ComponentRepoVO

参数

参数类型

描述

type

String

参数解释：

仓库类型。

取值范围：

不涉及。

repo_id

String

参数解释：

Repo仓库ID。

取值范围：

不涉及。

http_url

String

参数解释：

仓库HTTP地址。

取值范围：

不涉及。

git_url

String

参数解释：

仓库GIT地址。

取值范围：

不涉及。

branch

String

参数解释：

分支。

取值范围：

不涉及。

language

String

参数解释：

语言。

取值范围：

不涉及。

endpoint_id

String

参数解释：

扩展点ID。

取值范围：

不涉及。

请求示例

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

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

响应示例

状态码：200

查询微服务列表响应体

{
  "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
}

状态码

状态码

描述

200

查询微服务列表响应体

错误码

请参见错误码。

父主题： 微服务管理

相关文档