GetSmartClipTask

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.

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
aimiaobi:GetSmartClipTask	create	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:GetSmartClipTask

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Unique identifier of your Alibaba Cloud Model Studio workspace. To get the workspace ID, see Get the workspace ID.	xxxx
TaskId	string	Yes	Unique identifier of the task. You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId for multiple tasks, those tasks belong to the same conversation group.	task-03d46184ee7d8749

Response elements

Element	Type	Description	Example
	object	PlainResult
Code	string	Status code	NoData
Data	object	Task response
Status	string	Task status: PENDING: Pending RUNNING: Running SUCCESSED: Succeeded FAILED: Failed CANCELED: Canceled	RUNNING
ErrorMessage	string	Error message	Error message
SubJobs	array<object>	List of subtasks
	array<object>	Subtask
SubJobId	string	Subtask ID	xxxxx
Status	string	Subtask status: PENDING: Pending RUNNING: Running SUCCESSED: Succeeded FAILED: Failed CANCELED: Canceled	RUNNING
ErrorMessage	string	Error message	Invalid file name
FileKey	string	File key	oss://default/bucket-name/path-xxx/xxx-1.mp4
FileAttr	object	File attributes
FileName	string	Video file name	2024-12-12.mp4
FileLength	string	Video file size	290804
TmpUrl	string	Temporary URL to access the video file. Expires in one hour.	http://www.example.com/tmp.mp4
Duration	number	Video duration in seconds	120
Height	integer	Video height	1080
Width	integer	Video width	1920
HttpStatusCode	integer	HTTP status code	200
Message	string	Error description	success
RequestId	string	Unique identifier of the request	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the operation succeeded. true indicates success. false indicates failure.	true

Examples

Success response JSON format

{
  "Code": "NoData",
  "Data": {
    "Status": "RUNNING",
    "ErrorMessage": "错误信息",
    "SubJobs": [
      {
        "SubJobId": "xxxxx",
        "Status": "RUNNING",
        "ErrorMessage": "文件名错误",
        "FileKey": "oss://default/bucket-name/path-xxx/xxx-1.mp4",
        "FileAttr": {
          "FileName": "2024-12-12.mp4",
          "FileLength": "290804",
          "TmpUrl": "http://www.example.com/tmp.mp4",
          "Duration": 120,
          "Height": 1080,
          "Width": 1920
        }
      }
    ]
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes