CreateImageProcessTask-阿里云帮助中心

调试

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

请求参数


名称	类型	是否必选	示例值	描述
RegionId	String	否	cn-hangzhou	项目所在地域的ID。 RegionId是Endpoint的标识和组成部分，用于构造请求示例中的Endpoint。Endpoint的格式为`imm.${RegionId}.aliyuncs.com`，例如当RegionId为cn-hangzhou时，Endpoint为imm.cn-hangzhou.aliyuncs.com。
Action	String	是	CreateImageProcessTask	操作接口名称，固定取值为CreateImageProcessTask。
Project	String	是	immimagetest	项目名称。
ImageUri	String	是	oss://imm-test/testcases/test.bmp	图片的OSS URI。 OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。
NotifyTopicName	String	否	topic1	异步反向通知的TopicName。
NotifyEndpoint	String	否	http://1111111111.mns.cn-hangzhou.aliyuncs.com	异步反向通知的Endpoint，任务执行状态可以通过该Endpoint异步通知给调用者。使用此功能需要开通MNS服务，新建topic和queue，并配置订阅关系。具体操作，请参见消息服务MNS快速入门。说明 MNS服务和智能媒体管理必须处于同一地域。
TargetList	String	是	[{"Actions":["image/resize,m_fixed","w_100,h_100"],"TargetUri":"oss://imm-test/testcases/testafter.bmp"}]	处理后的图片，可对同一图片做不同的处理。包括如下选项： Actions：需要对图片的处理，和OSS的图片处理参数一致，多个操作以正斜线（/）分割放在Actions数组中。更多信息，请参见OSS图片处理。 TargetUri：输出图片的OSS URI。

MNS通知

请求参数中如果设置了NotifyTopicName和NotifyEndpoint支持MNS事件通知，则智能媒体管理会为您返回异步通知。通知的消息格式为：


{
    "events": [
        {
            "eventName": "ImageProcessTask",
            "eventSource": "acs:imm",
            "eventTime": "2020-12-28T11:06:25.264Z",
            "eventVersion": "1.0",
            "imm": {
                  “Success”: “”,
                  “CompressDuration”: “”,
                  “Results”: “[{\”Success\”:\”true\”,\”TargetUri\”:\”oss://abc/p1.jpg\”,\”Reason\”:\”\”},{\”Success\”:\”true\”,\”TargetUri\”:\”oss://abc/p2.heic\”,\”Reason\”:\”\”}]”,
                  “JobId”: “ImageProcessTask-f8ba005b-52d7-462e-bf1b-e9a36a62170b”,
                  “ErrorCode”: “”,
                  “SourceResolution”: “340x247”,
                  “TaskId”: “ImageProcessTask-f8ba005b-52d7-462e-bf1b-e9a36a62170b”,
                  “ImageUri”: “oss://imm-test/testcases/test.bmp”,
                  “SourceCodec”: “BMP3”
                }
        }
    ]
}

MNS通知的返回参数说明请参见下表。


参数	类型	描述
eventName	String	任务类型，返回固定值为ImageProcessTask。
imm.TaskId	String	任务的唯一标识。
imm.Results	String	图片处理结果，以JSON格式表示。

返回数据


名称	类型	示例值	描述
TaskId	String	ImageProcessTask-f8ba005b-52d7-462e-bf1b-e9a36a62170b	任务的唯一标识。
RequestId	String	10AFFE69-73BA-47C2-8A85-029AA9DA72A3	当次请求的Request ID。
TaskType	String	ImageProcessTask	任务的类型，返回值固定为ImageProcessTask。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateImageProcessTask
&Project=immimagetest
&ImageUri=oss://imm-test/testcases/test.bmp
&NotifyTopicName=topic1
&NotifyEndpoint=http://1111111111.mns.cn-hangzhou.aliyuncs.com
&TargetList=[{"Actions":["image/resize,m_fixed","w_100,h_100"],"TargetUri":"oss://imm-test/testcases/testafter.bmp"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateImageProcessTaskResponse>
    <TaskId>ImageProcessTask-f8ba005b-52d7-462e-bf1b-e9a36a62170b</TaskId>
    <RequestId>10AFFE69-73BA-47C2-8A85-029AA9DA72A3</RequestId>
    <TaskType>ImageProcessTask</TaskType>
</CreateImageProcessTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "ImageProcessTask-f8ba005b-52d7-462e-bf1b-e9a36a62170b",
  "RequestId" : "10AFFE69-73BA-47C2-8A85-029AA9DA72A3",
  "TaskType" : "ImageProcessTask"
}