文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 获取项目列表
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取项目列表

功能介绍

获取项目列表

调用方法

请参见如何调用API。

URI

GET /v1/domain/project/related-page

表1 Query参数

参数

是否必选

参数类型

描述

page_size

否

Integer

每页显示的条目数量，page_size小于等于100

默认取值：

10

page_no

否

Integer

分页页码，表示从此页开始查询， page大于等于1

默认取值：

1

search

否

String

搜索内容

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

result

result object

项目列表

error

String

返回错误信息

status

String

返回状态信息
表3 result

参数

参数类型

描述

total

Number

总数

project_info_list

Array of project_info_list objects

项目列表
表4 project_info_list

参数

参数类型

描述

identifier

String

唯一标识

name

String

项目名

author_id

String

用户ID

status

Integer

状态

author_domain_id

String

项目创建者租户ID

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/domain/project/related-page

响应示例

状态码： 200

OK

{
  "result" : {
    "total" : 1,
    "project_info_list" : [ {
      "identifier" : "32f28c61a5c24688be80294a06f844b2",
      "name" : "CodeCIServer",
      "status" : 1,
      "author_id" : "4105.0",
      "author_domain_id" : "60021bab32fd450aa2cb89226f425e06"
    } ]
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档