Domain name for API request: cvm.tencentcloudapi.com.
This API is used to modify image sharing information.
A maximum of 10 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyImageSharePermission. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ImageId | Yes | String | Image ID, such as img-gvbnzy6f . You can obtain the image ID in the following ways:ImageId in the response.The image ID should correspond to an image in the NORMAL state. For more information on image status, see Image Data Table. |
AccountIds.N | Yes | Array of String | ID list of root accounts receiving shared images. For the format of array-type parameters, see API Introduction. An account ID is different from a QQ number. For details on root account IDs, refer to the account ID section in Account Information. |
Permission | Yes | String | Operations. Valid values: SHARE , sharing an image; CANCEL , cancelling an image sharing. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to share the image img-6pb6lrmy
to the account 1038493875
.
GET https://cvm.tencentcloudapi.com/?Action=ModifyImageSharePermission
&ImageId=img-6pb6lrmy
&AccountIds.0=1038493875
&Permission=SHARE
&<Common request parameters>
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.AccountAlreadyExists | The account already exists. |
FailedOperation.AccountIsYourSelf | You cannot share images with yourself. |
FailedOperation.BYOLImageShareFailed | BYOL images cannot be shared. |
FailedOperation.NotMasterAccount | You’re using a collaborator account. Please enter a root account. |
FailedOperation.QImageShareFailed | Image sharing failed. |
FailedOperation.RImageShareFailed | Image sharing failed. |
InvalidAccountId.NotFound | Invalid account ID. |
InvalidAccountIs.YourSelf | You cannot share images with yourself. |
InvalidImageId.Malformed | Invalid image ID format. |
InvalidImageId.NotFound | The image cannot be found. |
InvalidParameter.InstanceImageNotSupport | This API does not support instance images. |
InvalidParameterValue.InvalidAppIdFormat | Invalid AppID |
InvalidParameterValue.InvalidImageId | The image does not support this operation. |
InvalidParameterValue.InvalidImageState | The image has another ongoing task. Please check and try again later. |
InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
OverQuota | The number of shared images exceeds the quota. |
UnauthorizedOperation.ImageNotBelongToAccount | The specified image does not belong to the user. |
UnauthorizedOperation.InvalidToken | Check if the token is valid. |
UnsupportedOperation.EncryptedImagesNotSupported | Encrypted images are not supported. |
UnsupportedOperation.LocationImageNotSupported | This request does not support images in this region. Please change to another image. |
Was this page helpful?