QueryStories_智能媒体管理_API文档

2020-09-30

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
调用该接口前，请确保已经使用创建故事或者创建自定义故事接口生成过相册故事。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

imm:QueryStories	List	Dataset acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}	无	无

请求参数

字段名称	字段详情
ProjectNamestring	项目名称。获取方式请参见创建项目。示例值:test-project参考取值来源: UpdateProject CreateProject ListProjects
DatasetNamestring	数据集名称。获取方式请参见创建数据集。示例值:test-dataset参考取值来源: CreateDataset UpdateDataset ListDatasets
ObjectIdstring	故事对象 ID。示例值:id1
StoryNamestring	故事名称。示例值:name1参考取值来源: GetStory CreateCustomizedStory
StoryTypestring	故事类型。可取值请参见故事类型和子类型。示例值:TimeMemory参考取值来源: GetStory CreateStory
StorySubTypestring	故事子类型。可取值请参见故事类型和子类型。示例值:SeasonHighlights参考取值来源: GetStory CreateCustomizedStory
FigureClusterIdsarray<string>	人物聚类的 ID 列表。
CreateTimeRangeTimeRange	时间范围对象。
StoryStartTimeRangeTimeRange	时间范围对象。
StoryEndTimeRangeTimeRange	时间范围对象。
NextTokenstring	在查询结果过多需要翻页时使用，标记当前开始读取的位置，置空表示从头开始；翻页读取时，则需传入上次调用该接口返回的 NextToken 值。示例值:MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****
MaxResultsinteger<int64>	本次读取的最大数据记录数量。取值范围为[1,100]。默认值为 100。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10
CustomLabelsstring	自定义标签键值对。查询满足此标签对的故事。示例值:key=value
WithEmptyStoriesboolean	是否返回空故事。取值范围如下：展开详情示例值:true
Sortstring	排序字段，取值范围如下：展开详情示例值:CreateTime
Orderstring	排序方式。取值范围如下：展开详情示例值:asc

返回参数

字段名称	字段详情
RequestIdstring	当次请求的 Request ID。示例值:2C5C1E0F-D8B8-4DA0-8127-EC32C771****
Storiesarray<Story>	查询的故事列表。
NextTokenstring	表示当前调用返回读取到的位置，空代表数据已经读取完毕。示例值:MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****

返回示例

变更历史

	变更时间	变更内容概要	操作
	2022-02-24	新增请求参数Sort 新增请求参数Order

相关示例