tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModifySnapshotsSharePermission

最后更新时间：2023-06-21 15:01:13

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.

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: ModifySnapshotsSharePermission.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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.

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

This example shows you how to share a snapshot with users.

Input Example

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySnapshotsSharePermission
<Common request parameters>

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

Output Example

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

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
InvalidParameter Incorrect parameter.
InvalidSnapshot.NotSupported Indicates that the operation is not supported for the snapshot.
InvalidSnapshotId.NotFound The ‘SnapshotId’ entered does not exist.
MissingParameter Missing parameter.
ResourceInsufficient.OverQuota Quota insufficient.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款