Tenant Cloud Compute Cloud Virtual Machine Image APIs ModifyImageSharePermission

ModifyImageSharePermission

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API is used to modify image sharing information.

  • After an image is shared, the receiver's account can create an instance through the image.
  • Each custom image can be shared with a maximum of 500 accounts.
  • Names and descriptions of shared images cannot be changed. They can only be used to create instances.
  • Sharing is only supported within the same region as that of the receiver's account.

Default interface request rate limit: 10 times per second.

Interface update time: 2018-04-04 09:23:06.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ModifyImageSharePermission
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
ImageId Yes No String Image ID, in the format of img-gvbnzy6f. You can obtain the Image ID in the following ways:
  • Through the ImageId returned by the API DescribeImages.
  • Through the DescribeImages.
    The Image ID should be specified as an image in the NORMAL state. For the image status, see the Image Data Table.
    Example: img-6pb6lrmy
    		•
    AccountIds Yes No Array of String List of account IDs receiving shared images, for the format of array parameter, see API Introduction. The account ID is different from the QQ number. For querying the user account ID, see the account ID column in the Account Information.
    Example: ["103849387508"]
    Permission Yes No String Operations, including SHARE and CANCEL. SHARE represents sharing, and CANCEL represents canceling sharing.
    Example: SHARE

    3. Output Parameters

    Parameter name Type Description
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidAccountId.NotFound Invalid account ID
    InvalidAccountIs.YourSelf You cannot share an image with yourself.
    OverQuota The maximum number of shared images allowed is reached