ListRules-阿里云帮助中心

Queries all event rules. You can use the Limit and NextToken parameters to implement paging.

URI

/openapi/listRules

Request parameters

Parameter	Type	Required	Example	Description
EventBusName	String	Yes	default	For more information, see Limits.
RuleNamePrefix	String	Yes	my	The name of the event rule. For more information, see Limits.
Limit	String	No	10	The maximum number of entries to be returned in a call. You can use this parameter and the NextToken parameter to implement paging. Note A maximum of 100 entries can be returned in a call.
NextToken	String	No	5	If you configure the Limit parameter and excess return values exist, this parameter is returned.

Response parameters

Parameter	Type	Example	Description
NextToken	String	5	The offset for the next paging request. If excess data over the specified value of the Limit parameter is available for the next paging request, this parameter is returned.
Rules	List<Rule>		The event rules returned.
EventBusName	String	default	The name of the event bus.
RuleARN	String	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule1	The Alibaba Cloud Resource Name (ARN) of the event rule. The ARN is used for authorization.
RuleName	String	myRule1	The name of the event rule.
Status	String	ENABLE	The status of the event rule. Valid values: ENABLE: The event rule is enabled. It is the default state of the event rule. DISABLE: The event rule is disabled.
FilterPattern	String	`{\"source\":[\"acs.oss\"],\"type\":[\"oss:ObjectCreated:UploadPart\"]}`	The event pattern, in the JSON format. Valid values: stringEqual pattern stringExpression pattern Each field can have a maximum of five expressions in the map data structure. Each field can have a maximum of five expressions in the map data structure.
Targets	List<Target>		The event target to which events are delivered.
Id	String	target1	The custom ID of the event target.
Type	String	http	The type of the event target.
Endpoint	String	http://www.example.com	The endpoint of the event target.
PushRetryStrategy	String	BACKOFF_RETRY	The retry policy that is used to push the event. Valid values: BACKOFF_RETRY: backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds. EXPONENTIAL_DECAY_RETRY: exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
ParamList	List<Param>		The parameters that the event passes.
resourceKey	String	body	The resource key of the transformed event.For more information, see Event target parameters.
form	String	TEMPLATE	The transformation method.For more information, see Event target parameters.
value	String	`{\"key\"=\"value\"}`	The event value to be transformed.
template	String	The value of ${key} is ${value}!	The format of the template.

Examples

Sample requests

POST /openapi/listRules HTTP/1.1
Host: 123456789098****.eventbridge.cn-hangzhou.aliyuncs.com
Date: Sat, 18 Apr 2020 05:30:41 GMT
x-eventbridge-version: 2020-04-01
Authorization: acs vZ3VL0SuJdHi****:Jo2PbTj****zYAYoYslKLvWzg=
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
    "EventBusName":"default",
    "RuleNamePrefix":"my",
    "Limit":"10",
    "NextToken":"5"
}

Sample success response

HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 5E9A9081333245F1D800****
Date: Sat, 18 Apr 2020 05:30:41 GMT

{
    "NextToken":"5",
    "Rules":[
        {
            "EventBusName":"default",
            "RuleARN":"acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule1",
            "RuleName":"myRule1",
            "status":"ENABLE",
            "FilterPattern":"{\"source\":[\"acs.oss\"],\"type\":[\"oss:ObjectCreated:UploadPart\"]}",
            "Targets":[
                {
                    "Id":"target1",
                    "Type":"http",
                    "Endpoint":"http://www.example.com",
                    "PushRetryStrategy":"EXPONENTIAL_DECAY_RETRY"
                }
            ],
            "ResourceKeys":[
                {
                    "form":"CONSTANT",
                    "resourceKey":"url"
                },
                {
                    "form":"TEMPLATE",
                    "resourceKey":"body"
                }
            ]
        }
    ]
}