Initiates a task to replicate an image to another region.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| appstreaming:StartTaskForDistributeImage | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ImageId | string | Yes | The image ID. | imgc-07jyldnd9i***** |
| VersionId | string | No | The ID of the image version. If you do not specify this parameter, the latest image version is used by default. | iv-07jyldnd9i**** |
| RetryType | string | No | This parameter is not publicly available. | RETRY |
| DestinationRegionList | array | No | The regions to which you want to replicate the image. | |
| string | No | The region ID. | cn-hangzhou | |
| ProductType | string | No | The product type. Valid values:
| CloudApp |
| SourceRegion | string | No | The region where the source image is located. If you leave this parameter empty, a random region is selected. | cn-shanghai |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": "tid-06xnr5lyp77e7****",
"Success": true,
"Code": 200,
"Message": "success",
"RequestId": "419F31B9-1FDF-5644-ABA3-D00026FA****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Instance.NotFound | The instance is not found. | The instance is not found. |
| 400 | DesktopInstance.NotFound | The cloud computer instance does not exist. | The cloud computer instance does not exist. |
| 400 | Instance.ImageUnsupported | A non-centralized image does not support this type of operation. | A non-centralized image does not support this type of operation. |
| 400 | Instance.PhysicalNodeNotExist | The instance physical node does not exist. | The physical node of this instance does not exist. |
| 400 | ImageCreateByInstance.TaskExist | The image task of instance creation already exists. | The image task of instance creation already exists. |
| 400 | ExceedBuilderQuota | The maximum number of builders is reached. | The maximum number of builders is reached. |
| 400 | InvalidBaseImage.NotConfigured | Configuration required for Vhd/Container images. | Configuration required for Vhd/Container images. |
| 400 | CreateDesktopImageRecord.Failed | Create cloud computer image failed. | Failed to create the cloud computer image. |
| 400 | Image.NotExist | The image does not exist. | The image does not exist. |
| 400 | ImageRegionDistribute.NotAllow | This image cannot be distributed. | This image cannot be distributed. |
| 400 | ImageUpdateFailed.NotAllow | The image is not allowed to be modified. | The image is not allowed to be modified. |
| 400 | ImageUpdateSharedImageFailed.NotAllow | The shared image is not allowed to be modified. | The shared image is not allowed to be modified. |
| 400 | ParentImageRegionDistribute.NotExist | The target distribution region of the parent image does not exist. | The target distribution region of the parent image does not exist. |
| 400 | InternalError | Internal error. | - |
| 400 | ImageDistribute.TargetDistributeRegionListEmpty | The target distribution region list is empty. | The target distribution region list is empty. |
| 400 | ImageDistribute.ImageNotSupport | The image does not support region distribution. | The image does not support region distribution. E.g. encrypted images. |
| 400 | ImageDistribute.RepeatedDistribution | This image has been distributed to this region. | This image has been distributed to this region. |
| 400 | ImageDistribute.Undistributed | The image has not been distributed to any region. | The image has not been distributed to any region. |
| 400 | ImageRegion.NotConfigured | The image does not have any region configuration. | The image does not have any region configuration. |
For a list of error codes, visit the Service error codes.
