云硬盘
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云硬盘 > API 文档 > 快照相关接口 > 修改快照分享信息

修改快照分享信息

最近更新时间：2024-03-12 01:12:36

我的收藏

本页目录：

1. 接口描述

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

本接口（ModifySnapshotsSharePermission）用于修改快照分享信息。

分享快照后，被分享账户可以通过该快照创建云硬盘。

  • 每个快照最多可分享给50个账户。
  • 分享快照无法更改名称，描述，仅可用于创建云硬盘。
  • 只支持分享到对方账户相同地域。
  • 仅支持分享数据盘快照。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifySnapshotsSharePermission。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
SnapshotIds.N 是 Array of String 快照ID, 可通过DescribeSnapshots查询获取。
示例值：["snap-j1ytqxx7"]
AccountIds.N 是 Array of String 接收分享快照的账号Id列表，array型参数的格式可以参考API简介。账号ID不同于QQ号，查询用户账号ID请查看账号信息中的账号ID栏。
示例值：["100001122000"]
Permission 是 String 操作，包括 SHARE，CANCEL。其中SHARE代表分享操作，CANCEL代表取消分享操作。
示例值：SHARE

3. 输出参数

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

4. 示例

示例1 将快照共享给用户

将指定快照共享给另一个用户

输入示例

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

{
    "AccountIds": [
        "123456789"
    ],
    "Permission": "SHARE",
    "SnapshotIds": [
        "snap-cgrmci8t",
        "snap-124p95lf"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "4ab150b9-538d-48fb-8821-7fa185f1d07c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidSnapshot.NotSupported 快照不支持该操作。
InvalidSnapshotId.NotFound 输入的SnapshotId不存在。
MissingParameter 缺少参数错误。
ResourceInsufficient.OverQuota 配额不足。
中国站