异步通知消息格式

本文介绍调用异步任务接口发送的异步通知消息的格式。

通用消息体

  • 消息正文示例。

{
  "id": "25E-1uBJUMOshisffTNk8********", //消息id
  "source": "acs.imm", //消息来源
  "type": "imm:Task:******", //任务类型
  "subject": "",
  "time": "1724136957925", //消息创建时间
  "content": "{}" // 消息体正文,注意内部是有转义的
}

CreateMediaConvertTask为例,若配置了消息通知,完整的正文消息如下所示:

{
  "id": "25E-1uBJUMOshisffTNk8Nr3GIj****",
  "source": "acs.imm",
  "type": "imm:Task:MediaConvert",
  "subject": "acs:imm:cn-beijing:102321002467****:test-***/imm:Task:MediaConvert",
  "time": "1724133063161",
  "content": "{\"ProjectName\":\"test-project\",\"DatasetName\":\"\",\"RequestId\":\"F9F8F37F-3188-5EFE-9292-9F0AF98D****\",\"StartTime\":\"2024-08-20T07:03:07.36Z\",\"EndTime\":\"2024-08-20T07:03:08.57Z\",\"UserData\":\"\",\"TaskType\":\"MediaConvert\",\"TaskId\":\"MediaConvert-db7faf5a-99c5-4afe-8309-d167fe53****\",\"Status\":\"Succeeded\",\"Code\":\"\",\"Message\":\"\",\"EventSourceId\":\"\",\"Sources\":[{\"URI\":\"oss://your-bucket/immtest/test.mp4\",\"SubtitleSources\":null}],\"Targets\":[{\"URI\":\"\",\"Subtitle\":{\"Extract\":{\"URI\":\"\"}},\"Image\":{\"Sprites\":null,\"Snapshots\":[{\"URI\":\"oss://your-bucket/dest.png\"}],\"Animations\":null}}]}"
}
说明

下文中消息示例为通用消息体中的content内容,且进行了反转义以方便您的阅读。

元数据管理

元数据索引

IndexFileMeta接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "dataset1",
        "StartTime": "2023-01-04T13:17:00.270148129+08:00",
        "EndTime": "2023-01-04T13:17:00.904455255+08:00",
        "Success": true,
        "Message": "",
        "Files": [
            {
                "URI": "oss://test-bucket/test-object", // 建立索引的文件URI。
                "Error": "" // Error为空字符串表示该文件处理成功。
            }
        ]
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "dataset1",
        "StartTime": "2023-01-04T13:20:23.938065853+08:00",
        "EndTime": "2023-01-04T13:20:24.092661447+08:00",
        "Success": true,
        "Message": "",
        "Files": [
            {
                "URI": "oss://abcxxx", // 建立索引的文件URI。
                "Error": "[InvalidArgument] File does not exist." // Error不为空字符串表示该文件处理失败。
            }
        ]
    }

CreateFacesSearchingTask接口MNS消息示例

{
    "ProjectName": "immtest",
    "DatasetName": "dataset1",
    "RequestId": "FB57E2F6-5CB5-0EEB-B80A-****",
    "StartTime": "2023-01-04T05:08:28.582Z",
    "EndTime": "2023-01-04T05:08:28.785Z",
    "UserData": "test",
    "TaskType": "FacesSearching",
    "TaskId": "CreateFacesSearchingTask-72515b1d-448a-4320-9cfd-****",
    "Status": "Succeeded",
    "Code": "", // Code为空表示处理成功。
    "Message": "Success",
    "SimilarFaces": [
        {
            "URI": "oss://test-bucket/test-object.jpg",
            "Boundary": {
                "Width": 109,
                "Height": 150,
                "Left": 69,
                "Top": 49
            },
            // 相似人脸列表
            "SimilarFaces": [
                {
                    "URI": "oss://test-bucket/test-object-1.jpg",
                    "FigureId": "4cacbb71-52fd-4d3f-9d14-0840fecee0bf",
                    "Similarity": 0.73321015
                },
                {
                    "URI": "oss://test-bucket/test-object-2.jpg",
                    "FigureId": "7a4cd08d-bcd0-4bc4-93f4-1291075819cf",
                    "Similarity": 0.77035695
                },
                {
                    "URI": "oss://test-bucket/test-object-3.jpg",
                    "FigureId": "da920124-410a-4493-9fd3-1a3b366dca86",
                    "Similarity": 0.9836307
                }
            ]
        }
    ]
}

人脸聚类

CreateFigureClusteringTask接口MNS消息示例

{
    "ProjectName": "immtest",
    "DatasetName": "dataset1",
    "RequestId": "8541C62B-F379-0ADE-9A21-****",
    "StartTime": "2023-01-04T05:11:06.365Z",
    "EndTime": "2023-01-04T05:11:06.594Z",
    "UserData": "abcdef",
    "TaskType": "FaceClustering",
    "TaskId": "CreateFigureClusteringTask-4783e3c5-4099-464a-9530-****",
    "Status": "Succeeded",
    "Code": "", // Code为空表示处理成功。
    "Message": "Success",
    "NewClusterCount": 1, // 新增的聚类分组数量。
    "UpdatedClusterCount": 0, // 更新的聚类分组数量。
    "UpdatedFigureCount": 5  // 更新的人脸数量。
}

CreateFigureClustersMergingTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "dataset1",
        "RequestId": "6B95FE0A-614E-01BA-A1CB-****",
        "StartTime": "2023-01-04T05:04:50.25Z",
        "EndTime": "2023-01-04T05:04:50.72Z",
        "UserData": "",
        "TaskType": "FaceClusterMerging",
        "TaskId": "CreateFigureClustersMergingTask-4c9d5919-97e8-4145-96e9-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": "Success",
        "From": "Cluster-069b470c-b004-449b-b215-0a5e227ba727",
        "To": "Cluster-ee56c6f1-c9db-46e4-af5a-9c8bcc43444d",
        "UpdatedFigureCount": 4 // 更新的人脸数量。
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "dataset1",
        "RequestId": "2B6A466F-4AA8-087F-9E7A-****",
        "StartTime": "2023-01-04T05:21:48.455Z",
        "EndTime": "2023-01-04T05:21:48.742Z",
        "UserData": "",
        "TaskType": "FaceClusterMerging",
        "TaskId": "CreateFigureClustersMergingTask-c66050ea-3850-40b0-8bdd-****",
        "Status": "Failed",
        "Code": "InvalidArgument", // Code不为空表示处理失败。
        "Message": "The input parameter From is not valid", // 错误信息。
        "From": "abcdefaaaa",
        "To": "Cluster-dcd021b6-8870-4135-8414-d9a60d52f5ca",
        "UpdatedFigureCount": 0
    }
    

时空聚类

CreateLocationDateClusteringTask接口MNS消息示例

{
    "ProjectName": "immtest",
    "DatasetName": "dataset1",
    "RequestId": "7F069F5C-E226-05B3-8690-****",
    "StartTime": "2023-01-04T05:09:36.478Z",
    "EndTime": "2023-01-04T05:09:36.741Z",
    "UserData": "test",
    "TaskType": "LocationDateClustering",
    "TaskId": "LocationDateClustering-585f2e38-fe9b-4282-be88-****",
    "Status": "Succeeded",
    "Code": "",  // Code为空表示处理成功。
    "Message": ""
}

故事

CreateStory接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "dataset1",
        "RequestId": "6C466710-0AB1-09FB-9CC8-****",
        "StartTime": "2023-01-04T05:05:54.679Z",
        "EndTime": "2023-01-04T05:05:55.131Z",
        "UserData": "",
        "TaskType": "StoryCreation",
        "TaskId": "CreateStory-03f13dc9-08a9-4eb9-a4e2-****",
        "Status": "Succeeded",
        "Code": "",  // Code为空表示处理成功。
        "Message": "",
        "ObjectId": "id1"
    }
    
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "dataset1",
        "RequestId": "7F069F5C-E226-05B3-8690-****",
        "StartTime": "2023-01-04T05:18:41.565Z",
        "EndTime": "2023-01-04T05:18:41.708Z",
        "UserData": "",
        "TaskType": "StoryCreation",
        "TaskId": "CreateStory-05fb77df-740d-4d9b-9943-****",
        "Status": "Failed",
        "Code": "InvalidParameter", // Code不为空表示处理失败。
        "Message": "The specified parameter StorySubType is not valid.", // 错误信息。
        "ObjectId": "id1"
    }

图片处理

CreateImageToPDFTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "A9F681DA-9170-01D5-A090-****",
        "StartTime": "2023-01-04T05:21:42.1Z",
        "EndTime": "2023-01-04T05:21:42.37Z",
        "UserData": "test",
        "TaskType": "ImageToPDF",
        "TaskId": "ImageToPDF-036d9b7a-1b9f-4f50-a19d-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": ""
    }
    
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "CAA2C757-8027-07A0-A4A0-6F1A0A8F5549",
        "StartTime": "2023-01-04T05:11:32.492Z",
        "EndTime": "2023-01-04T05:11:32.745Z",
        "UserData": "test",
        "TaskType": "ImageToPDF",
        "TaskId": "ImageToPDF-fc96da75-972d-4ec0-bf1e-2457edd09ed4",
        "Status": "Failed",
        "Code": "InvalidArgument", // Code不为空表示处理失败。
        "Message": "Read image failed" // 错误信息。
    }
    

CreateImageSplicingTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "1E4E2AB8-F433-0072-B88D-****",
        "StartTime": "2023-01-04T05:12:54.19Z",
        "EndTime": "2023-01-04T05:12:54.415Z",
        "UserData": "test",
        "TaskType": "ImageSplicing",
        "TaskId": "ImageSplicing-1f2593b9-e481-4ed9-837a-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": ""
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "583A888E-A217-01FB-BD5B-****",
        "StartTime": "2023-01-04T05:13:07.582Z",
        "EndTime": "2023-01-04T05:13:07.728Z",
        "UserData": "test",
        "TaskType": "ImageSplicing",
        "TaskId": "ImageSplicing-41a687a6-c2fe-479f-9d96-****",
        "Status": "Failed",
        "Code": "InvalidArgument", // Code不为空表示处理失败。
        "Message": "Decode image failed" // 错误信息。
    }

CreateDecodeBlindWatermarkTask接口MNS消息示例

  • 处理成功消息示例。

    {
      "ProjectName": "temp-proj-7b662f1ce8ae40de96dbdb2a88884395",
      "DatasetName": "",
      "RequestId": "A2F2E71E-FE90-007D-A260-0B5A57A2257E",
      "StartTime": "2023-03-28T05:52:40.551Z",
      "EndTime": "2023-03-28T05:52:41.533Z",
      "UserData": "",
      "TaskType": "DecodeBlindWatermark",
      "TaskId": "DecodeBlindWatermark-9eb08870-d7cb-44d4-a7b4-3720bcc7cff3",
      "Status": "Succeeded",
      "Code": "",
      "Message": "",
      "EventSourceId": "",
      "Content": "阿里云版权所有"
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "FC91EF4A-4736-052D-B249-FCE1BDD4296B",
        "StartTime": "2023-01-04T05:13:07.582Z",
        "EndTime": "2023-01-04T05:13:07.728Z",
        "UserData": "test",
        "TaskType": "DecodeBlindWatermark",
        "TaskId": "DecodeBlindWatermark-687a641a-c2fe-479f-9d96-****",
        "Status": "Failed",
        "Code": "InvalidArgument.SourceURI", // Code不为空表示处理失败。
        "Message": "The input argument SourceURI not valid." // 错误信息。
    }

媒体处理

CreateMediaConvertTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "F68472DA-EF7B-0F71-9347-****",
        "StartTime": "2023-01-04T05:11:35.084Z",
        "EndTime": "2023-01-04T05:11:59.202Z",
        "UserData": "test",
        "TaskType": "MediaConvert",
        "TaskId": "MediaConvert-4d51241b-04d4-4343-aa25-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": "",
        // 目标列表。
        "Targets": [ 
            {
                "Code": "",
                "Message": "",
                "URI": "oss://test-bucket/test-object.mp4",
                "Subtitle": {
                    "Extract": {
                        "URI": "oss://test-bucket/test-object/DirtBaseExtractSubtitle"
                    }
                },
                "Image": {
                    "Sprites": [
                        {
                            "URI": "oss://test-bucket/test-object/DirtBaseImage_sprite"
                        }
                    ],
                    "Snapshots": [
                        {
                            "URI": "oss://test-bucket/test-object/DirtBaseImage_snapshot"
                        }
                    ]
                }
            }
        ]
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "19C14AFF-816C-082D-A6F7-****",
        "StartTime": "2023-01-04T05:12:07.321Z",
        "EndTime": "2023-01-04T05:12:07.555Z",
        "UserData": "test",
        "TaskType": "MediaConvert",
        "TaskId": "MediaConvert-703f51ca-ac8d-4623-a858-****",
        "Status": "Failed",
        "Code": "InvalidArgument", // Code不为空表示处理失败。
        "Message": "Invalid data found when processing input", // 错误信息。
        "Targets": []
    }

CreateVideoLabelClassificationTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "1ACEA79F-5A40-02F1-B398-****",
        "StartTime": "2023-01-04T05:12:31.18Z",
        "EndTime": "2023-01-04T05:12:33.876Z",
        "UserData": "test",
        "TaskType": "VideoLabelClassification",
        "TaskId": "VideoLabelClassification-99950265-1b6d-407c-b2f3-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": "",
        // 标签列表。
        "Labels": [
            {
                "Language": "zh-Hans",
                "LabelName": "颜色",
                "LabelConfidence": 0.999,
                "CentricScore": 0.77,
                "LabelLevel": 2,
                "ParentLabelName": "其他事物"
            },
            {
                "Language": "zh-Hans",
                "LabelName": "其他事物",
                "LabelConfidence": 0.999,
                "CentricScore": 0.77,
                "LabelLevel": 1,
                "ParentLabelName": ""
            }
        ]
    }
    
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "4B2915C9-076B-036A-984D-****",
        "StartTime": "2023-01-04T05:12:37.361Z",
        "EndTime": "2023-01-04T05:12:37.872Z",
        "UserData": "test",
        "TaskType": "VideoLabelClassification",
        "TaskId": "VideoLabelClassification-0c420dd8-1029-48c4-a9ad-****",
        "Status": "Failed",
        "Code": "InvalidSourceURL", // Code不为空表示处理失败。
        "Message": "Unable to read the file", // 错误信息。
        "Labels": null
    }

文档处理

CreateOfficeConversionTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "A1DA7436-768B-061D-833C-****",
        "StartTime": "2023-01-04T05:03:40.928Z",
        "EndTime": "2023-01-04T05:03:41.444Z",
        "UserData": "test",
        "TaskType": "OfficeConversion",
        "TaskId": "OfficeConversion-ed315cab-7736-4ad8-8c56-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": ""
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "915CA9CD-5610-03FC-8500-****",
        "StartTime": "2023-01-04T05:04:13.063Z",
        "EndTime": "2023-01-04T05:04:13.442Z",
        "UserData": "test",
        "TaskType": "OfficeConversion",
        "TaskId": "OfficeConversion-2b646a78-d6cf-470b-9f26-****",
        "Status": "Failed",
        "Code": "Convert.Fail", // Code不为空表示处理失败。
        "Message": "Internal error, exit status 1" // 错误信息。
    }

文件处理

压缩解压

CreateFileCompressionTask接口MNS消息示例

{
    "ProjectName": "immtest",
    "DatasetName": "",
    "RequestId": "4DE5A2ED-221A-0FE2-8C03-****",
    "StartTime": "2023-01-04T05:04:51.41Z",
    "EndTime": "2023-01-04T05:04:54.832Z",
    "UserData": "test",
    "TaskType": "FileCompression",
    "TaskId": "FileCompression-d343b98d-924d-4bf7-bd4b-****",
    "Status": "Succeeded",
    "Code": "", // Code为空表示处理成功。
    "Message": ""
}

CreateFileUncompressionTask接口MNS消息示例

{
    "ProjectName": "immtest",
    "DatasetName": "",
    "RequestId": "D9CDFE0C-2BBB-0C3E-BB26-****",
    "StartTime": "2023-01-04T05:06:07.71Z",
    "EndTime": "2023-01-04T05:06:08.3Z",
    "UserData": "test",
    "TaskType": "FileUncompression",
    "TaskId": "FileUncompression-7f1efbcd-9897-40c5-9683-****",
    "Status": "Succeeded",
    "Code": "", // Code为空表示处理成功。
    "Message": ""
}

CreateArchiveFileInspectionTask接口MNS消息示例

{
    "ProjectName": "immtest",
    "DatasetName": "",
    "RequestId": "7F9642D6-BC23-05E6-A9A9-****",
    "StartTime": "2023-01-04T05:03:10.274Z",
    "EndTime": "2023-01-04T05:03:10.63Z",
    "UserData": "test",
    "TaskType": "ArchiveFileInspection",
    "TaskId": "ArchiveFileInspection-efb644ad-8e03-4819-ad1f-****",
    "Status": "Succeeded",
    "Code": "200", // Code为200表示处理成功
    "Message": "List Success"
}

点云压缩

CreateCompressPointCloudTask接口MNS消息示例

  • 处理成功消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "BFAF835C-10B0-0B64-9670-****",
        "StartTime": "2023-01-04T05:17:32.211Z",
        "EndTime": "2023-01-04T05:17:32.395Z",
        "UserData": "test",
        "TaskType": "PointCloudCompress",
        "TaskId": "PointCloudCompress-287b9635-97b3-4038-a31d-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": ""
    }
  • 处理失败消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "B39E157F-517B-069D-905D-****",
        "StartTime": "2023-01-04T05:17:10.399Z",
        "EndTime": "2023-01-04T05:17:10.631Z",
        "UserData": "test",
        "TaskType": "PointCloudCompress",
        "TaskId": "PointCloudCompress-97dcbbe1-079a-4efe-8e8d-****",
        "Status": "Failed",
        "Code": "NotFound.TargetURIPrefix", // Code不为空表示处理失败。
        "Message": "not found oss://test-bucket/test-object" // 错误信息。
    }

内容安全

CreateImageModerationTask接口MNS消息示例

  • 审核通过消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "EFB1924D-65E8-0C99-90F9-****",
        "StartTime": "2023-01-04T05:17:51.791Z",
        "EndTime": "2023-01-04T05:17:52.257Z",
        "UserData": "test",
        "TaskType": "ImageModeration",
        "TaskId": "ImageModeration-dc2179f5-4c68-417e-8fa6-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": "",
        "URI": "oss://test-bucket/test-object",
        "Suggestion": "pass", // 建议通过。
        "Categories": []
    }
    
  • 审核不通过消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "308F6D1A-4B38-0398-B652-****",
        "StartTime": "2023-01-04T05:12:29.362Z",
        "EndTime": "2023-01-04T05:12:29.915Z",
        "UserData": "test",
        "TaskType": "ImageModeration",
        "TaskId": "ImageModeration-49bc8b0f-6c83-4432-8914-****",
        "Status": "Succeeded",
        "Code": "", // Code为空表示处理成功。
        "Message": "",
        "URI": "oss://test-bucket/test-object",
        "Suggestion": "block", // 建议不通过。
        "Categories": [ // 包含非法内容的分类项。
            "porn"
        ]
    }
    
  • 需要人工审核的消息示例。

    {
        "ProjectName": "immtest",
        "DatasetName": "",
        "RequestId": "6E0C4FD3-5AD1-0885-B092-****",
        "StartTime": "2023-01-04T05:16:50.44Z",
        "EndTime": "2023-01-04T05:16:50.956Z",
        "UserData": "test",
        "TaskType": "ImageModeration",
        "TaskId": "ImageModeration-9eba1545-7f06-4bcb-9704-****",
        "Status": "Running",
        "Code": "", // Code为空表示处理成功。
        "Message": "",
        "URI": "oss://test-bucket/test-object",
        "Suggestion": "review", // 需要人工审核。
        "Categories": []
    }