Gunakan ListDisasterRecoveryPlans untuk kueri tugas Replicator - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri tugas Global Replicator.

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:ListDisasterRecoveryPlans

get

*All Resource

*

None

Sintaks permintaan

GET /disaster_recovery HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
instanceId	string	No	ID instans.	rmq-cn-778xxx
filter	string	No	Kondisi filter. Tugas Global Replicator disaring berdasarkan nama atau deskripsi tugas.	xxx
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.	855EF8E6-9C1D-5DE2-9E84-924E13Exxxx
success	boolean	Indicates whether the information about the service was queried.	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.	28
list	array<object>	The Global Replicator tasks.
	array<object>	The Global Replicator task.
planId	integer	The ID of the Global Replicator task.	1300000016
planName	string	The name of the Global Replicator task.	xxx
planDesc	string	The description of the Global Replicator task.	xxx
planType	string	The type of the Global Replicator task. Valid values: ACTIVE_PASSIVE: one-way backup ACTIVE_ACTIVE: two-way backup	ACTIVE_PASSIVE
planStatus	string	The status of the Global Replicator task. Valid values: CREATED RUNNING DELETED	RUNNING
extInfo	object	The extended information.
	string	The extended information.	xxx
instances	array<object>	The instances involved in the Global Replicator task.
	array<object>	The instance involved the Global Replicator task.
instanceType	string	The instance type.	ALIYUN_ROCKETMQ
regionId	string	The ID of the region where the instance resides.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-ot93rbxxx
instanceRole	string	The instance role.	ACTIVE
authType	string	The authentication type.	NO_AUTH
username	string	The username used for authentication.	xxx
password	string	The password used for authentication.	xxx
endpointUrl	string	The endpoint.	xxx
networkType	string	The network type.	TCP_INTERNET
vpcId	string	The virtual private cloud (VPC) ID.	vpc-bp13docqysrgxtbxxxx
vSwitchId	string	The vSwitch ID.	vsw-uf6gwtbn6etadpv******
messageProperty	object	The message attribute.
propertyKey	string	The attribute key.	aaa
propertyValue	string	The attribute value.	bbb
securityGroupId	string	The security group ID.	sg-bp17hpmgz9******
consumerGroupId	string	The ID of the consumer group.	GID_ui_xxx
syncCheckpointEnabled	boolean	Indicates whether consumer progress synchronization is enabled.	true
autoSyncCheckpoint	boolean	Indicates whether automatic consumer progress synchronization is enabled.	true
createTime	string	The time when the query task was created.	2022-08-01 20:05:50
updateTime	string	The time when the query task was last modified.	2022-08-01 20:05:50
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 returned 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": "855EF8E6-9C1D-5DE2-9E84-924E13Exxxx",
  "success": true,
  "data": {
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00\n",
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 28,
    "list": [
      {
        "planId": 1300000016,
        "planName": "xxx",
        "planDesc": "xxx",
        "planType": "ACTIVE_PASSIVE",
        "planStatus": "RUNNING",
        "extInfo": {
          "key": "xxx"
        },
        "instances": [
          {
            "instanceType": "ALIYUN_ROCKETMQ",
            "regionId": "cn-hangzhou",
            "instanceId": "rmq-cn-ot93rbxxx",
            "instanceRole": "ACTIVE",
            "authType": "NO_AUTH",
            "username": "xxx",
            "password": "xxx",
            "endpointUrl": "xxx",
            "networkType": "TCP_INTERNET",
            "vpcId": "vpc-bp13docqysrgxtbxxxx",
            "vSwitchId": "vsw-uf6gwtbn6etadpv******\n",
            "messageProperty": {
              "propertyKey": "aaa",
              "propertyValue": "bbb"
            },
            "securityGroupId": "sg-bp17hpmgz9******\n",
            "consumerGroupId": "GID_ui_xxx"
          }
        ],
        "syncCheckpointEnabled": true,
        "autoSyncCheckpoint": true,
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "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.