Domain name for API request: lighthouse.intl.tencentcloudapi.com.
This API is used to share an image across accounts.
This API is used to share custom images only, and the status of the shared image must be NORMAL.
The account receiving the shared image must be a root account.
A maximum of 20 requests can be initiated per second for this API.
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: ShareBlueprintAcrossAccounts. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| BlueprintId | Yes | String | Image ID, which can be obtained through the BlueprintId returned by the DescribeBlueprints API. |
| AccountIds.N | Yes | Array of String | List of account IDs that receive the shared images. The account ID is different from the QQ number. To query a user account ID, view the account ID column in the account information. The maximum number of accounts is 10. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: lighthouse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ShareBlueprintAcrossAccounts
<Common request parameters>
{
"BlueprintId": "lhbp-6jc6l8yb",
"AccountIds": [
"700000164995"
]
}{
"Response": {
"RequestId": "d339efa9-f637-4ba9-a7c6-fb89ce67d76f"
}
}
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 | Operation failed. |
| FailedOperation.ShareBlueprintAcrossAccountFailed | Failed to share an image across accounts. Try again later. |
| InvalidParameterValue.AccountIdInvalidAccountArea | Sharing images to accounts in different sites is not allowed. |
| InvalidParameterValue.AccountIdSameWithUin | The account is the current user. |
| InvalidParameterValue.AccountIdsNotExist | The account ID does not exist. |
| InvalidParameterValue.AccountIdsNotOwnerAccount | The account ID is not a root account. |
| InvalidParameterValue.BlueprintIdMalformed | Invalid parameter value: the image ID format is invalid. |
| InvalidParameterValue.InvalidBlueprintId | The image ID is invalid. |
| InvalidParameterValue.InvalidBlueprintState | Invalid image status value |
| LimitExceeded.ShareBlueprintAcrossAccountQuotaLimitExceeded | The image quota is insufficient to share images to the specified account. |
| OperationDenied.BlueprintOperationInProgress | The image is being operated on. Try again later. |
| ResourceInUse.BlueprintModifyingSharePermission | The image is undergoing sharing property modifications. The operation is not supported. |
| ResourceNotFound.BlueprintIdNotFound | The image ID does not exist. |
| ResourceNotFound.PrivateBlueprintNotFound | The custom image does not exist. |
| UnauthorizedOperation.NoPermission | No permission. |
| UnauthorizedOperation.TokenInvalid | You do not have permission to perform this operation. The token in the request is invalid. |
| UnsupportedOperation.BlueprintAlreadyShared | The image has already been shared. The operation is not supported. |
| UnsupportedOperation.BlueprintCurStateInvalid | The current status of the image does not support this operation. |
| UnsupportedOperation.BlueprintLatestOperationUnfinished | The last operation on the image is not completed yet. |
| UnsupportedOperation.BlueprintOccupied | The image is in use, so this operation is not supported. |
Feedback