tencent cloud

云服务器

动态与公告
产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
产品简介
云服务器概述
产品优势
基本概念
地域和可用区
新手指引
Service Regions and Service Providers
产品计费
计费概述
计费方式
计费项
转换计费方式
购买实例
变配费用说明
欠费说明
快速入门
通过自定义配置购买 Linux 云服务器
通过自定义配置购买 Windows 云服务器
用户指南
操作指南总览
使用限制总览
实例
竞价实例
预留实例
镜像
存储
备份与恢复
网络
安全
密码/密钥
监控与告警
运维管理
便捷功能
迁移服务器
在线迁移
迁移咨询
故障处理
无法登录云服务器问题处理思路
Windows 实例登录相关故障
Linux 实例登录相关故障
其他实例登录相关故障
实例运行故障
Linux 实例内存故障
网络故障
实践教程
云服务器选型建议
搭建环境
搭建网站
搭建应用
搭建可视化界面
本地文件上传到云服务器
网络性能测试
其他实践教程
API 文档
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
安全与合规
访问管理
网络
常见问题
地域和可用区相关
计费相关
实例相关
存储相关
镜像相关
服务器迁移相关
网络相关
安全相关
操作系统相关
运维和监控相关
访问管理相关
NTP 服务相关
应用场景相关
服务协议
CVM Service Level Agreements
Red Hat Enterprise Linux 镜像服务协议
Public IP Service Level Agreement
词汇表
文档云服务器API 文档Image APIsModifyImageSharePermission

ModifyImageSharePermission

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:38:09

1. API Description

Domain name for API request: cvm.intl.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

    Example1 Sharing an image

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

    Input Example

    GET https://cvm.intl.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

    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.

    帮助和支持

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

    填写满意度调查问卷,共创更好文档体验。

    文档反馈