DescribeImageSharePermission

Last Updated At: 2026-08-03 00:05:03

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (DescribeImageSharePermission) is used to view image sharing information.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-11-16 03:09:47.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeImageSharePermission
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
ImageId Yes No String Image ID Needs to be Shared
Example: img-6pb6lrmy

3. Output Parameters

Parameter name Type Description
SharePermissionSet Array of SharePermission Image Sharing Information
Example:View
MaxSharePermission Int64 Maximum Shared Permissions
Example: 2
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InvalidAccountId.NotFound Invalid account ID
InvalidAccountIs.YourSelf You cannot share an image with yourself.
OverQuota The maximum number of shared images allowed is reached
InvalidImageId.NotFound Image not found