Dapatkan detail aturan event menggunakan GetRule - EventBridge - Alibaba Cloud - EventBridge

Mengambil detail aturan event.

Deskripsi operasi

Mendapatkan detail aturan event.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:GetRule

get

*Rule

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/rule/{#RuleName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
EventBusName	string	Yes	Nama event bus.	default
RuleName	string	Yes	Nama aturan.	ram-changes

Elemen respons

Element	Type	Description	Example
	object
Message	string	Pesan kesalahan.	The event rule not existed!
RequestId	string	ID permintaan unik yang dihasilkan oleh Alibaba Cloud.	2BC1857D-E633-5E79-B2C2-43EF5F7730D8
Data	object	Data respons.
Status	string	Status aturan. Nilai yang valid: ENABLE: Aturan diaktifkan. Ini adalah nilai default. DISABLE: Aturan dinonaktifkan.	ENABLE
EventBusName	string	Nama event bus.	Housekeeping-Bus
RuleARN	string	ARN aturan.	acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
Description	string	Deskripsi aturan.	test
Targets	array<object>	Daftar target event.
	array<object>	Sebuah target event.
DetailMap	object	The details of the event target.
Type	string	The type of the event target. For more information, see Event target parameters.	acs.mns.queue
Endpoint	string	The endpoint to which the event is delivered.	acs:mns:cn-hangzhou:123456789098****:queues/myqueue
ParamList	array<object>	The list of parameters for the event target.
	object	An event target parameter.
Value	string	The value of the event target parameter.	{\"key\"=\"value\"}
Template	string	The template for the event target parameter.	The value of ${key} is ${value}!
Form	string	The format of the event target parameter. For more information, see Limits.	TEMPLATE
ResourceKey	string	The resource parameter of the event target. For more information, see Limits.	body
PushSelector	string	The push selector.	PARAM_TRANSFORMER
Id	string	The custom ID of the event target.	Mlm123456JHd2RsRoKw
DeadLetterQueue	object	The dead-letter queue.
Arn	string	The Alibaba Cloud Resource Name (ARN) of the dead-letter queue.	acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
Network	string
VpcId	string	The ID of the VPC.
VSwitchIds	string	The VSwitch IDs.
SecurityGroupId	string	The ID of the security group.
PushRetryStrategy	string	The push retry strategy. Valid values: BACKOFF_RETRY: A backoff retry. The request is retried up to three times. The interval between retries is a random value from 10 to 20 seconds. EXPONENTIAL_DECAY_RETRY: An exponential decay retry. The request is retried up to 176 times over one day. The interval starts at 1 second and exponentially increases to 512 seconds. The intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, and then 512 seconds for the remaining 167 retries.	BACKOFF_RETRY
ConcurrentConfig	object	The concurrency settings.
Concurrency	integer	The number of concurrent executions.	2
ErrorsTolerance	string	The fault tolerance policy. Valid values: ALL: Enables fault tolerance. If an error occurs, execution is not blocked. If all retries fail, the event is sent to the dead-letter queue or discarded, depending on your configuration. NONE: Disables fault tolerance. If an error occurs and all retries fail, execution is blocked.	ALL
FilterPattern	string	Pola event dalam format JSON. Mode berikut didukung: mode stringEqual: Dalam struktur map, setiap field dapat berisi hingga lima ekspresi. mode stringExpression: Dalam struktur map, setiap field dapat berisi hingga lima ekspresi.	{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamp	integer	Timestamp pembuatan aturan.	1607071602000
RuleName	string	Nama aturan.	ramrolechange-fc
Code	string	Kode respons. Nilai yang valid: Success: Permintaan berhasil. Nilai lain: Permintaan mengembalikan kode kesalahan. Untuk informasi lebih lanjut, lihat Kode kesalahan.	Success
Success	boolean	Menunjukkan apakah operasi berhasil. Nilai `true` menunjukkan keberhasilan.	true

Contoh

Respons sukses

JSONformat

{
  "Message": "The event rule not existed!",
  "RequestId": "2BC1857D-E633-5E79-B2C2-43EF5F7730D8",
  "Data": {
    "Status": "ENABLE",
    "EventBusName": "Housekeeping-Bus",
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
    "Description": "test",
    "Targets": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Type": "acs.mns.queue",
        "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
        "ParamList": [
          {
            "Value": "{\\\"key\\\"=\\\"value\\\"}",
            "Template": "The value of ${key} is ${value}!",
            "Form": "TEMPLATE",
            "ResourceKey": "body"
          }
        ],
        "PushSelector": "PARAM_TRANSFORMER",
        "Id": "Mlm123456JHd2RsRoKw\n",
        "DeadLetterQueue": {
          "Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source",
          "Network": "",
          "VpcId": "",
          "VSwitchIds": "",
          "SecurityGroupId": ""
        },
        "PushRetryStrategy": "BACKOFF_RETRY",
        "ConcurrentConfig": {
          "Concurrency": 2
        },
        "ErrorsTolerance": "ALL"
      }
    ],
    "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}",
    "CreatedTimestamp": 1607071602000,
    "RuleName": "ramrolechange-fc"
  },
  "Code": "Success",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.