接口功能介绍
- 至少指定一项待修改的属性。
接口约束
无
URI
POST /v3/customImage/modifyAttribute
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageOid | 是 | String | 镜像ID | mi-jdf39e1579j44bcrpa4hg | |
| imageName | 否 | String | 镜像名称。只能由数字、英文字母、中划线、下划线和小数点组成，字符数限制[1,50]。 | ||
| description | 否 | String | 描述。字符数限制[0,200]。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"imageOid":"mi-xxx","imageName":"abb","description":null}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
