# 查询项目空间列表 - ListPrograms #### 功能介绍 查询项目空间列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:project:list | List | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI GET /v4/programs 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 分页大小，最大为100 | | offset | 否 | Integer | 分页起始，从0开始，为limit整数倍 | | 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 | 项目空间总数 | 表3ProgramItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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个项目 | 表4User | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**： 错误描述。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： 请求的ID，系统自动生成。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v4/programs GET https://{endpoint}/v4/programs ``` #### 响应示例 **状态码：200** ``` { "programs" : [ { "program_id" : "d537faaa00514c94ad47c95fddd36d08", "name" : "项目空间ZX0811", "description" : null, "creator" : { "user_name" : "ForTest", "user_id" : "c2d89e38a64a466f8f945f595df4402d", "nick_name" : "ForTest测试", "domain_id" : "aae03ca0d6814951980945b6eeca56cd", "domain_name" : "HIS_CodeArtsReq", "gender" : null }, "owner" : { "user_name" : "ForTest", "user_id" : "c2d89e38a64a466f8f945f595df4402d", "nick_name" : "ForTest测试", "domain_id" : "aae03ca0d6814951980945b6eeca56cd", "domain_name" : "HIS_CodeArtsReq", "gender" : null }, "created_time" : 1754899772000, "updated_time" : 1754899772000, "is_archived" : false, "is_watched" : false } ], "total" : 29 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功返回项目空间列表 | | 400 | Bad Request | | 401 | Unauthorized | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。