云服务器修改镜像共享信息-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cvm.tencentcloudapi.com 。

本接口（ModifyImageSharePermission）用于修改镜像共享信息。

共享镜像后，被共享账户可以通过该镜像创建实例。
每个自定义镜像最多可共享给500个账户。
共享镜像无法更改名称，描述，仅可用于创建实例。
只支持共享到对方账户相同地域。

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyImageSharePermission。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
ImageId	是	String	镜像ID，形如`img-gvbnzy6f`。镜像Id可以通过如下方式获取：通过DescribeImages接口返回的`ImageId`获取。通过镜像控制台获取。镜像ID必须指定为状态为`NORMAL`的镜像。镜像状态请参考镜像数据表。示例值：img-6pb6lrmy
AccountIds.N	是	Array of String	接收共享镜像的主账号ID列表，array型参数的格式可以参考API简介。账号ID不同于QQ号，查询用户主账号ID请查看账号信息中的账号ID栏。示例值：["103849387508"]
Permission	是	String	操作，包括 `SHARE`，`CANCEL`。其中`SHARE`代表共享操作，`CANCEL`代表取消共享操作。示例值：SHARE

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 共享镜像

共享镜像img-6pb6lrmy给账户1038493875

输入示例

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSharePermission
<公共请求参数>

{
    "AccountIds": [
        "1038493875"
    ],
    "Permission": "SHARE",
    "ImageId": "img-6pb6lrmy"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.AccountAlreadyExists	账号已经存在
FailedOperation.AccountIsYourSelf	账号为当前用户
FailedOperation.BYOLImageShareFailed	自带许可镜像暂时不支持共享。
FailedOperation.NotMasterAccount	账号为协作者，请填写主账号
FailedOperation.QImageShareFailed	镜像共享失败。
FailedOperation.RImageShareFailed	镜像共享失败。
InvalidAccountId.NotFound	无效的账户Id。
InvalidAccountIs.YourSelf	您无法共享镜像给自己。
InvalidImageId.Malformed	错误的镜像Id格式。
InvalidImageId.NotFound	未找到该镜像。
InvalidParameter.InstanceImageNotSupport	当前接口不支持实例镜像。
InvalidParameterValue.InvalidAppIdFormat	无效的appid。
InvalidParameterValue.InvalidImageId	镜像不允许执行该操作
InvalidParameterValue.InvalidImageState	镜像被其他操作占用，请检查，并稍后重试。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。
OverQuota	镜像共享超过配额。
UnauthorizedOperation.ImageNotBelongToAccount	指定的镜像不属于用户。
UnauthorizedOperation.InvalidToken	请确认Token是否有效。
UnsupportedOperation.EncryptedImagesNotSupported	不支持加密镜像。
UnsupportedOperation.LocationImageNotSupported	此请求不支持该区域镜像,请更换其他镜像。

修改镜像共享信息

本页目录：