查询项目的模块列表
功能介绍
查询项目的模块列表
URI
GET /v4/projects/{project_id}/modules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
devcloud项目的32位id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
查询偏移量 缺省值：0 |
|
limit |
否 |
Integer |
一次返回的数据,最小1,最大100 最小值：1 最大值：100 缺省值：10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
模块总数 |
|
modules |
Array of ProjectModule objects |
模块列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
module_id |
Integer |
模块id |
|
module_name |
String |
模块名称 |
|
owner |
ModuleOwner object |
|
|
deepth |
Integer |
模块层级 |
|
is_parent |
Boolean |
是否是父级，true 父模块， false 非父模块 |
|
children |
Array of ProjectChildModule objects |
子模块信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
module_id |
Integer |
模块id |
|
module_name |
String |
模块名称 |
|
owner |
ModuleOwner object |
|
|
deepth |
Integer |
模块层级 |
|
is_parent |
Boolean |
是否是父级，true 父模块， false 非父模块 |
|
parent_module_id |
Integer |
父模块id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
用户32位字符串id |
|
user_num_id |
Integer |
用户数字id |
|
user_name |
String |
用户名称 |
|
nick_name |
String |
用户昵称 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
Get https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/modules
响应示例
状态码： 200
OK
{
"total" : 1,
"modules" : [ {
"module_id" : 1,
"module_name" : "demo",
"owner" : {
"user_id" : "09d75cde5180d4481f91c018e89cb8e2",
"user_num_id" : 4091,
"user_name" : "demo_user_name_06",
"nick_name" : "demo"
},
"deepth" : 1,
"is_parent" : true,
"children" : [ {
"module_id" : 1,
"module_name" : "demo",
"owner" : {
"user_id" : "09d75cde5180d4481f91c018e89cb8e2",
"user_num_id" : 4091,
"user_name" : "demo_user_name_06",
"nick_name" : "demo"
},
"deepth" : 1,
"is_parent" : true,
"parent_module_id" : 1
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
