共享自定义镜像
更新时间:2024-07-02
该接口用于用户共享自己指定的自定义镜像,仅限自定义镜像,公共镜像和服务集成镜像不能共享。
- imageId 所指定的镜像不存在,提示404错误。
- 镜像共享后,被共享的用户可以使用此镜像创建、重置实例。
- 请求参数中的account和accountId均为可选参数,但不能全部为空,当两个参数同时出现时,服务端会自动去重。
请求结构
POST /v{version}/image/{imageId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"account" : "account",
"accountId" : "accountId"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
imageId | String | 是 | URL参数 | 待共享的镜像ID |
action | String | 是 | Query参数 | 对镜像执行的动作,当前取值:share |
account | String | 否 | Request Body参数 | 待共享的用户名 |
accountId | String | 否 | Request Body参数 | 待共享的用户ID |
ucAccount | String | 否 | RequestBody参数 | uc账号 |
返回头域
除公共头域,无其它特殊头域。
返回参数
无特殊返回参数
错误码
错误码 | 错误描述 | HTTP状态码 | 中文解释 |
---|---|---|---|
Image.UnCustomImageCannotBeShared | Only custom image can be shared. | 403 | 非自定义镜像不能共享 |
Image.InvalidAccount | Account is invalid. | 400 | 无效的用户 |
Image.AccountListIsEmpty | Account list is empty. | 400 | 用户列表为空 |
Image.ExceedSharedToUserNumQuota | Exceed shared to user num quota. | 413 | 超出可共享的用户数量限制 |
Image.CannotShareToOwner | Cannot share to owner. | 403 | 镜像不能共享给所属用户 |
Image.AccountHasBeenShared | Account has been shared. | 409 | 用户已接收到此共享镜像,不能重复共享 |
Image.ExceedAcceptSharedImageNumQuota | Exceed accept shared image num quota | 413 | 超出可接受共享的镜像数量限制 |
请求示例
POST /v2/image/m-nky*****?share HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Date: Wed, 01 Mar 2006 12:00:00 GMT
Authorization: authorization-string
{
"account" : "********",
"accountId" : "**********"
}
返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS