Help & DocumentationCloud Block StorageAPI DocumentationSnapshot APIsModifySnapshotsSharePermission

ModifySnapshotsSharePermission

Last updated: 2020-02-03 20:15:56

PDF

Contents：

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API is used to modify snapshot sharing information.

After snapshots are shared, the accounts they are shared to can use the snapshot to create cloud disks.

  • Each snapshot can be shared to at most 50 accounts.
  • You can use a shared snapshot to create cloud disks, but you cannot change its name or description.
  • Snapshots can only be shared with accounts in the same region.
  • Only data disk snapshots can be shared.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifySnapshotsSharePermission
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
AccountIds.N Yes Array of String List of account IDs with which a snapshot is shared. For the format of array-type parameters, see API Introduction. You can find the account ID in Account Information.
Permission Yes String Operations. Valid values: SHARE, sharing an image; CANCEL, cancelling the sharing of an image.
SnapshotIds.N Yes Array of String The ID of the snapshot. You can obtain this by using [DescribeSnapshots](https://intl.cloud.tencent.com/document/product/362/15647.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sharing a snapshot with users

Input Example

https://cbs.tencentcloudapi.com/?Action=ModifySnapshotsSharePermission
&AccountIds.0=123456789
&Permission=SHARE
&SnapshotIds.0=snap-cgrmci8t
&SnapshotIds.1=snap-124p95lf
&<Common Request Parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InvalidParameter Invalid parameter
InvalidSnapshot.NotSupported Indicates that the operation is not supported for the snapshot.
InvalidSnapshotId.NotFound The ‘SnapshotId’ entered does not exist.
MissingParameter Missing parameter. Request does not include the required parameter.
ResourceInsufficient.OverQuota Quota insufficient.