Domain name for API request: cvm.tencentcloudapi.com.
This API is used to modify image sharing information.
A maximum of 10 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: cvm.ap-shanghai-fsi.tencentcloudapi.com
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: ModifyImageSharePermission. |
| 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. |
| ImageId | Yes | String | Image ID such as img-gvbnzy6f. You can obtain the image IDs in two ways: ImageId in the response. You can only specify an image in the NORMAL state. For more information on image states, see here. |
| AccountIds.N | Yes | Array of String | List of account IDs with which an image is shared. For the format of array-type parameters, see API Introduction. The account ID is different from the QQ number. You can find the account ID in Account Information. |
| Permission | Yes | String | Operations. Valid values: SHARE, sharing an image; CANCEL, cancelling an image sharing. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to share the image img-6pb6lrmy with the account 1038493875.
GET https://cvm.tencentcloudapi.com/?Action=ModifyImageSharePermission
&ImageId=img-6pb6lrmy
&AccountIds.0=1038493875
&Permission=SHARE
&<Common request parameters>{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.AccountAlreadyExists | The account already exists. |
| FailedOperation.AccountIsYourSelf | You cannot share images with yourself. |
| FailedOperation.NotMasterAccount | You’re using a collaborator account. Please enter a root account. |
| 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. |
| InvalidParameter.InstanceImageNotSupport | This API does not support instance images. |
| InvalidParameterValue.InvalidImageId | The image does not support this operation. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| OverQuota | The number of shared images exceeds the quota. |
Was this page helpful?