tencent cloud

Feedback

DescribeSnapshotSharePermission

Last updated: 2023-03-22 14:36:15

1. API Description

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

This API is used to query the sharing information of snapshots.

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: DescribeSnapshotSharePermission.
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.
SnapshotId Yes String The ID of the snapshot to be queried. You can obtain this by using DescribeSnapshots.

3. Output Parameters

Parameter Name Type Description
SharePermissionSet Array of SharePermission The set of snapshot sharing information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the sharing information of a snapshot

This example shows you how to query the sharing information of a snapshot.

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeSnapshotSharePermission
&SnapshotId=snap-asxafa65                   
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4ab150b9-538d-48fb-8821-7fa185f1d07c",
        "SharePermissionSet": [
            {
                "CreatedTime": "2019-07-08 00:00:06",
                "AccountId": "123456789"
            }
        ]
    }
}

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.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter.