Creates a story based on the specified images and videos.
Operation description
- Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
- Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the CreateBinding operation or manually by calling the IndexFileMeta or BatchIndexFileMeta operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| imm:CreateCustomizedStory | create | *Dataset acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | immtest | |
| DatasetName | string | Yes | dataset001 | |
| StoryType | string | Yes | The type of the story. For information about valid types, see Story types and subtypes. | PeopleMemory |
| StorySubType | string | Yes | The subtype of the story. For information about valid subtypes, see Story types and subtypes. | Solo |
| StoryName | string | Yes | The name of the story. | name1 |
| Cover | object | Yes | The cover image of the story. You can specify an image as the cover image of the custom story. | |
| URI | string | Yes | The URI of the cover image. | oss://bucket1/cover |
| Files | array<object> | Yes | The files of the story. You can specify up to 100 files in a custom story. | |
| object | Yes | |||
| URI | string | Yes | The URIs of the files. | [{"URI":"oss://bucket1/file1"}] |
| CustomLabels | object | No | The custom labels. You can specify labels to help you identify and retrieve the story. | {"Bucket": "examplebucket"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BC91D091-D49F-0ACD-95D5-F0621045****",
"ObjectId": "563062c0b085733f34ab****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|