ModifyImageSharePermission

Download PDF

ModifyImageSharePermission

最后更新时间：2024-10-22 19:33:22

下载PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to modify image sharing information.

The account with shared image access can use the image to create instances.
Each custom image can be shared with a maximum of 500 accounts.
Shared images cannot have their names or description changed. They can only be used to create instances.
Sharing is only supported within the same region as the recipient's account.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: Call the DescribeImages API and find the value of `ImageId` in the response. Obtain it in the Image console. 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.

3. Output Parameters

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.

4. Example

This example shows you how to share the image img-6pb6lrmy to the account 1038493875.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=ModifyImageSharePermission
&ImageId=img-6pb6lrmy
&AccountIds.0=1038493875
&Permission=SHARE
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

tencent cloud

Recent Pages

ModifyImageSharePermission

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

ModifyImageSharePermission

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Sharing an image

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？