创建一个故事。
接口说明
- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
- 调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
- 该接口为异步接口，任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或者 ListTasks 接口获取返回的 TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:CreateStory | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称。获取方式请参见创建项目。 | test-project |
| DatasetName | string | 是 | 数据集名称。获取方式请参见创建数据集。 | test-dataset |
| ObjectId | string | 否 | 故事对象 ID。该参数不是必填参数。如果为空，IMM 会为生成的故事创建一个 ID，该 ID 是故事的唯一标识符，可用于对该故事的查询、更新等操作。ID 也可由用户生成，生成之后通过该参数传入，IMM 可记录下用户传入的 ID 作为该故事的唯一标识。如果传入已存在的 ID，则会更新该 ID 对应的故事。 | id1 |
| StoryType | string | 是 | 故事类型，指定需要生成相册故事的类型。具体类型描述和可取值请参见故事类型和子类型。 | PeopleMemory |
| StorySubType | string | 否 | 故事子类型，指定需要生成的相册故事的子类型，具体类型描述和可取值请参见故事类型和子类型。 | Solo |
| StoryStartTime | string | 否 | 待创建故事的照片集合的开始时间。与 StoryEndTime 共同组成时间区间，IMM 会根据该时间区间来筛选候选照片生成故事。该参数是一个 RFC3339 时间格式的字符串。 | 2016-12-30T16:00:00Z |
| StoryEndTime | string | 否 | 待创建故事的照片集合的结束时间。与 StoryStartTime 共同组成时间区间，IMM 会根据该时间区间来筛选候选照片生成故事。该参数是一个 RFC3339 时间格式的字符串。 | 2021-12-30T16:00:00Z |
| StoryName | string | 否 | 故事名称。 | name1 |
| MinFileCount | long | 否 | 生成的故事中包含的照片文件最小个数，实际生成的故事照片数量会在 MinFileCount 和 MaxFileCount 之间。该参数取值为大于 1 的整数，若待生成故事的候选照片集中的可用照片张数小于该参数，则会返回空故事。 | 1 |
| MaxFileCount | long | 否 | 生成的故事中包含的照片文件最大个数，生成的故事照片数量会在 MinFileCount 和 MaxFileCount 之间。该参数取值范围为大于 MinFileCount 的整数。（为保证故事生成的效果，算法内部会将最大数量限制在 1500，当 MaxFileCount 大于 1500 时，该参数没有效果） | 3 |
| NotifyTopicName | string | 否 | 异步反向通知的 TopicName。 | test-topic |
| CustomLabels | object | 否 | 自定义标签。该标签标记了用户对该故事自定义的信息，可作检索使用。 | {"Bucket": "examplebucket"} |
| CustomId | string | 否 | 自定义 ID。用户自定义的生成故事的标识（可与 ObjectID 不相同），可供用户后期对故事进行检索、排序等。 | test |
| Address | AddressForStory | 否 | 待生成故事的地址信息。IMM 会根据该参数标识出的地址位置信息，筛选拍摄地符合该地址信息的照片生成故事，该参数在故事类型为旅行故事（TravelMemory）时生效。 说明
根据相关规定，无法在中国香港、中国澳门、中国台湾及海外提供将中国内地的 GPS 信息解析为地址的能力。
| |
| Tags | object | 否 | 此参数提供一种标签机制，可在以下场景中使用：
| {"key":"val"} |
| UserData | string | 否 | 用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 | {"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"} |
| Notification | Notification | 否 | 消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
"TaskId": "CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****",
"EventId": "392-1CqzvESGTEeNZ2OWFbRKIM****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-09 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-08-16 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2022-08-16 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |