tencent cloud

Feedback

DescribeImageSharePermission

Last updated: 2022-08-26 10:50:47

1. API Description

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

This API is used to query image sharing information.

A maximum of 10 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: DescribeImageSharePermission.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ImageId Yes String The ID of the image to be shared

3. Output Parameters

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

4. Example

Example1 Querying sharing information of a specified image

This example shows you how to query the sharing information of an image whose image ID is img-6pb6lrmy.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeImageSharePermission
&ImageId=img-6pb6lrmy
&<Common request parameters>

Output Example

{
    "Response": {
        "SharePermissionSet": [
            {
                "CreatedTime": "2018-06-10T11:02:50Z",
                "AccountId": "101104350000"
            },
            {
                "CreatedTime": "2018-06-13T15:03:25Z",
                "AccountId": "101104350001"
            }
        ],
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
    }
}

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
InvalidAccountId.NotFound Invalid account ID.
InvalidAccountIs.YourSelf You cannot share images with yourself.
InvalidImageId.Malformed Invalid image ID format.
InvalidImageId.NotFound The image cannot be found.
OverQuota The number of shared images exceeds the quota.
UnauthorizedOperation.ImageNotBelongToAccount The specified image does not belong to the user.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support