Help & DocumentationCloud Virtual MachineAPI DocumentationImage APIsModifyImageSharePermission

ModifyImageSharePermission

Last updated: 2019-12-05 20:30:43

PDF

Contents：

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyImageSharePermission
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. 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 an image whose image ID is img-6pb6lrmy with 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

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    InvalidAccountId.NotFound Invalid account ID.
    InvalidAccountIs.YourSelf You cannot share images with yourself.
    OverQuota The number of shared images exceeds the quota.