referensi API ListDisasterRecoveryItems - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri tugas Global Replicator instans.

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

rocketmq:ListDisasterRecoveryItems

get

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Sintaks permintaan

GET /disaster_recovery/{planId}/items HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
planId	integer	Yes	ID tugas Global Replicator.	1234

Parameter permintaan

Parameter	Type	Required	Description	Example
topicName	string	No	Nama topik.	topic-test920
filter	string	No	Kondisi filter. Topik difilter berdasarkan nama topik.	topic_test
pageNumber	integer	No	Nomor halaman.	1
pageSize	integer	No	Jumlah entri per halaman.	10

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	C115601B-8736-5BBF-AC99-7FEAE12xxxx
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
scrollId	string	The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination request.	B13D0B07-F24B-4790-88D8-D47A38063D00
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	10
totalCount	integer	The total number of entries returned.	49
list	array<object>	The Global Replicator tasks.
	array<object>	The Global Replicator task.
itemId	integer	The ID of the Global Replicator task.	100070284
planId	integer	The ID of the topic mapping.	1300000016
itemStatus	string	The status of the topic mapping. Valid values: CREATING CHANGING RUNNING MANUAL_STOPPED OVERDUE_STOPPED	RUNNING
topics	array<object>	The topics involved in the topic mapping.
	object	The topic involved in the topic mapping.
regionId	string	regionId	cn-hangzhou
instanceType	string	The instance type.	ALIYUN_ROCKETMQ
instanceId	string	The instance ID.	rmq-cn-kh43w0olz0c
topicName	string	The topic name.	topic-test
consumerGroupId `deprecated`	string	The ID of the consumer group.	group-test
deliveryOrderType	string	The method used to deliver messages to the destination instance. Valid values: Concurrently: concurrent delivery Orderly: ordered delivery Valid values: Concurrently : 并发投递 Orderly : 顺序投递	Concurrently
extInfo	object	The extended information.
	string	The extended information.	{}
createTime	string	The time when the query task was created.	2024-09-20 03:38:28
updateTime	string	The time when the query task was last modified.	2024-10-04 02:19:44
code	string	The error code.	200
message	string	The error message.	xxx
httpStatusCode	integer	The response code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId
accessDeniedDetail	string	The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.	xxx

Contoh

Respons sukses

JSONformat

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE12xxxx",
  "success": true,
  "data": {
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00\n",
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 49,
    "list": [
      {
        "itemId": 100070284,
        "planId": 1300000016,
        "itemStatus": "RUNNING",
        "topics": [
          {
            "regionId": "cn-hangzhou",
            "instanceType": "ALIYUN_ROCKETMQ",
            "instanceId": "rmq-cn-kh43w0olz0c",
            "topicName": "topic-test",
            "consumerGroupId": "group-test",
            "deliveryOrderType": "Concurrently"
          }
        ],
        "extInfo": {
          "key": "{}"
        },
        "createTime": "2024-09-20 03:38:28",
        "updateTime": "2024-10-04 02:19:44"
      }
    ]
  },
  "code": "200",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.