ListTriggers - Intelligent Media Management - Alibaba Cloud Documentation Center

Queries triggers by tag or status.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:ListTriggers	list	Trigger `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/trigger/`	none	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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
Triggers	array	The triggers.
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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history