文档

SearchStories - 查询故事列表

更新时间:

根据用户指定的条件,查询指定 drive 空间下的故事列表。

接口说明

请确保在使用该接口前,已充分了解 PDS 的收费方式和价格

使用此功能须开通增值服务图片处理功能。

使用查询故事列表前,需要用户调用 CreateStory 或 CreateCustomizedStory 接口创建故事,否则返回空列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/image/find_stories

请求参数

名称类型必填描述示例值
bodyobject

请求参数

drive_idstring

空间 id

1
story_idstring

故事 id

9132e0d8-fe92-4e56-86c3-f5f112308003
story_typestring

故事类型。由用户创建时指定。

PeopleMemory
story_namestring

故事名称。 长度不超过 1024 字节。

美食
story_start_time_rangeobject

创建故事照片或视频的开始时间范围

startstring

起始时间。时间格式为 RFC3339。

2016-12-31T00:00:00+08:00
endstring

结束时间。时间格式为 RFC3339。

2022-12-31T00:00:00+08:00
story_end_time_rangeobject

创建故事照片或视频的结束时间范围

startstring

起始时间。时间格式为 RFC3339。

2016-12-31T00:00:00+08:00
endstring

结束时间。时间格式为 RFC3339。

2022-12-31T00:00:00+08:00
create_time_rangeobject

创建故事时间范围

startstring

起始时间。时间格式为 RFC3339。

2016-12-31T00:00:00+08:00
endstring

结束时间。时间格式为 RFC3339。

2022-12-31T00:00:00+08:00
face_group_idsarray

人脸分组列表。 查询人物故事时使用。

string

人脸分组 id

Cluster-be377f73-3502-433c-8309-a01e659c128c
custom_labelsstring

自定义标签。 可查询多个字段,使用 "," 分隔。

key1=value1,key2!=value2
with_empty_storiesboolean

是否返回空故事。默认 false。

false
markerstring

查询的起始位置。若为空则表示从头开始查询。

NWQ1Yjk4YmI1ZDODBhNDQ2Nzhl***
limitlong

限定此次返回资源的数量,取值范围[1,100]。 默认 100。 返回结果可以小于指定的数量,但不能多于指定的数量。

100
sortstring

排序字段

枚举值:
  • StoryName按故事名称排序
  • StoryEndTime按故事结束时间排序
  • CreateTime按故事创建时间排序
  • StoryStartTime按故事开始时间排序
CreateTime
orderstring

排序方式

枚举值:
  • asc升序
  • desc降序
desc
cover_image_thumbnail_processstring

图片封面缩略图控制参数

image/resize,m_fill,h_128,w_128,limit_0/format,jpg
cover_video_thumbnail_processstring

视频封面缩略图控制参数

video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto
url_expire_seclong

缩略图过期时间。单位为秒,最短 10 秒,最长 86400 秒。

900

返回参数

名称类型描述示例值
object

返回参数

itemsarray

故事列表

Story

故事详情

next_markerstring

下次查询位置

Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***

示例

正常返回示例

JSON格式

{
  "items": [
    {
      "story_id": "9132e0d8-fe92-4e56-86c3-f5f112308003",
      "story_type": "PeopleMemory",
      "story_sub_type": "Solo",
      "story_name": "test_name",
      "story_start_time": "2021-01-14T10:17:18.102700407+08:00",
      "story_end_time": "2022-01-14T10:17:18.102700407+08:00",
      "created_at": "2022-01-14T10:17:18.102700407+08:00",
      "updated_at": "2022-01-14T10:17:18.102700407+08:00",
      "face_group_ids": [
        "Cluster-be377f73-3502-433c-8309-a01e659c128c"
      ],
      "cover_file_id": "63e5e4340f76cb3ead5f40f68163f0f967c1a7bf",
      "cover_file_thumbnail_url": "https://pds-domain-bucket.oss-cn-hangzhou.aliyuncs.com/Bh1HqdAs%2F1001%2F642a88c26f99cad589904fc8a6b2db6021c6601f%2F642a88c29391c47f221e49e88a21fa9b0a9e5063?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5eGE8nGtYZ59bSnbUODlmsjTttVhpbFpjz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNXD6XXO2qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABVgD3mIAeUoDYKTJrFTPdmAPIrlUUQ1HZstB0ZVHvYByygr3oeitG9FEQ8lcfaZYJOtWRchdgH8tsSwHj2jI1vMeAiLHgbW98SPA3yfN8OR1kLW73uq3LAvekc9Qldz33YTM4JA5MNJzR8x5O6Oe4rY5OMSSVU5F%2Ffr8bJZD%2FXMM%3D&x-oss-access-key-id=STS.NT3XsrXYXBvLoe2rkvBTyiSnD&x-oss-expires=1685966251&x-oss-process=image%2Fresize%2Cw_500&x-oss-signature=XimW6haBxYktKg4cstMfpd%2F2LSoMibj6A%2B7ZqBJcSbQ%3D&x-oss-signature-version=OSS2",
      "story_file_list": [
        {
          "domain_id": "bj1",
          "drive_id": "1",
          "file_id": "5d79206586bb5dd69fb34c349282718146c55da7",
          "name": "1.mov",
          "type": "file",
          "content_type": "application/json",
          "created_at": "2019-08-20T06:51:27.292Z",
          "updated_at": "2019-08-20T06:51:27.292Z",
          "description": "image file",
          "trashed_at": "2019-08-20T06:51:27.292Z",
          "file_extension": "txt",
          "mime_type": "video/quicktime",
          "mime_extension": "mov",
          "hidden": false,
          "size": 1024,
          "starred": false,
          "status": "available",
          "user_meta": "k1=v1,k2=v2",
          "labels": [
            "[\"label1:1\", \"label2:2\"]"
          ],
          "upload_id": "C9DCFE5A82644AC7A02DB74C30C934A6",
          "parent_file_id": "3d5b846942cf94fa72324c8a4bda34e81da635a",
          "crc64_hash": "3574582125365864471",
          "content_hash": "EA4942AA8761213890A5C386F88E6464D2C31CA3",
          "content_hash_name": "sha1",
          "download_url": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
          "thumbnail": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
          "category": "image",
          "local_created_at": "2019-08-20T06:51:27.292Z",
          "local_modified_at": "2019-08-20T06:51:27.292Z",
          "revision_id": "5d5b846942cf94fa72324c14a4bda34e81da635d",
          "investigation_info": {
            "status": 4,
            "suggestion": "pass"
          },
          "thumbnail_urls": {
            "key": "\"128X128\": \"https://url1\", \"800X800\": \"url2\""
          },
          "image_media_metadata": {
            "time": "2006-01-02T15:04:05.000Z07:00",
            "width": 1024,
            "height": 1024,
            "location": "30.185453,120.218522",
            "country": "China",
            "province": "Zhejiang",
            "city": "Hangzhou",
            "district": "Xihu",
            "township": "Xihu",
            "address_line": "Zhejiang hangzhou xihu",
            "image_tags": [
              {
                "confidence": 0.98,
                "parent_name": "sport",
                "name": "basketball",
                "tag_level": 3,
                "source": "play basketball",
                "centric_score": 0.877
              }
            ],
            "faces": "[{\"FaceId\":\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\",\"GroupId\":\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\",\"FaceConfidence\":0.999,\"Age\":13,\"AgeConfidence\":4,\"Gender\":\"female\",\"GenderConfidence\":1,\"Emotion\":\"none\",\"EmotionConfidence\":0.672,\"FaceAttributes\":{\"Mask\":\"none\",\"MaskConfidence\":0.894,\"Beard\":\"none\",\"BeardConfidence\":0.997,\"Glasses\":\"none\",\"GlassesConfidence\":0.999,\"Mouth\":\"close\",\"MouthConfidence\":0.937,\"Hat\":\"none\",\"HatConfidence\":0.998,\"HeadPose\":{\"Pitch\":10.684,\"Roll\":-10.707,\"Yaw\":-20.094},\"FaceBoundary\":{\"Width\":457,\"Height\":687,\"Top\":1324,\"Left\":1356}}}]",
            "faces_thumbnail": [
              {
                "face_id": "a9a66a86-73dd-4c95-8b79-1d8a49db5226",
                "face_group_id": "Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0",
                "face_thumbnail": "https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2"
              }
            ],
            "exif": "{\"Compression\":{\"value\":\"6\"},\"DateTime\":{\"value\":\"2020:08:19 17:11:11\"}}",
            "image_quality": {
              "overall_score": 0.736
            }
          },
          "ex_fields_info": {
            "key": ""
          },
          "content_uri": "",
          "streams_info": {
            "key": {
              "crc64_hash": "",
              "size": 0,
              "content_hash": "",
              "content_hash_name": "",
              "download_url": "",
              "url": "",
              "thumbnail": ""
            }
          },
          "user_tags": {
            "key": "\"k1\":\"v1\", \"k2\",\"v2\""
          },
          "revision_version": 1,
          "video_media_metadata": {
            "time": "2006-01-02T15:04:05.000Z07:00",
            "width": 1920,
            "height": 1080,
            "location": "30.185453,120.218522",
            "country": "China",
            "province": "Zhejiang",
            "city": "Hangzhou",
            "district": "Xihu",
            "township": "Xihu",
            "address_line": "Zhejiang hangzhou xihu",
            "video_media_video_stream": [
              {
                "duration": "22.88",
                "bitrate": "108420",
                "code_name": "h264",
                "frame_count": "90"
              }
            ],
            "video_media_audio_stream": [
              {
                "duration": "7704.573000",
                "bit_rate": "129280",
                "code_name": "aac"
              }
            ]
          },
          "punish_flag": 1,
          "id_path": "id1/id2",
          "name_path": "root/f1/f2",
          "creator_type": "",
          "creator_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
          "creator_name": "AB***CD",
          "last_modifier_type": "",
          "last_modifier_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
          "last_modifier_name": "AB***CD",
          "dir_size_info": {
            "dir_count": 1,
            "file_count": 10
          },
          "trashed": true
        }
      ],
      "custom_id": "test",
      "custom_labels": {
        "key": "value"
      }
    }
  ],
  "next_marker": "Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***"
}

错误码

访问错误中心查看更多错误码。