ListRules - - Alibaba Cloud ドキュメントセンター

すべてのイベントルールを照会します。 Limit パラメーターと NextToken パラメーターを使用して、ページングを実装できます。

URI

/openapi/listRules

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
EventBusName	String	はい	default	詳細については、「制限」をご参照ください。
RuleNamePrefix	String	はい	my	イベントルール名。詳細については、「制限」をご参照ください。
Limit	String	いいえ	10	1 回の呼び出しで返される最大エントリ数。このパラメーターと NextToken パラメーターを使用して、ページングを実装できます。説明 1 回の呼び出しで最大 100 エントリを返すことができます。
NextToken	String	いいえ	5	Limit パラメーターを設定し、超過戻り値が存在する場合、このパラメーターが返されます。

レスポンスパラメーター

パラメーター	タイプ	例	説明
NextToken	String	5	次のページングリクエストのオフセット。次のページングリクエストで Limit パラメーターの指定値を超えるデータが利用可能な場合、このパラメーターが返されます。
Rules	List<Rule>		返されたイベントルール。
EventBusName	String	default	イベントバスの名前。
RuleARN	String	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule1	イベントルールのAlibaba Cloudリソースネーム（ARN）。 ARN は認証に使用されます。
RuleName	String	myRule1	イベントルール名。
Status	String	ENABLE	イベントルールのステータス。有効な値： ENABLE：イベントルールは有効です。イベントルールのデフォルト状態です。 DISABLE：イベントルールは無効です。
FilterPattern	String	`{\"source\":[\"acs.oss\"],\"type\":[\"oss:ObjectCreated:UploadPart\"]}`	JSON 形式のイベントパターン。有効な値： stringEqual パターン stringExpression パターン各フィールドは、マップデータ構造で最大 5 つの式を持つことができます。各フィールドは、マップデータ構造で最大 5 つの式を持つことができます。
Targets	List<Target>		イベントが配信されるイベントターゲット。
Id	String	target1	イベントターゲットのカスタム ID。
Type	String	http	イベントターゲットのタイプ。
Endpoint	String	http://www.example.com	イベントターゲットのエンドポイント。
PushRetryStrategy	String	BACKOFF_RETRY	イベントをプッシュするために使用される再試行ポリシー。有効な値： BACKOFF_RETRY：バックオフ再試行。リクエストは最大 3 回再試行できます。 2 回の連続する再試行の間隔は、10 ～ 20 秒のランダムな値です。 EXPONENTIAL_DECAY_RETRY：指数関数的減衰再試行。リクエストは最大 176 回再試行できます。 2 回の連続する再試行の間隔は、指数関数的に 512 秒まで増加し、合計再試行時間は 1 日です。具体的な再試行間隔は、1、2、4、8、16、32、64、128、256、512、512、...、512 秒で、合計で最大 167 回の 512 秒が含まれます。
ParamList	List<Param>		イベントが渡すパラメーター。
resourceKey	String	body	変換されたイベントのリソースキー。詳細については、「イベントターゲットパラメーター」をご参照ください。
form	String	TEMPLATE	変換方法。詳細については、「イベントターゲットパラメーター」をご参照ください。
value	String	`{\"key\"=\"value\"}`	変換されるイベント値。
template	String	The value of ${key} is ${value}!	テンプレートの形式。

例

リクエストの例

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

成功レスポンスの例

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"
                }
            ]
        }
    ]
}