GetYikeStoryboardJob - Intelligent Media Services - Alibaba Cloud Documentation Center

Retrieves the details of a Yike storyboard job.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:GetYikeStoryboardJob

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The storyboard job ID.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
JobId	string	The storyboard job ID. You can obtain this ID from the response parameters of the SubmitStoryboardJob operation.	**a046-263c-3560-978a-fb287782**
JobParams	object	A JSON object that contains the parameters for the job. The structure of this object varies based on the AI algorithm.
FileURL	string	The OSS URL of the file.	https://test.oss-cn-shanghai.aliyuncs.com/test.mp4
ShotPromptMode	string	The shot generation mode.	multi
SourceType	string	The source type.	Novel
ModelParams	string	The model parameters.	{ "AudioEnable": false }
ShotSplitMode	string	The shot splitting mode.	firstPersonNarration
NarrationVoiceId	string	The narration voice.	sys_YoungGracefulWoman
VideoModel	string	The video model.	wan2.6-r2v-flash
StyleId	string	The style ID.	RealisticPhotography
Resolution	string	The resolution of the generated video.	1K
Title	string	The job title. - Maximum length: 128 bytes. - UTF-8 encoding.	test-title
AspectRatio	string	The aspect ratio of the video.	16:9
JobStatus	string	The job status. Valid values: Succeeded: The job completed successfully. Failed: The job failed to complete. Running: The job is in progress.	Succeeded
JobResult	object	The job result.
OutputUrl	string	The downloadable OSS URL.	https://test.oss-cn-shanghai.aliyuncs.com/test.mp4
SuccessStoryboardList	string	A list of IDs for successful storyboards.	[\"st_2118280473\"]
ExceptionStoryboardIds	string	A list of IDs for storyboards that encountered an exception.	[\"st_2053348871\"]
FailureShotList	string	A list of shots that failed to generate.	[{\"errorCode\":\"NoMediaData\",\"storyboardId\":\"st_2118280473\",\"shotId\":\"54\"}]
SuccessStoryboardIds	string	A comma-separated list of successful storyboard IDs.	st_2118280473, st_2118280471
StoryboardInfoList	string	Detailed information about each storyboard in the job.	[{\"storyboardId\":\"st_1541525214\",\"title\":\"test_1\",\"status\":\"Produced\",\"subStatus\":\"ProduceSucc\"},{\"storyboardId\":\"st_1633435355\",\"title\":\"test_2\",\"status\":\"Produced\",\"subStatus\":\"ProduceSucc\"}]

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "JobId": "****a046-263c-3560-978a-fb287782****",
  "JobParams": {
    "FileURL": "https://test.oss-cn-shanghai.aliyuncs.com/test.mp4",
    "ShotPromptMode": "multi",
    "SourceType": "Novel",
    "ModelParams": "{\n  \"AudioEnable\": false\n}",
    "ShotSplitMode": "firstPersonNarration",
    "NarrationVoiceId": "sys_YoungGracefulWoman",
    "VideoModel": "wan2.6-r2v-flash",
    "StyleId": "RealisticPhotography",
    "Resolution": "1K",
    "Title": "test-title",
    "AspectRatio": "16:9"
  },
  "JobStatus": "Succeeded",
  "JobResult": {
    "OutputUrl": "https://test.oss-cn-shanghai.aliyuncs.com/test.mp4",
    "SuccessStoryboardList": "[\\\"st_2118280473\\\"]",
    "ExceptionStoryboardIds": "[\\\"st_2053348871\\\"]",
    "FailureShotList": "[{\\\"errorCode\\\":\\\"NoMediaData\\\",\\\"storyboardId\\\":\\\"st_2118280473\\\",\\\"shotId\\\":\\\"54\\\"}]",
    "SuccessStoryboardIds": "st_2118280473, st_2118280471",
    "StoryboardInfoList": "[{\\\"storyboardId\\\":\\\"st_1541525214\\\",\\\"title\\\":\\\"test_1\\\",\\\"status\\\":\\\"Produced\\\",\\\"subStatus\\\":\\\"ProduceSucc\\\"},{\\\"storyboardId\\\":\\\"st_1633435355\\\",\\\"title\\\":\\\"test_2\\\",\\\"status\\\":\\\"Produced\\\",\\\"subStatus\\\":\\\"ProduceSucc\\\"}]"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.