CreateStory API を呼び出してストーリーを生成 - IMM

ストーリーを作成します。

操作説明

この操作を呼び出す前に、Intelligent Media Management (IMM) の課金方法と料金を理解してください。
この操作を呼び出す前に、CreateBinding、IndexFileMeta、または BatchIndexFileMeta を呼び出して、ファイルをデータセットにインデックス化する必要があります。
これは非同期操作です。タスクが開始されると、その情報は 7 日間のみ保存されます。この期間を過ぎると、情報を取得できなくなります。返された TaskId を使用して GetTask または ListTasks を呼び出してタスク情報を表示します。または、Notification パラメーターを設定して、通知メッセージからタスク情報を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

imm:CreateStory

create

*Dataset

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectName	string	必須	プロジェクトの名前。詳細については、「プロジェクトの作成」をご参照ください。	test-project
DatasetName	string	必須	データセットの名前。詳細については、「データセットの作成」をご参照ください。	test-dataset
ObjectId	string	任意	ストーリーオブジェクトの ID。このパラメーターはオプションです。 ID を指定しない場合、IMM が ID を生成します。ストーリー ID を使用して、ストーリーのクエリや更新ができます。既存の ID を指定すると、対応するストーリーが更新されます。	id1
StoryType	string	必須	生成するストーリーのタイプ。ストーリーのタイプとその有効な値の詳細については、「ストーリーのタイプとサブタイプ」をご参照ください。	PeopleMemory
StorySubType	string	任意	生成するストーリーのサブタイプ。ストーリーのサブタイプとその有効な値の詳細については、「ストーリーのタイプとサブタイプ」をご参照ください。	Solo
StoryStartTime	string	任意	ストーリーの写真コレクションの開始時刻。このパラメーターと StoryEndTime は、時間範囲を定義します。 IMM は、この時間範囲内の候補写真をフィルターしてストーリーを生成します。値は RFC 3339 フォーマットの文字列である必要があります。	2016-12-30T16:00:00Z
StoryEndTime	string	任意	ストーリーの写真コレクションの終了時刻。このパラメーターと StoryStartTime は、時間範囲を定義します。 IMM は、この時間範囲内の候補写真をフィルターしてストーリーを生成します。値は RFC 3339 フォーマットの文字列である必要があります。	2021-12-30T16:00:00Z
StoryName	string	任意	ストーリーの名前。	name1
MinFileCount	integer	任意	生成されるストーリー内の写真の最小数。実際の写真の数は、MinFileCount と MaxFileCount の値の間になります。値は 1 より大きい整数である必要があります。利用可能な候補写真の数がこの値より少ない場合、空のストーリーが返されます。	1
MaxFileCount	integer	任意	生成されるストーリー内の写真の最大数。実際の写真の数は、MinFileCount と MaxFileCount の値の間になります。値は MinFileCount の値より大きい整数である必要があります。生成されるストーリーの品質を確保するため、内部アルゴリズムは写真の最大数を 1,500 枚に制限します。 MaxFileCount を 1,500 より大きい値に設定しても、その設定は有効になりません。	3
NotifyTopicName	string	任意	非同期通知用の Topic の名前。	test-topic
CustomLabels	object	任意	カスタムラベル。これらのラベルには、ストーリーに関するカスタム情報が含まれており、取得に使用できます。	{"Bucket": "examplebucket"}
CustomId	string	任意	ストーリーのカスタム識別子。この ID は ObjectId とは異なる場合があります。この ID を使用して、ストーリーを取得またはソートできます。	test
Address	AddressForStory	任意	ストーリーの住所情報。 IMM は、撮影場所が指定された住所と一致する写真をフィルターして、ストーリーを生成します。このパラメーターは、StoryType が TravelMemory に設定されている場合にのみ有効になります。説明規制要件により、GPS 情報の住所への解析は、香港 (中国)、マカオ (中国)、台湾 (中国)、または中国本土以外のリージョンではサポートされていません。
Tags	object	任意	このパラメーターは、次のシナリオで使用できるタグ付けメカニズムを提供します： MNS メッセージで返されるカスタムデータを設定します。タスクを検索するための検索条件として使用します。 TargetURI の変数として使用します。	{"key":"val"}
UserData	string	任意	非同期通知メッセージで返されるカスタム情報。この情報を使用して、通知メッセージをサービスに関連付けることができます。最大長は 2,048 バイトです。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Notification	Notification	任意	通知設定。非同期通知メッセージのフォーマットの詳細については、「非同期通知メッセージのフォーマット」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエストの ID。	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskId	string	タスクの ID。	CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****
EventId	string	イベントの ID。	392-1CqzvESGTEeNZ2OWFbRKIM****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。