更新时间:2025-08-05 GMT+08:00
分享

查询项目空间列表

功能介绍

查询项目空间列表。

调用方法

请参见如何调用API

URI

GET /v4/programs

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询项目空间列表数目,最大为100

offset

Integer

查询项目空间列表偏移量

search

String

模糊查询项目空间名称或者描述

sort_key

String

排序字段,支持name,created_time排序,

sort_dir

String

排序顺序ASC,DESC

is_watched

Boolean

是否关注,false 未关注, true 已关注

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

programs

Array of ProgramItem objects

项目空间列表

total

Integer

项目空间总数

表3 ProgramItem

参数

参数类型

描述

created_time

Long

参数解释:

创建时间。

取值范围:

时间戳。

creator

User object

参数解释:

创建人。

description

String

参数解释:

项目空间描述。

取值范围:

最少1位字符,最大128位字符。

is_archived

Boolean

参数解释:

归档状态。

取值范围:,

true(已归档);

false(未归档)。

is_watched

Boolean

是否关注, true 已关注, false 未关注

name

String

参数解释:

项目空间名称。

取值范围:

最少0位字符,最大500位字符。

owner

User object

参数解释:

所有者。

program_id

String

参数解释:

项目空间uuid。

取值范围:

32位uuid。

updated_time

Long

参数解释:

更新时间。

取值范围:

时间戳。

project_count

Integer

项目空间关联的项目数,1个项目最多关联100个项目

表4 User

参数

参数类型

描述

domain_id

String

参数解释:

租户uuid

取值范围:

不涉及

domain_name

String

参数解释:

租户名

取值范围:

不涉及

gender

String

参数解释:

性别

取值范围:

不涉及

nick_name

String

参数解释:

昵称

取值范围:

不涉及

user_id

String

参数解释:

用户uuid

取值范围:

不涉及

user_name

String

参数解释:

用户名

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/programs

GET https://{endpoint}/v4/programs

响应示例

状态码

状态码

描述

200

成功返回项目空间列表

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档