取消共享私有镜像
接口功能介绍
取消共享一份私有镜像给指定用户。
接口约束
接口请求成功需至少满足:
- 所指定的私有镜像的状态应是 active。可使用查询镜像详细信息接口来查询一份镜像的详细信息。
- 共享镜像的接受人:
- 不是自己,即私有镜像的拥有者;
- 在所指定的私有镜像的共享列表中,并且未接受所指定的私有镜像对应的共享镜像(可使用查询私有镜像的共享列表接口来查询一份私有镜像的共享列表)。
- 不是自己,即私有镜像的拥有者;
URI
POST /v4/image/shared-image/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 描述 | 示例 | 下级对象 |
---|---|---|---|---|---|
destinationUser | 是 | String | 共享镜像的接受人。 | 888888@chinatelecom.cn | |
imageID | 是 | String | 要取消共享的私有镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b |
响应参数
参数 | 是否必填 | 参数类型 | 描述 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码,取值范围(值:描述): 800:成功 900:失败 |
800 | |
errorCode | 是 | String | 错误码(product.module.code 三段式码)。 | ||
message | 是 | String | 失败时的错误描述(一般为英文)。 | ||
description | 是 | String | 失败时的错误描述(一般为中文)。 | ||
returnObj | 是 | Object | 返回参数。 |
请求示例
请求头header
无
请求体body
{
"destinationUser": "888888@chinatelecom.cn",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "88f8888888dd88ec888888888d888d8b"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "",
"description": "",
"returnObj": {}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Image.ImageAdmin.AccessFailed | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
Image.ImageCheck.NotFound | 镜像不存在或不符合要求。 |
Image.ImageCheck.UnknownError | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
Image.ImageFormat.FormatError | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
Image.ImageWorkorder.DeleteError | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
Image.PatternCheck.NotValid | 请求参数无效。 |