修改快照分享信息

最近更新时间:2020-09-09 08:02:31

1. 接口描述

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

本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 将快照共享给用户

输入示例

https://cbs.tencentcloudapi.com/?Action=ModifySnapshotsSharePermission
&AccountIds.0=123456789
&Permission=SHARE
&SnapshotIds.0=snap-cgrmci8t
&SnapshotIds.1=snap-124p95lf
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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