すべてのプロダクト
Search

このプロダクト

    :ListUserDefinedEventSources

    ドキュメントセンター

    :ListUserDefinedEventSources

    最終更新日:Nov 10, 2025

    すべてのカスタムイベントソースをクエリします。

    URI

    /openapi/listUserDefinedEventSources

    使用方法

    SourceMNSParameters、SourceRocketMQParameters、SourceRabbitMQParameters、SourceHttpEventParameters、SourceSLSParameters パラメーターのうち、1 つだけが返されます。

    リクエストパラメーター

    なし

    レスポンスパラメーター

    パラメータータイプ例説明
    StatusStringActivated返されたイベントソースのステータス。
    有効な値：
    • Activated
    TypeStringUserDefinedイベントソースのタイプ。
    有効な値：
    • UserDefined: カスタムイベントソース
    SourceMNSParametersObjectイベントプロバイダーが シンプルメッセージキュー（旧 MNS） の場合に構成されるリソース情報。
    SourceRocketMQParametersObjectイベントプロバイダーが RocketMQ for ApsaraMQ の場合に構成されるリソース情報。
    SourceRabbitMQParametersObjectイベントプロバイダーが RabbitMQ for ApsaraMQ の場合に構成されるリソース情報。
    SourceHttpEventParametersObjectイベントプロバイダーが HTTP/HTTPS であることを示します。
    SourceSLSParametersObjectイベントプロバイダーがログサービスであることを示します。
    CtimeString1626360902642イベントソースが作成された時刻。単位：ミリ秒。
    EventBusNameStringdemo-busイベントソースが関連付けられているイベントバスの名前。
    ARNStringacs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.sourceイベントソースの Alibaba Cloud リソース名（ARN）。
    NameStringrocketmq.sourceイベントソースの名前。

    レスポンスパラメーター SourceMNSParameters

    パラメータータイプ例説明
    RegionIdStringcn-zhangjiakouシンプルメッセージキュー（旧 MNS） キューが存在するリージョンの ID。
    QueueNameStringMyQueueシンプルメッセージキュー（旧 MNS） キューの名前。
    IsBase64DecodeStringtrueBase64 デコードが有効になっているかどうかを示します。

    レスポンスパラメーター SourceRocketMQParameters

    パラメータータイプ例説明
    RegionIdStringcn-zhangjiakouRocketMQ for ApsaraMQ インスタンスが存在するリージョンの ID。
    InstanceIdStringMQ_INST_164901546557****_BAAN****RocketMQ for ApsaraMQ インスタンスの ID。詳細については、「制限」をご参照ください。
    TopicStringmytopicRocketMQ for ApsaraMQ インスタンスのトピックの名前。詳細については、「制限」をご参照ください。
    TagStringtestメッセージのフィルタリングに使用されるタグ。
    OffsetStringCONSUME_FROM_TIMESTAMPメッセージのコンシューマーオフセット。有効な値：
    • CONSUME_FROM_LAST_OFFSET: 最新のオフセットから消費を開始します。
    • CONSUME_FROM_FIRST_OFFSET: 最も古いオフセットから消費を開始します。
    • CONSUME_FROM_TIMESTAMP: 指定された時点のオフセットから消費を開始します。
    TimestampLong1636597951964消費を開始するオフセットのタイムスタンプ。Offset パラメーターが CONSUME_FROM_TIMESTAMP に設定されている場合にのみ、このパラメーターは有効です。
    GroupIDStringGID_group1RocketMQ for ApsaraMQ のグループの ID。

    レスポンスパラメーター SourceRabbitMQParameters

    パラメータータイプ例説明
    RegionIdStringcn-zhangjiakouRabbitMQ for ApsaraMQ インスタンスが存在するリージョンの ID。
    InstanceIdStringamqp-cn-nif22u74****RabbitMQ for ApsaraMQ インスタンスの ID。詳細については、「制限」をご参照ください。
    VirtualHostNameStringeb-connectRabbitMQ for ApsaraMQ インスタンスの vhost の名前。詳細については、「制限」をご参照ください。
    QueueNameStringdemoRabbitMQ for ApsaraMQ インスタンスのキューの名前。詳細については、「制限」をご参照ください。

    レスポンスパラメーター SourceHttpEventParameters

    パラメータータイプ必須例説明
    TypeStringはいHTTPS生成された webhook URL でサポートされるプロトコルタイプ。有効な値：
    • HTTP
    • HTTPS
    • HTTP&HTTPS
    MethodListはいGET生成された webhook URL でサポートされる HTTP リクエストメソッド。複数の値を選択できます。有効な値：
    • GET
    • POST
    • PUT
    • PATCH
    • DELETE
    • HEAD
    • OPTIONS
    • TRACE
    • CONNECT
    SecurityConfigStringはいipセキュリティ設定のタイプ。有効な値：
    • none: セキュリティ設定なし。
    • ip: CIDR ブロック。
    • referer: セキュリティドメイン名。
    IpListいいえ10.0.0.0/8セキュリティ CIDR ブロック。SecurityConfig パラメーターを ip に設定した場合にのみ、このパラメーターは必須です。CIDR ブロックまたは IP アドレスを入力できます。
    RefererListいいえaliyundoc.comセキュリティドメイン名。SecurityConfig パラメーターを referer に設定した場合にのみ、このパラメーターは必須です。ドメイン名を入力できます。

    レスポンスパラメーター SourceSLSParameters

    パラメータータイプ必須例説明
    ProjectStringはいtest-projectログサービスプロジェクト。
    LogStoreStringはいtest-logstoreログサービスログストア。
    ConsumePositionStringいいえend開始コンシューマーオフセット。値 begin は最も古いオフセットを示し、値 end は最新のオフセットを示します。消費を開始する時刻を秒単位で指定することもできます。
    RoleNameStringはいtestRoleロールの名前。EventBridge にこのロールを使用してログサービスのログを読み取る権限を付与するには、RAM コンソールでロールを作成するときに、[選択された信頼エンティティ] パラメーターで [Alibaba Cloud サービス] を選択し、[信頼サービスの選択] パラメーターで [EventBridge] を選択する必要があります。

    例

    リクエストの例

    POST /openapi/listUserDefinedEventSources 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****:Jo2PbT******azYAYoYslKLvWzg=
Content-Type: application/json;charset=UTF-8
Content-Length: 26

    レスポンスの例

    HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 608C6467-3195-42A3-97B5-C51FB976****
Date: Sat, 18 Apr 2020 05:30:41 GMT

{
    "code":"200",
    "data":{
        "RequestId":"608C6467-3195-42A3-97B5-C51FB976****",
        "Data":{
            "eventSourceList":[
                {
                    "Status":"Activated",
                    "Type":"UserDefined",
                    "Ctime":1626360902642,
                    "EventBusName": "demo-bus",
                    "SourceRocketMQParameters":{
                        "InstanceId":"MQ_INST_164901546557****_BXmr****",
                        "Tag":"",
                        "RegionId":"cn-hangzhou",
                        "Topic":"demo-topic",
                        "GroupID":"GID_SOURCE",
                        "Offset":"CONSUME_FROM_LAST_OFFSET"
                    },
                    "ARN":"acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source",
                    "Name":"demo.source"
                }
            ]
        },
        "Code":"Success",
        "Success":true
    },
    "httpStatusCode":"200",
    "requestId":"608C6467-3195-42A3-97B5-C51FB976****",
    "successResponse":true
}