StartTaskForDistributeImage - 发起镜像地域复制任务

发起镜像复制到其他地域的任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
appstreaming:StartTaskForDistributeImagecreate
*全部资源
*

请求参数

名称类型必填描述示例值
ImageIdstring

镜像 id

imgc-07jyldnd9i*****
VersionIdstring

镜像版本 ID,不填默认使用最新的镜像版本。

iv-07jyldnd9i****
RetryTypestring

该参数暂不对外透出。

RETRY
DestinationRegionListarray

需要复制的目标地域列表。

string

阿里云地域 ID。

cn-hangzhou
ProductTypestring

产品类型。

枚举值:
  • CloudDesktop无影云桌面
  • CloudApp无影云应用
  • WuyingServer无影工作站
CloudApp
SourceRegionstring

指定复制镜像的源地域,不设置则随机选择。

cn-shanghai

返回参数

名称类型描述示例值
object

返回数据结构体。

Datastring

返回的镜像复制任务 ID。

tid-06xnr5lyp77e7****
Successboolean

是否成功。

true
Codestring

出错时的错误码。

200
Messagestring

出错时的错误消息。

success
RequestIdstring

请求的 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Instance.NotFoundThe instance is not found.实例找不到。
400DesktopInstance.NotFoundThe cloud computer instance does not exist.云电脑实例不存在。
400Instance.ImageUnsupportedA non-centralized image does not support this type of operation.使用非中心化镜像不支持该操作。
400Instance.PhysicalNodeNotExistThe instance physical node does not exist.物理节点不存在。
400ImageCreateByInstance.TaskExistThe image task of instance creation already exists.实例创建镜像任务已存在。
400ExceedBuilderQuotaThe maximum number of builders is reached.Builder数量达到了上限。
400InvalidBaseImage.NotConfiguredConfiguration required for Vhd/Container images.Vhd/Container镜像类型需要配置BaseImageId。
400CreateDesktopImageRecord.FailedCreate cloud computer image failed.创建云电脑镜像失败。
400Image.NotExistThe image does not exist.镜像不存在。
400ImageRegionDistribute.NotAllowThis image cannot be distributed.镜像不允许分发操作。
400ImageUpdateFailed.NotAllowThe image is not allowed to be modified.镜像不允许修改。
400ImageUpdateSharedImageFailed.NotAllowThe shared image is not allowed to be modified.共享镜像不允许修改。
400ParentImageRegionDistribute.NotExistThe target distribution region of the parent image does not exist.依赖父镜像分发地址不存在。
400InternalErrorInternal error.内部错误
400ImageDistribute.TargetDistributeRegionListEmptyThe target distribution region list is empty.分发地域配置为空。
400ImageDistribute.ImageNotSupportThe image does not support region distribution.镜像不支持分发,如:加密镜像。
400ImageDistribute.RepeatedDistributionThis image has been distributed to this region.镜像已经分发过该地域。
400ImageDistribute.UndistributedThe image has not been distributed to any region.镜像分发无拷贝源地址,检查镜像分发地域是否已经清空。
400ImageRegion.NotConfiguredThe image does not have any region configuration.镜像无任何地域配置信息。

访问错误中心查看更多错误码。