使用CreateStory建立相簿故事-Intelligent Media Management-阿里雲

建立一個故事

介面說明

請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格。
調用該介面前，請確保您已通過綁定方式（ 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

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectName	string	是	專案名稱。擷取方式請參見建立專案。	test-project
DatasetName	string	是	資料集名稱。擷取方式請參見建立資料集。	test-dataset
ObjectId	string	否	故事物件識別碼。該參數不是必填參數。如果為空白，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	integer	否	產生的故事中包含的照片檔案最小個數，實際產生的故事照片數量會在 MinFileCount 和 MaxFileCount 之間。該參數取值為大於 1 的整數，若待產生故事的候選照片集中的可用照片張數小於該參數，則會返回空故事。	1
MaxFileCount	integer	否	產生的故事中包含的照片檔案最大個數，產生的故事照片數量會在 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	否	此參數提供一種標籤機制，可在以下情境中使用：設定自訂資料，這些資料會在 MNS 訊息中返回。作為搜尋條件搜尋任務。作為變數在 TargetURI 中使用。	{"key":"val"}
UserData	string	否	使用者自訂資訊，在非同步訊息通知中會為您返回，用於方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Notification	Notification	否	訊息通知配置，詳細內容請單擊 Notification 查看，非同步通知訊息格式請參見非同步通知訊息格式。

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	當次請求的 Request ID。	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskId	string	任務 ID。	CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****
EventId	string	事件 ID。	392-1CqzvESGTEeNZ2OWFbRKIM****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "TaskId": "CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****",
  "EventId": "392-1CqzvESGTEeNZ2OWFbRKIM****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。