Todos os produtos
Search

Este produto

    EventBridge:ListUserDefinedEventSources

    Central de documentação

    EventBridge:ListUserDefinedEventSources

    Última atualização: Oct 28, 2026

    Consulta todas as fontes de eventos externas.

    Descrição da operação

    Consulta todas as fontes de eventos externas.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    eventbridge:ListUserDefinedEventSources

    get

    *EventSource.

    acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/eventsource/*

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    NamePrefix

    string

    Não

    O prefixo do nome da fonte de eventos.

    testName
    EventBusName

    string

    Não

    O nome do barramento de eventos.

    testBus
    Limit

    integer

    Não

    O número máximo de entradas a serem retornadas por solicitação. Você pode usar este parâmetro com NextToken para paginar os resultados. O valor máximo é 100.

    50
    NextToken

    string

    Não

    O token retornado quando Limit é especificado e há resultados adicionais disponíveis.

    100

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Message

    string

    A mensagem de erro.

    InvalidArgument
    RequestId

    string

    O identificador exclusivo gerado pelo Alibaba Cloud para a solicitação.

    5169654A-7059-57E3-BFD9-33C7E012****
    Data

    object

    Os dados retornados.

    NextToken

    string

    O próximo token retornado quando o parâmetro Limit é especificado e mais resultados estão disponíveis.

    100
    Total

    integer

    O número total de entradas.

    18
    EventSourceList

    array<object>

    A lista de origens de eventos.

    array<object>

    A estrutura de dados da origem do evento.

    Name

    string

    O nome da origem do evento consultada.

    rocketmq.source
    Arn

    string

    O Alibaba Cloud Resource Name (ARN) da origem do evento consultada.

    acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
    Status

    string

    O status da origem do evento consultada. Valores válidos:

    • Activated: A origem do evento está ativada.

    Activated
    Type

    string

    O tipo da origem do evento consultada. Valores válidos:

    • UserDefined: Origem de evento personalizada.

    UserDefined
    Ctime

    number

    O timestamp de criação.

    1607071602000
    ExternalSourceType

    string

    O tipo da origem do evento externo.

    RabbitMQ
    EventBusName

    string

    O nome do barramento de eventos.

    test-custom-bus
    SourceMNSParameters

    object

    Os parâmetros da origem de eventos do Simple Message Queue (anteriormente MNS).

    RegionId

    string

    A região onde reside a fila do Simple Message Queue (anteriormente MNS).

    cn-hangzhou
    QueueName

    string

    O nome da fila no Simple Message Queue (anteriormente MNS).

    queue.openapi-sign-callback
    IsBase64Decode

    boolean

    Especifica se a decodificação Base64 deve ser ativada. Valor padrão: true.

    true
    SourceRocketMQParameters

    object

    O parâmetro de solicitação SourceRocketMQParameters.

    RegionId

    string

    A região onde reside a instância do ApsaraMQ for RocketMQ.

    cn-shenzhen
    InstanceId

    string

    O ID da instância do ApsaraMQ for RocketMQ. Para mais informações, consulte Limites.

    bastionhost-cn-7mz293s9d1p
    Topic

    string

    O nome do tópico da instância do ApsaraMQ for RocketMQ. Para mais informações, consulte Limites.

    migration_instance
    Tag

    string

    A tag de filtro da mensagem.

    dataact
    Offset

    string

    O offset de consumo da mensagem. Valores válidos:

    • CONSUME_FROM_LAST_OFFSET: Consome mensagens a partir do offset mais recente.

    • CONSUME_FROM_FIRST_OFFSET: Consome mensagens a partir do offset mais antigo.

    • CONSUME_FROM_TIMESTAMP: Consome mensagens a partir do offset em um ponto no tempo especificado. Valor padrão: CONSUME_FROM_LAST_OFFSET.

    CONSUMEFROMLASTOFFSET
    Timestamp

    number

    O timestamp. Este parâmetro é válido apenas quando o parâmetro Offset é definido como CONSUME_FROM_TIMESTAMP.

    1664591760
    GroupId

    string

    O ID do grupo do ApsaraMQ for RocketMQ.

    GID-test
    InstanceType

    string

    O tipo de instância. Valores válidos: CLOUD_4 (instância baseada em nuvem 4.0), CLOUD_5 (instância baseada em nuvem 5.0) e SELF_BUILT (MQ autogerenciado).

    CLOUD_5
    InstanceNetwork

    string

    O tipo de rede da instância.

    PublicNetwork
    InstanceVpcId

    string

    O ID da virtual private cloud (VPC).

    vpc-***
    InstanceVSwitchIds

    string

    O ID do vSwitch.

    vsw-bp1iu***
    InstanceSecurityGroupId

    string

    O ID do grupo de segurança.

    eb-167adad548***
    AuthType

    string

    O tipo de autenticação. Você pode definir este parâmetro como ACL ou deixá-lo vazio.

    ACL
    InstanceEndpoint

    string

    O endpoint da instância.

    registry-vpc.cn-hangzhou.aliyuncs.com
    InstanceUsername

    string

    O nome de usuário da instância.

    root
    InstancePassword

    string

    A senha da instância.

    yourPassword
    SourceRabbitMQParameters

    object

    O parâmetro de solicitação SourceRabbitMQParameters.

    RegionId

    string

    A região onde reside a instância do ApsaraMQ for RabbitMQ.

    cn-hangzhou
    InstanceId

    string

    O ID da instância do ApsaraMQ for RabbitMQ. Para mais informações, consulte Limites.

    bastionhost-cn-0ju2x28fj07
    VirtualHostName

    string

    O nome do vhost da instância do ApsaraMQ for RabbitMQ. Para mais informações, consulte Limites.

    eb-connect
    QueueName

    string

    O nome da fila da instância do ApsaraMQ for RabbitMQ. Para mais informações, consulte Limites.

    file-upload-queue
    SourceSLSParameters

    object

    O parâmetro de solicitação SourceSLSParameters.

    Project

    string

    O projeto do Simple Log Service.

    VideoTestProject
    LogStore

    string

    O Logstore do Simple Log Service.

    cloudfirewall-logstore
    ConsumePosition

    string

    O offset de consumo inicial. Você pode selecionar o offset mais antigo ou mais recente, que corresponde a "begin" ou "end". Você também pode iniciar o consumo a partir de um ponto no tempo especificado em segundos.

    end
    RoleName

    string

    O nome da função. Para conceder autorização para o barramento de eventos EventBridge usar esta função para ler logs do Simple Log Service, as seguintes condições devem ser atendidas: ao criar a função para o serviço no console do Resource Access Management (RAM), você deve selecionar Alibaba Cloud Service e definir o serviço confiável como o barramento de eventos. Para a política de acesso desta função, consulte Origem de evento personalizada: Simple Log Service.

    testRole
    SourceHttpEventParameters

    object

    O parâmetro de solicitação SourceHttpEventParameters.

    Type

    string

    O tipo de protocolo suportado pelo webhook gerado. Valores válidos:

    • HTTP

    • HTTPS

    • HTTP&HTTPS

    HTTPS
    Method

    array

    Os métodos de solicitação HTTP suportados pelo webhook gerado. Você pode selecionar vários valores. Valores válidos:

    • GET

    • POST

    • PUT

    • PATCH

    • DELETE

    • HEAD

    • OPTIONS

    • TRACE

    • CONNECT

    string

    Os métodos de solicitação HTTP suportados pelo webhook gerado. Você pode selecionar vários valores. Valores válidos:

    • GET

    • POST

    • PUT

    • PATCH

    • DELETE

    • HEAD

    • OPTIONS

    • TRACE

    • CONNECT

    GET
    SecurityConfig

    string

    O tipo da configuração de segurança. Valores válidos:

    • none: Nenhuma configuração é necessária.

    • ip: Bloco CIDR.

    • referer: Nome de domínio seguro.

    none
    Ip

    array

    A configuração de segurança de bloco CIDR. Este parâmetro é necessário apenas quando o parâmetro SecurityConfig é definido como ip. Você pode inserir um bloco CIDR ou um endereço IP.

    string

    A configuração de segurança de bloco CIDR. Este parâmetro é necessário apenas quando o parâmetro SecurityConfig é definido como ip. Você pode inserir um bloco CIDR ou um endereço IP.

    8.212.139.16/32
    Referer

    array

    A configuração de nome de domínio seguro. Este parâmetro é necessário apenas quando o parâmetro SecurityConfig é definido como referer. Você pode inserir um nome de domínio.

    string

    A configuração de nome de domínio seguro. Este parâmetro é necessário apenas quando o parâmetro SecurityConfig é definido como referer. Você pode inserir um nome de domínio.

    aliyundoc.com

    PublicWebHookUrl

    array

    A URL de solicitação de rede pública.

    string

    A URL de solicitação de rede pública.

    http://***.eventbridge.cn-hangzhou.aliyuncs.com/webhook/putEvents?token=***
    VpcWebHookUrl

    array

    A URL de solicitação de rede interna.

    string

    A URL de solicitação de rede interna.

    http://***.eventbridge.cn-hangzhou-vpc.aliyuncs.com/webhook/putEvents?token=0f6705c9253540e1a53e06db011a25b52068562ca50d4818828fffd61c5af***
    SourceKafkaParameters

    object

    Os parâmetros da origem de eventos do ApsaraMQ for Kafka.

    InstanceId

    string

    O ID da instância.

    i-2ze6kiwzkebf04s5h8ds
    ConsumerGroup

    string

    O ID do grupo do consumidor que assina o tópico.

    test-gid
    Topic

    string

    O nome do tópico.

    topic_api_1674441611897
    OffsetReset

    string

    O offset de consumo.

    earliest
    RegionId

    string

    O ID da região.

    cn-hangzhou
    MaximumTasks

    integer

    A cota de simultaneidade (número de consumidores).

    2
    Network

    string

    A configuração de rede. Valores válidos: Default (rede padrão) e PublicNetwork (rede autogerenciada).

    Default
    SecurityGroupId

    string

    O ID do grupo de segurança.

    sg-f8zatts5g97x0j***
    VpcId

    string

    O ID da VPC.

    vpc-bp1kz3ohhzgrau2***
    VSwitchIds

    string

    O ID do vSwitch.

    vsw-bp1hcrxq3mkcik***e
    SourceScheduledEventParameters

    object

    Os parâmetros da origem de eventos agendados.

    Schedule

    string

    A expressão cron.

    0 1 * * * *
    TimeZone

    string

    O fuso horário para execução do cron.

    GMT+0:00
    UserData

    string

    A string JSON.

    {"a": "b"}
    SourceOSSEventParameters

    object

    Os parâmetros da origem de eventos do OSS.

    EventTypes

    array

    A lista de tipos de eventos.

    string

    O tipo de evento.

    ObjectCreated:PutObject
    StsRoleArn

    string

    O ARN da função STS.

    acs:eventbridge:cn-hangzhou:**
    MatchRules

    any

    As regras de correspondência.

    Event rules (if any)
    Code

    string

    O código de retorno da operação de API.

    • Success: A operação foi bem-sucedida.

    • Outros valores: Um código de erro. Para mais informações, consulte Códigos de erro.

    Success
    Success

    boolean

    Retorna true se a operação for bem-sucedida.

    true

    Exemplo de resposta: `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 }`

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Message": "InvalidArgument",
  "RequestId": "5169654A-7059-57E3-BFD9-33C7E012****",
  "Data": {
    "NextToken": "100",
    "Total": 18,
    "EventSourceList": [
      {
        "Name": "rocketmq.source",
        "Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source",
        "Status": "Activated",
        "Type": "UserDefined",
        "Ctime": 1607071602000,
        "ExternalSourceType": "RabbitMQ",
        "EventBusName": "test-custom-bus",
        "SourceMNSParameters": {
          "RegionId": "cn-hangzhou",
          "QueueName": "queue.openapi-sign-callback",
          "IsBase64Decode": true
        },
        "SourceRocketMQParameters": {
          "RegionId": "cn-shenzhen",
          "InstanceId": "bastionhost-cn-7mz293s9d1p",
          "Topic": "migration_instance",
          "Tag": "dataact",
          "Offset": "CONSUMEFROMLASTOFFSET",
          "Timestamp": 1664591760,
          "GroupId": "GID-test",
          "InstanceType": "CLOUD_5",
          "InstanceNetwork": "PublicNetwork",
          "InstanceVpcId": "vpc-***",
          "InstanceVSwitchIds": "vsw-bp1iu***",
          "InstanceSecurityGroupId": "eb-167adad548***",
          "AuthType": "ACL",
          "InstanceEndpoint": "registry-vpc.cn-hangzhou.aliyuncs.com",
          "InstanceUsername": "root",
          "InstancePassword": "yourPassword"
        },
        "SourceRabbitMQParameters": {
          "RegionId": "cn-hangzhou",
          "InstanceId": "bastionhost-cn-0ju2x28fj07",
          "VirtualHostName": "eb-connect",
          "QueueName": "file-upload-queue"
        },
        "SourceSLSParameters": {
          "Project": "VideoTestProject",
          "LogStore": "cloudfirewall-logstore",
          "ConsumePosition": "end",
          "RoleName": "testRole"
        },
        "SourceHttpEventParameters": {
          "Type": "HTTPS",
          "Method": [
            "GET"
          ],
          "SecurityConfig": "none",
          "Ip": [
            "8.212.139.16/32"
          ],
          "Referer": [
            "aliyundoc.com\t"
          ],
          "PublicWebHookUrl": [
            "http://***.eventbridge.cn-hangzhou.aliyuncs.com/webhook/putEvents?token=***"
          ],
          "VpcWebHookUrl": [
            "http://***.eventbridge.cn-hangzhou-vpc.aliyuncs.com/webhook/putEvents?token=0f6705c9253540e1a53e06db011a25b52068562ca50d4818828fffd61c5af***"
          ]
        },
        "SourceKafkaParameters": {
          "InstanceId": "i-2ze6kiwzkebf04s5h8ds",
          "ConsumerGroup": "test-gid",
          "Topic": "topic_api_1674441611897",
          "OffsetReset": "earliest",
          "RegionId": "cn-hangzhou",
          "MaximumTasks": 2,
          "Network": "Default",
          "SecurityGroupId": "sg-f8zatts5g97x0j***",
          "VpcId": "vpc-bp1kz3ohhzgrau2***",
          "VSwitchIds": "vsw-bp1hcrxq3mkcik***e"
        },
        "SourceScheduledEventParameters": {
          "Schedule": "0 1 * * * *",
          "TimeZone": "GMT+0:00",
          "UserData": "{\"a\": \"b\"}"
        },
        "SourceOSSEventParameters": {
          "EventTypes": [
            "ObjectCreated:PutObject 等"
          ],
          "StsRoleArn": "acs:eventbridge:cn-hangzhou:**",
          "MatchRules": "事件规则（如有）"
        }
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    403 ServiceNotEnable Service not enable

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.