All Products
Search
Document Center

App Streaming:StartTaskForDistributeImage

Last Updated:Dec 17, 2025

Initiates a task to replicate an image to another region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
appstreaming:StartTaskForDistributeImagecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ImageIdstringYes

The image ID.

imgc-07jyldnd9i*****
VersionIdstringNo

The ID of the image version. If you do not specify this parameter, the latest image version is used by default.

iv-07jyldnd9i****
RetryTypestringNo

This parameter is not publicly available.

RETRY
DestinationRegionListarrayNo

The regions to which you want to replicate the image.

stringNo

The region ID.

cn-hangzhou
ProductTypestringNo

The product type.

Valid values:

  • CloudDesktop: Elastic Desktop Service
  • CloudApp: App Streaming
  • WuyingServer: Workstation
CloudApp
SourceRegionstringNo

The region where the source image is located. If you leave this parameter empty, a random region is selected.

cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Datastring

The ID of the image replication task.

tid-06xnr5lyp77e7****
Successboolean

Indicates whether the task is successful.

true
Codestring

The error code if an error occurred.

200
Messagestring

The error message if an error occurred.

success
RequestIdstring

The ID of the request.

419F31B9-1FDF-5644-ABA3-D00026FA****

Examples

Sample success responses

JSONformat

{
  "Data": "tid-06xnr5lyp77e7****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "419F31B9-1FDF-5644-ABA3-D00026FA****"
}

Error codes

HTTP status codeError codeError messageDescription
400Instance.NotFoundThe instance is not found.The instance is not found.
400DesktopInstance.NotFoundThe cloud computer instance does not exist.The cloud computer instance does not exist.
400Instance.ImageUnsupportedA non-centralized image does not support this type of operation.A non-centralized image does not support this type of operation.
400Instance.PhysicalNodeNotExistThe instance physical node does not exist.The physical node of this instance does not exist.
400ImageCreateByInstance.TaskExistThe image task of instance creation already exists.The image task of instance creation already exists.
400ExceedBuilderQuotaThe maximum number of builders is reached.The maximum number of builders is reached.
400InvalidBaseImage.NotConfiguredConfiguration required for Vhd/Container images.Configuration required for Vhd/Container images.
400CreateDesktopImageRecord.FailedCreate cloud computer image failed.Failed to create the cloud computer image.
400Image.NotExistThe image does not exist.The image does not exist.
400ImageRegionDistribute.NotAllowThis image cannot be distributed.This image cannot be distributed.
400ImageUpdateFailed.NotAllowThe image is not allowed to be modified.The image is not allowed to be modified.
400ImageUpdateSharedImageFailed.NotAllowThe shared image is not allowed to be modified.The shared image is not allowed to be modified.
400ParentImageRegionDistribute.NotExistThe target distribution region of the parent image does not exist.The target distribution region of the parent image does not exist.
400InternalErrorInternal error.-
400ImageDistribute.TargetDistributeRegionListEmptyThe target distribution region list is empty.The target distribution region list is empty.
400ImageDistribute.ImageNotSupportThe image does not support region distribution.The image does not support region distribution. E.g. encrypted images.
400ImageDistribute.RepeatedDistributionThis image has been distributed to this region.This image has been distributed to this region.
400ImageDistribute.UndistributedThe image has not been distributed to any region.The image has not been distributed to any region.
400ImageRegion.NotConfiguredThe 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.