更新模块信息
功能介绍
更新模块信息。
调用方法
请参见如何调用API。
URI
PUT /v2/module/modules
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
owner |
否 |
String |
参数解释: 模块的负责人数字id,通过获取指定项目的成员用户列表接口获取,响应消息体中的user_num_id字段的值就是模块的负责人数字id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
id |
否 |
String |
参数解释: 模块的id,可通过查询模块设置接口获取,响应消息体中的id字段的值就是模块的id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10。 默认取值: 不涉及。 |
projectId |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 模块的描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
name |
否 |
String |
参数解释: 模块的名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 返回的结果。 |
status |
String |
参数解释: 返回状态。 取值范围: success:返回成功。 error:返回失败。 |
请求示例
PUT http://{endpoint}/v2/module/modules { "description" : "test", "id" : 11111, "name" : "test", "owner" : 11111, "projectId" : "f385a0028b184fe3ae6d593db128c0e5" }
响应示例
状态码:200
更新模块信息接口成功的响应。
{ "result" : { "module" : { "id" : 5945957, "project_id" : 13096279, "name" : "2222", "owner" : 1274137, "description" : "333111" } }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
更新模块信息接口成功的响应。 |
错误码
请参见错误码。