根据条件查询故事及其信息。
接口说明
- 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格。
- 调用该接口前,请确保您已通过绑定方式( CreateBinding )或者主动索引( IndexFileMeta 或者 BatchIndexFileMeta )方式将文件索引到数据集(Dataset)中。
- 调用该接口前,请确保已经使用创建故事或者创建自定义故事接口生成过相册故事。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:QueryStories | list | *Dataset acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称。获取方式请参见创建项目。 | test-project |
| DatasetName | string | 是 | 数据集名称。获取方式请参见创建数据集。 | test-dataset |
| ObjectId | string | 否 | 故事对象 ID。 | id1 |
| StoryName | string | 否 | 故事名称。 | name1 |
| StoryType | string | 否 | 故事类型。可取值请参见故事类型和子类型。 | TimeMemory |
| StorySubType | string | 否 | 故事子类型。可取值请参见故事类型和子类型。 | SeasonHighlights |
| FigureClusterIds | array | 否 | 人物聚类的 ID 列表。 | |
| string | 否 | 人物聚类的 ID。 | Cluster-773d9c7e-3fd4-480c-a24b-30a82**** | |
| CreateTimeRange | TimeRange | 否 | 创建故事时间范围。 | |
| StoryStartTimeRange | TimeRange | 否 | 创建故事照片或视频的开始时间范围。 | |
| StoryEndTimeRange | TimeRange | 否 | 创建故事照片或视频的结束时间范围。 | |
| NextToken | string | 否 | 在查询结果过多需要翻页时使用,标记当前开始读取的位置,置空表示从头开始;翻页读取时,则需传入上次调用该接口返回的 NextToken 值。 | MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw**** |
| MaxResults | long | 否 | 本次读取的最大数据记录数量。取值范围为[1,100]。默认值为 100。 | 10 |
| CustomLabels | string | 否 | 自定义标签键值对。查询满足此标签对的故事。 | key=value |
| WithEmptyStories | boolean | 否 | 是否返回空故事。取值范围如下:
| true |
| Sort | string | 否 | 排序字段,取值范围如下:
| CreateTime |
| Order | string | 否 | 排序方式。取值范围如下:
| asc |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "2C5C1E0F-D8B8-4DA0-8127-EC32C771****",
"NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****",
"Stories": [
{
"ObjectType": "story",
"StoryName": "name1",
"Cover": {
"OSSURI": "",
"URI": ""
},
"OwnerId": 1023210024677934,
"ProjectName": "test-project",
"ObjectId": "id1",
"DatasetName": "test-dataset",
"StoryEndTime": "1754-08-31T06:49:24.128654848+08:05",
"CreateTime": "2022-01-12T12:47:44.714010629+08:00",
"StorySubType": "ImportantPerson",
"StoryStartTime": "1754-08-31T06:49:24.128654848+08:05",
"StoryType": "PeopleMemory"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史
