流水线 CodeArts Pipeline
流水线 CodeArts Pipeline
- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 模板管理
-
流水线管理
- 启动流水线
- 批量获取流水线状态
- 获取流水线状态/获取流水线执行详情
- 获取流水线列表/获取项目下流水线执行状况
- 删除流水线
- 查询流水线详情
- 修改流水线信息
- 停止流水线
- 获取流水线执行记录
- 基于模板创建流水线
- 创建流水线
- 重试运行流水线
- 通过人工审核
- 获取流水线运行需要的自定义参数
- 驳回人工审核
- 查询流水线日志
- 获取流水线步骤执行输出
- 查询流水线上的构建产物
- 批量删除流水线
- 禁用流水线
- 批量设置流水线标签
- 启用流水线
- 批量运行流水线
- 查询流水线任务日志
- 延时任务通过
- 延时任务拒绝
- 延时1小时
- 手动卡点通过
- 手动卡点拒绝
- 解除挂起
- 查询批量执行流水线结果
- 交换分组顺序
- 流水线官方消息通知查询
- 流水线官方消息通知更新
- 流水线消息通知开关
- 流水线第三方消息通知查询
- 流水线第三方消息通知更新
- 查询流水线的角色权限
- 查询流水线的用户权限
- 修改流水线的角色权限
- 修改流水线的用户权限
- 查询流水线是否启用二级权限
- 修改流水线是否启用二级权限
- 批量设置流水线实例二级权限
- 取消某次流水线排队
- 查询当前流水线排队中的记录
- 查询流水线的旧版运行记录
- 查询流水线运行使用的参数
- 回退执行流水线
- 获取step跳转链接
- 查询流水线运行的变更
- 查询流水线可用的系统参数
- 查询流水线触发失败记录
- 查询流水线修改历史
- 创建参数组
- 修改参数组
- 删除参数组
- 流水线绑定参数组
- 查询参数组详情
- 查询流水线关联的参数组
- 查询参数组列表
- 获取通用Webhook信息
- 分组管理
- 规则管理
- 租户级策略管理
- 项目级策略管理
- 扩展插件管理
- 扩展点管理
- 流水线标签管理
- 变更管理
- 微服务管理
- 模板管理（旧版，待下线）
- 流水线管理（旧版，待下线）
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询微服务列表
功能介绍
查询微服务列表
调用方法
请参见如何调用API。
URI
POST /v2/{cloudProjectId}/component/list/query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cloudProjectId |
是 |
String |
项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
偏移 |
|
limit |
是 |
Integer |
大小 |
|
name |
否 |
String |
微服务名称 |
|
sort_dir |
否 |
String |
排序方向 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of ComponentVO objects |
数据 |
|
total |
Integer |
记录总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
微服务ID |
|
name |
String |
微服务名称 |
|
type |
String |
类型 |
|
description |
String |
描述 |
|
status |
String |
状态 |
|
parent_id |
String |
父ID |
|
cloud_project_id |
String |
项目ID |
|
repos |
Array of ComponentRepoVO objects |
微服务代码仓 |
|
is_followed |
Boolean |
组件是否被收藏 |
|
creator_id |
String |
创建人ID |
|
creator_name |
String |
创建人名称 |
|
create_time |
String |
创建时间 |
|
updater_id |
String |
更新人ID |
|
updater_name |
String |
更新人名称 |
|
update_time |
String |
更新时间 |
请求示例
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 |
查询微服务列表响应体 |
错误码
请参见错误码。
父主题： 微服务管理
