Kueri informasi dasar instans dan endpoint dengan OnsInstanceBaseInfo-ApsaraMQ for RocketMQ-Alibaba Cloud - ApsaraMQ for RocketMQ

Meminta informasi dasar tentang sebuah instans dan endpoint-nya untuk mengirim dan menerima pesan.

Deskripsi operasi

Penting

OpenAPI yang disediakan oleh Alibaba Cloud adalah API manajemen yang digunakan untuk mengelola dan meminta sumber daya layanan Alibaba Cloud. Integrasikan OpenAPI hanya untuk tujuan manajemen. Jangan gunakan OpenAPI untuk data link inti yang mengirim dan menerima pesan. Hal ini dapat menciptakan ancaman keamanan pada data link Anda.

Klien terhubung ke ApsaraMQ for RocketMQ melalui endpoint untuk mengirim dan menerima pesan. Anda dapat memanggil operasi ini untuk meminta endpoint sebuah 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

mq:QueryInstanceBaseInfo

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans yang akan diminta.	MQ_INST_138015630679****_BAAy1Hac

Elemen respons

Element	Type	Description	Example
	object
InstanceBaseInfo	object	Objek informasi instans.
Endpoints	object	Endpoint untuk protokol yang berbeda.
TcpEndpoint	string	The internal endpoint for the TCP protocol.	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
TcpInternetEndpoint	string	The public endpoint for the TCP protocol. Only instances in the China (Chengdu), China (Qingdao), and China (Shenzhen) regions support public endpoints for the TCP protocol. To use the public endpoint for the TCP protocol, upgrade the client software development kit (SDK) to one of the following versions: Java SDK for TCP: 2.0.0.Final or later. For more information, see the Java SDK Version Guide. C++ SDK for TCP: 3.0.0 or later. For more information, see the C++ SDK Version Guide. Data transfer costs are incurred when you use the public endpoint for the TCP protocol. For more information, see Data transfer cost.	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
HttpInternetEndpoint	string	The public endpoint for the HTTP protocol.	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
HttpInternalEndpoint	string	The internal endpoint for the HTTP protocol.	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
HttpInternetSecureEndpoint	string	The public endpoint for the HTTPS protocol.	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
IndependentNaming	boolean	Menunjukkan apakah instans memiliki namespace. Nilai yang valid: true: Instans memiliki namespace independen. Nama sumber daya harus unik dalam instans. Nama sumber daya dapat sama di berbagai instans. false: Instans tidak memiliki namespace independen. Nama sumber daya harus unik secara global.	true
MaxTps	integer	Transactions Per Second (TPS) maksimum untuk mengirim dan menerima pesan. Nilai yang valid: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000, dan 1000000. Untuk informasi lebih lanjut, lihat halaman pembelian instans. Catatan Parameter ini hanya berlaku untuk instans ApsaraMQ for RocketMQ Platinum Edition.	10000
Remark	string	Catatan pada instans.	ons-cn-m7r1r5f****
InstanceName	string	Nama instans. Nama harus terdiri dari 3 hingga 64 karakter dan dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_).	test
ReleaseTime	integer	Waktu ketika instans Platinum Edition kedaluwarsa.	1603555200000
TopicCapacity	integer	Jumlah maksimum topik yang dapat dibuat pada instans. Nilai yang valid: 25, 50, 100, 300, dan 500. Catatan Parameter ini hanya berlaku untuk instans ApsaraMQ for RocketMQ Platinum Edition.	50
InstanceStatus	integer	Status instans. Nilai yang valid: 0: Instans Platinum Edition sedang di-deploy. 2: Pembayaran untuk instans Standard Edition tertunggak. 5: Instans Standard Edition atau Platinum Edition sedang dalam layanan. 7: Instans Platinum Edition sedang ditingkatkan dan tersedia.	5
InstanceId	string	ID instans.	MQ_INST_138015630679****_BAAy1Hac
InstanceType	integer	Tipe instans. Nilai yang valid: 1: Instans Standard Edition (pay-as-you-go) 2: Instans Platinum Edition (subscription) Untuk informasi lebih lanjut tentang tipe dan spesifikasi instans ApsaraMQ for RocketMQ, lihat Tipe instans.	2
CreateTime	string	Waktu ketika instans dibuat. Nilai parameter ini adalah UNIX timestamp dalam milidetik.	1570701259403
spInstanceId	string	ID komoditas instans.	ons-cn-m7r1r5f****
spInstanceType	integer	Tipe penjualan instans. Valid values: 1 : Instans Standard Edition (pay-as-you-go) 2 : Instans Platinum Edition (subscription)	1
SupportClassic	integer		2
RequestId	string	Parameter umum. Setiap permintaan memiliki ID unik yang dapat Anda gunakan untuk memecahkan masalah.	6CC46974-65E8-4C20-AB07-D20D102E****

Contoh

Respons sukses

JSONformat

{
  "InstanceBaseInfo": {
    "Endpoints": {
      "TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "TcpInternetEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80",
      "HttpInternetEndpoint": "http://138015630679****.mqrest.cn-chengdu.aliyuncs.com",
      "HttpInternalEndpoint": "http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com",
      "HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-chengdu.aliyuncs.com"
    },
    "IndependentNaming": true,
    "MaxTps": 10000,
    "Remark": "ons-cn-m7r1r5f****",
    "InstanceName": "test",
    "ReleaseTime": 1603555200000,
    "TopicCapacity": 50,
    "InstanceStatus": 5,
    "InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType": 2,
    "CreateTime": "1570701259403",
    "spInstanceId": "ons-cn-m7r1r5f****",
    "spInstanceType": 1,
    "SupportClassic": 2
  },
  "RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.