tencent cloud

ModifyImageSharePermission
Last updated:2026-01-13 21:47:52
ModifyImageSharePermission
Last updated: 2026-01-13 21:47:52

1. API Description

Domain name for API request: lighthouse.intl.tencentcloudapi.com.

This API is used to share and cancel sharing of CVM custom images to the Lighthouse service.
Sharing CVM images to Lighthouse requires the following conditions to be met:

  1. Images that have been shared cannot be shared again.
  2. Images imported from external sources are not supported for sharing.
  3. Full-instance images are not supported for sharing.
  4. Images need to support CloudInit to be eligible for sharing.
  5. The Platform and OsName of the images must meet the sharing conditions before the images are eligible for sharing.
  6. Only images in the NORMAL status are supported for sharing.

A maximum of 20 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: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ImageId Yes String Image ID, which can be obtained through the ImageId in the returned value of the DescribeImages API.
Permission Yes String Sharing property, including SHARE and CANCEL. Among them, SHARE indicates sharing, and CANCEL indicates canceling sharing.

3. Output Parameters

Parameter Name Type Description
BlueprintId String Image ID after a CVM custom image is shared to Lighthouse.
Note: This field may return null, indicating that no valid values can be obtained.
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

Example1 Sharing a CVM Image to Lighthouse

This example shows you how to share a CVM image to Lighthouse.

Input Example

POST / HTTP/1.1
Host: lighthouse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSharePermission
<Common request parameters>

{
    "ImageId": "img-xkd784jw",
    "Permission": "SHARE"
}

Output Example

{
    "Response": {
        "BlueprintId": "lhbp-su83x02a",
        "RequestId": "4fe640d6-4912-4b43-9b3a-cc3bbab4cef2"
    }
}

Example2 Canceling the Sharing of a CVM Image to Lighthouse

This example shows you how to cancel the sharing of a CVM image to Lighthouse.

Input Example

POST / HTTP/1.1
Host: lighthouse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSharePermission
<Common request parameters>

{
    "ImageId": "img-xkd784jw",
    "Permission": "CANEL"
}

Output Example

{
    "Response": {
        "BlueprintId": null,
        "RequestId": "4fe640d6-4912-4b43-9b3a-cc3bbab4cef2"
    }
}

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

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.ImageOperationFailed Failed to perform operations on the image.
FailedOperation.RequestError A request error occurred.
InternalError.RequestError There was an error in the request.
InvalidParameterValue.InvalidImageIdMalformed The image ID format is invalid.
ResourceInUse.ImageInUse The image is in use. The operation is not supported.
ResourceNotFound.ImageIdNotFound The image ID does not exist.
ResourceNotFound.RoleNotFound The service role does not exist. Please add it to the account.
UnauthorizedOperation.NoPermission No permission.
UnsupportedOperation.AssumeRoleFailed Failed to obtain role authorization. Grant authorizations to the Lighthouse-related role and try again.
UnsupportedOperation.ImageAlreadyShared The image has already been shared. The operation is not supported.
UnsupportedOperation.ImageOccupied The image is currently in use by other operations. The operation is not supported. Try again later.
UnsupportedOperation.ImageUnableToShare Image sharing is not supported.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback