tencent cloud



最后更新时间:2022-08-26 10:50:45

1. API Description

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

This API is used to modify image sharing information.

  • The accounts with which an image is shared can use the shared image to create instances.
  • Each custom image can be shared with up to 50 accounts.
  • You can use a shared image to create instances, but you cannot change its name and description.
  • If an image is shared with another account, the shared image will be in the same region as the original image.

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 IDs in two ways:
  • Call DescribeImages and look for ImageId in the response.
  • Look for the information in the Image Console.
    You can only specify an image in the NORMAL state. For more information on image states, see here.
  • AccountIds.N Yes Array of String List of account IDs with which an image is shared. For the format of array-type parameters, see API Introduction. The account ID is different from the QQ number. You can find the account ID 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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sharing an image

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

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ModifyImageSharePermission
    &<Common request parameters>

    Output Example

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

    5. Developer Resources


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

    Command Line Interface

    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.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.




    7x24 电话支持