ListTriggers API Overview: Filter by Tag & Status - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

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

imm:ListTriggers

list

*Trigger

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. You can obtain the name of the project from the response of the CreateProject operation.	test-project
State	string	No	The status of the trigger. Valid values: Ready: The trigger is ready. Running: The trigger is running. Failed: The trigger failed and cannot be automatically recovered. Suspended: The trigger is suspended. Succeeded: The trigger is complete.	Succeeded
Sort	string	No	The sort field. Valid values: CreateTime: the point in time when the trigger is created. UpdateTime: the most recent point in time when the trigger is updated.	2020-11-11T06:51:17.5Z
Order	string	No	The sort order. Default value: DESC. ASC (default): ascending order. DESC: descending order.	ASC
TagSelector	string	No	The custom tag. You can specify this parameter only if you specified Tags when you called the CreateTrigger operation.	test=val1
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the total number of triggers is greater than the value of MaxResults, you must specify NextToken. You do not need to specify this parameter for the first request.	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResults	integer	No	The maximum number of entries to return. Valid values: 0 to 100. Default value: 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
Triggers	array	The triggers.
	DataIngestion	The trigger.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
RequestId	string	The request ID.	F480BFAF-E778-5079-93AD-1E4631******

Examples

Success response

JSON format

{
  "Triggers": [
    {
      "Id": "trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****",
      "Input": {
        "OSS": {
          "Bucket": "test-bucket",
          "Prefix": "test-object",
          "MatchExpressions": [
            "key prefix (abc)"
          ]
        }
      },
      "Actions": [
        {
          "Name": "doc/convert",
          "Parameters": [
            "pages=3"
          ],
          "FastFailPolicy": {
            "Action": "abort"
          }
        }
      ],
      "Notification": {
        "Endpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
        "Topic": "topic1",
        "MNS": {
          "TopicName": "topic1",
          "Endpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com"
        },
        "RocketMQ": {
          "Endpoint": "http://11111111111.mqrest.cn-hangzhou.aliyuncs.com",
          "TopicName": "topic1",
          "InstanceId": "MQ_INST_11111111111_BYcNy2Nc"
        }
      },
      "Statistic": {
        "SubmitSuccess": 10,
        "SubmitFailure": 1,
        "SkipFiles": 0
      },
      "State": "Succeeded",
      "Marker": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****",
      "CreateTime": "2020-11-10T03:50:28Z",
      "UpdateTime": "2021-12-18T07:40:29Z",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "Error": "api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound",
      "Phase": "IncrementalScanning",
      "ServiceRole": "AliyunIMMBatchTriggerRole"
    }
  ],
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==",
  "RequestId": "F480BFAF-E778-5079-93AD-1E4631******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.