Release Notes
Announcements
API | Operation | Description |
Deleting workflow | Deletes workflow | |
Querying workflow | Queries workflow | |
Querying workflow instance details | Queries workflow instance details | |
Querying workflow details list | Gets workflow instance list | |
Triggering workflow | Executes workflow |
public Boolean deleteWorkflow(MediaWorkflowListRequest request);
Request has the following sub-nodes:Node Name (Keyword) | Description | Type | Required |
bucketName | String | Yes | |
workflowId | Workflow ID | String | Yes |
true is returned upon success.CosClientException or CosServiceException exception. For more information, see Troubleshooting.//1. Create a workflow request objectMediaWorkflowListRequest request = new MediaWorkflowListRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");request.setWorkflowId("aaaa");Boolean response = client.deleteWorkflow(request);
public MediaWorkflowListResponse describeWorkflow(MediaWorkflowListRequest request);
Parameter | Description | Type | Required |
bucketName | String | Yes | |
ids | Workflow ID. If you enter multiple IDs, separate them with commas (,). | String | No |
name | Workflow name. | String | No |
pageNumber | Page number. | String | No |
pageSize | Number of entries per page. | String | No |
//1. Create a workflow request objectMediaWorkflowListRequest request = new MediaWorkflowListRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");MediaWorkflowListResponse response = client.describeWorkflow(request);List<MediaWorkflowObject> mediaWorkflowList = response.getMediaWorkflowList();
public MediaWorkflowExecutionResponse describeWorkflowExecution(MediaWorkflowListRequest request);
Parameter | Description | Type | Required |
bucketName | String | Yes | |
runId | Workflow instance ID | String | Yes |
//1. Create a workflow request objectMediaWorkflowListRequest request = new MediaWorkflowListRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");request.setRunId("i34bfd8d7eae711ea89fe525400c******");MediaWorkflowExecutionResponse response = client.describeWorkflowExecution(request);
public MediaWorkflowExecutionsResponse describeWorkflowExecutions(MediaWorkflowListRequest request);
Node Name | Description | Type | Required |
bucketName | String | Yes | |
workflowId | Workflow ID | String | Yes |
name | Filename | String | No |
orderByTime | Desc (default) or Asc | String | No |
size | Maximum number of jobs that can be pulled. The default value is 10. The maximum value is 100. | String | No |
states | Workflow instance status. If you enter multiple statuses, separate them with commas (,). Valid values: All, Success, Failed, Running, Cancel. Default value: All | String | No |
startCreationTime | Start time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z | String | No |
endCreationTime | End time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z | String | No |
nextToken | Context token for pagination | String | No |
//1. Create a workflow request objectMediaWorkflowListRequest request = new MediaWorkflowListRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");request.setWorkflowId("w4e6963a18e2446ed8bc8f09410e******");MediaWorkflowExecutionsResponse response = client.describeWorkflowExecutions(request);List<MediaWorkflowExecutionObject> workflowExecutionList = response.getWorkflowExecutionList();
public MediaWorkflowListResponse triggerWorkflowList(MediaWorkflowListRequest request);
//1. Create a workflow request objectMediaWorkflowListRequest request = new MediaWorkflowListRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("DemoBucket-123456789");request.setWorkflowId("we32f75950afe4a4682463d8158d*****");request.setObject("1.mp4");MediaWorkflowListResponse response = client.triggerWorkflowList(request);
Node Name | Description | Type | Required |
bucketName | String | Yes | |
object | Name of the object that requires workflow processing | String | Yes |
workflowId | ID of the workflow to trigger | String | Yes |
name | Name of the existing triggered job, which can contain up to 128 letters, digits, hyphens, and underscores and is empty by default. | String | No |
MediaWorkflowListResponse instance is returned.Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback