发起镜像复制到其他地域的任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
 - 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
 - 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
 - 对于不支持资源级授权的操作,用
全部资源表示。 
 - 条件关键字:是指云产品自身定义的条件关键字。
 - 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
 
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| appstreaming:StartTaskForDistributeImage | create | *全部资源 * | 
  | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| ImageId | string | 是 | 镜像 id  | imgc-07jyldnd9i***** | 
| VersionId | string | 否 | 镜像版本 ID,不填默认使用最新的镜像版本。  | iv-07jyldnd9i**** | 
| RetryType | string | 否 | 该参数暂不对外透出。  | RETRY | 
| DestinationRegionList | array | 否 | 需要复制的目标地域列表。  | |
| string | 否 | 阿里云地域 ID。  | cn-hangzhou | |
| ProductType | string | 否 | 产品类型。 枚举值: 
  | CloudApp | 
| SourceRegion | string | 否 | 指定复制镜像的源地域,不设置则随机选择。  | cn-shanghai | 
返回参数
示例
正常返回示例
JSON格式
{
  "Data": "tid-06xnr5lyp77e7****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "419F31B9-1FDF-5644-ABA3-D00026FA****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 400 | Instance.NotFound | The instance is not found. | 实例找不到。 | 
| 400 | DesktopInstance.NotFound | The cloud computer instance does not exist. | 云电脑实例不存在。 | 
| 400 | Instance.ImageUnsupported | A non-centralized image does not support this type of operation. | 使用非中心化镜像不支持该操作。 | 
| 400 | Instance.PhysicalNodeNotExist | The instance physical node does not exist. | 物理节点不存在。 | 
| 400 | ImageCreateByInstance.TaskExist | The image task of instance creation already exists. | 实例创建镜像任务已存在。 | 
| 400 | ExceedBuilderQuota | The maximum number of builders is reached. | Builder数量达到了上限。 | 
| 400 | InvalidBaseImage.NotConfigured | Configuration required for Vhd/Container images. | Vhd/Container镜像类型需要配置BaseImageId。 | 
| 400 | CreateDesktopImageRecord.Failed | Create cloud computer image failed. | 创建云电脑镜像失败。 | 
| 400 | Image.NotExist | The image does not exist. | 镜像不存在。 | 
| 400 | ImageRegionDistribute.NotAllow | This image cannot be distributed. | 镜像不允许分发操作。 | 
| 400 | ImageUpdateFailed.NotAllow | The image is not allowed to be modified. | 镜像不允许修改。 | 
| 400 | ImageUpdateSharedImageFailed.NotAllow | The shared image is not allowed to be modified. | 共享镜像不允许修改。 | 
| 400 | ParentImageRegionDistribute.NotExist | 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. | 分发地域配置为空。 | 
| 400 | ImageDistribute.ImageNotSupport | The image does not support region distribution. | 镜像不支持分发,如:加密镜像。 | 
| 400 | ImageDistribute.RepeatedDistribution | This image has been distributed to this region. | 镜像已经分发过该地域。 | 
| 400 | ImageDistribute.Undistributed | The image has not been distributed to any region. | 镜像分发无拷贝源地址,检查镜像分发地域是否已经清空。 | 
| 400 | ImageRegion.NotConfigured | The image does not have any region configuration. | 镜像无任何地域配置信息。 | 
访问错误中心查看更多错误码。
