Share a Custom Image
Last Updated：2020-08-07
Description
- This API is used to share the custom image, which is only limited to the custom image. The system image and service integration image can not be shared.
- The image specified by imageId does not exist, and it prompts an error 404.
- After the successful sharing of image, the shared user can create and reset the instance through this image.
- The account and accountId in the request parameter are of optional parameters, but they can not be empty. When two parameters appear at the same time, the server automatically de-duplicates them.
Request Structure
POST /v{version}/image/{imageId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"account" : "account",
"accountId" : "accountId"
}Request Header Field
There are no other special header fields except the public header field.
Request Parameters
| Parameter Name | Type | Required? | Parameter Position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| imageId | String | Yes | URL parameter | Image ID to share |
| action | String | Yes | Query Parameter | Action on image, whose current value is share. |
| account | String | No | Request Body Parameter | User name to share |
| accountId | String | No | Request Body Parameter | User ID to share |
| ucAccount | String | 否 | RequestBody Parameter | uc Account |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
No specific parameters are returned.
Error Code
| Error Code | Error Description | HTTP Status Code | Explanations |
|---|---|---|---|
| Image.UnCustomImageCannotBeShared | Only custom image can be shared. | 403 | The non-custom image can not be shared. |
| Image.InvalidAccount | Account is invalid. | 400 | Invalid user |
| Image.AccountListIsEmpty | Account list is empty. | 400 | The user list is empty. |
| Image.ExceedSharedToUserNumQuota | Exceed shared to user num quota. | 413 | The number of shareable users exceeds the limit. |
| Image.CannotShareToOwner | Cannot share to owner. | 403 | The image can not be shared with the owner. |
| Image.AccountHasBeenShared | Account has been shared. | 409 | The user receives this shared image, which can not be shared repeatedly. |
| Image.ExceedAcceptSharedImageNumQuota | Exceed accept shared image num quota | 413 | The number of shareable images exceeds the limit. |
Request Instance
POST /v2/image/m-nky7qeom?share HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Date: Wed, 01 Mar 2006 12:00:00 GMT
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"account" : "ceshizhanghao",
"accountId" : "ab1d7802cb9b436bafaf3361fe482ca6"
}Return Instance
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