Gunakan GetInstance untuk mengambil detail instans - ApsaraMQ untuk RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengambil detail instans tertentu.

Deskripsi operasi

Penting Operasi OpenAPI yang disediakan oleh Alibaba Cloud adalah API manajemen yang digunakan untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Gunakan hanya dalam alur kerja manajemen dan kontrol. Jangan mengandalkan OpenAPI dalam alur kerja tautan data inti untuk pengiriman dan penerimaan Paket, karena hal ini dapat menimbulkan risiko pada tautan data.

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

get

*Instans.

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

None

Sintaks permintaan

GET /instances/{instanceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans yang akan dikueri.	rmq-cn-7e22ody****

Parameter permintaan

Parameter

Type

Required

Description

Example

Tidak ada parameter yang diperlukan.

Elemen respons

Element	Type	Description	Example
	object	Data tanggapan.
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik yang dapat Anda gunakan untuk memecahkan masalah dan melacak masalah.	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	Apakah operasi berhasil.	true
data	object	Hasil tanggapan.
regionId	string	ID wilayah tempat instans berada.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
instanceName	string	Nama instans.	instans uji
status	string	Status instans. Valid values: RELEASED : Dirilis. RUNNING : Berjalan. STOPPED : Dihentikan. CHANGING : Berubah. CREATING : Sedang dibuat.	RUNNING
startTime	string	Pengatur waktu saat instans dimulai. Format adalah YYYY-MM-DD HH:mm:ss.	2022-08-01 00:00:00
expireTime	string	Pengatur waktu saat Instans kedaluwarsa. Format adalah YYYY-MM-DD HH:mm:ss.	2022-09-01 00:00:00
releaseTime	string	Pengatur waktu saat instans dirilis. Format adalah YYYY-MM-DD HH:mm:ss.	2022-09-07 00:00:00
userId	string	ID pengguna tempat instans berada.	111111111111111
bid	string	BID saluran penjualan untuk komoditas.	26842
commodityCode	string	Kode komoditas instans seri MSMQ for RocketMQ 5.x, seperti ons_rmqsub_public_cn.	ons_rmqsub_public_cn
serviceCode	string	Kode layanan instans. Kode layanan untuk MSMQ for RocketMQ adalah rmq.	rmq
seriesCode	string	Kode seri utama instans. Untuk perbedaan antar seri utama, lihat Pemilihan produk. Valid values: standard : Edisi Standar. shared : Edisi Shared. dedicated : Edisi Dedicated. ultimate : Edisi Platinum. professional : Edisi Profesional.	standard
subSeriesCode	string	Kode subseri instans. Untuk perbedaan antar subseri, lihat Pemilihan produk. Valid values: serverless : Edisi arsitektur tanpa server. cluster_ha : Edisi ketersediaan tinggi kluster. single_node : Edisi node tunggal.	cluster_ha
paymentType	string	Tipe pembayaran instans. Valid values: PayAsYouGo : Pay-as-you-go (pascabayar) Subscription : Subscription (prabayar)	Subscription
remark	string	Keterangan untuk instans.	Ini adalah keterangan untuk instans
networkInfo	object	Informasi jaringan.
vpcInfo	object	Informasi VPC.
vpcId	string	ID VPC yang terkait dengan instans.	vpc-uf6of9452b2pba82c****
vSwitchId `deprecated`	string	ID vSwitch yang terkait dengan instans. Penting Bidang ini tidak direkomendasikan. Gunakan bidang vSwitches sebagai gantinya. Untuk kompatibilitas, bidang ini saat ini hanya mengembalikan satu vSwitch.	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	Daftar vSwitch.
	object
vSwitchId	string	ID vSwitch.	vsw-uf6gwtbn6etadpvz7****
zoneId	string	ID zona.	cn-hangzhou
securityGroupIds	string	ID grup keamanan.	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	Informasi titik akhir.
	object	Informasi titik akhir.
endpointType	string	Tipe titik akhir instans. Valid values: TCP_VPC : Titik akhir VPC. TCP_INTERNET : Titik akhir Internet.	TCP_INTERNET
endpointUrl	string	Titik akhir instans.	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	Daftar putih IP untuk akses jaringan publik. Daftar putih IP hanya didukung untuk titik akhir Internet dan tidak didukung untuk titik akhir VPC. Jika tidak ada daftar putih IP yang dikonfigurasi, semua rentang alamat IP diizinkan untuk mengakses broker antrian MSMQ for RocketMQ melalui Internet secara default. Jika daftar putih IP dikonfigurasi, hanya alamat IP dalam daftar putih yang diizinkan untuk mengakses broker antrian MSMQ for RocketMQ melalui Internet. Bidang ini tidak lagi direkomendasikan. Gunakan bidang internetInfo.ipWhitelist sebagai gantinya.	192.168.x.x/24
	string	Daftar putih IP untuk akses jaringan publik.	192.168.x.x/24
endpointId	string	Instans Titik akhir PrivateLink yang terkait.	ep-bpxxx
internetInfo	object	Informasi jaringan publik instans.
internetSpec	string	Apakah akses jaringan publik diaktifkan. Instans mendukung akses VPC secara default. Jika akses jaringan publik diaktifkan, ApsaraMQ for RocketMQ mengenakan biaya untuk bandwidth downstream publik. Untuk informasi lebih lanjut tentang penagihan, lihat Biaya akses jaringan publik. Valid values: enable : Akses jaringan publik diaktifkan. disable : Akses jaringan publik dinonaktifkan.	enable
flowOutType	string	Tipe penagihan untuk penggunaan jaringan publik. Valid values: payByBandwidth : Penagihan bandwidth tetap. Nilai ini dikembalikan ketika akses jaringan publik diaktifkan. uninvolved : Tidak berlaku. Nilai ini dikembalikan ketika akses jaringan publik tidak diaktifkan.	payByBandwidth
flowOutBandwidth	integer	Spesifikasi bandwidth Internet. Unit: Mbit/s.	1
ipWhitelist	array	Daftar putih IP untuk akses jaringan publik. Jika daftar putih IP tidak dikonfigurasi, semua rentang alamat IP diizinkan mengakses broker ApsaraMQ for RocketMQ melalui jaringan publik secara default. Jika daftar putih IP dikonfigurasi, hanya alamat IP dalam daftar putih yang diizinkan mengakses broker ApsaraMQ for RocketMQ melalui jaringan publik.
	string	Alamat IP dalam daftar putih akses jaringan publik.	192.168.x.x/24
accountInfo	object	Informasi akun.
username	string	Nama pengguna instans. Saat menggunakan akses jaringan publik, Anda harus mengonfigurasi nama pengguna dan kata sandi instans di kode SDK untuk verifikasi identitas.	6W0xz2uPfiwp****
instanceQuotas	array<object>	Informasi kapasitas.
	object	Informasi kapasitas.
quotaName	string	Nama kuota instans. Valid values: TOPIC_COUNT : Kuota pembuatan topik instans.	TOPIC_COUNT
usedCount	number	Kuota yang digunakan. Unit: count.	10
freeCount	number	Kuota gratis. Unit: count.	20
totalCount	number	Total kuota. Unit: count.	100
createTime	string	Waktu instans dibuat. Nilai dalam format YYYY-MM-DD HH:mm:ss.	2022-08-01 00:00:00
updateTime	string	Waktu instans terakhir dimodifikasi. Nilai dalam format YYYY-MM-DD HH:mm:ss.	2022-08-02 00:00:00
extConfig `deprecated`	object	[Tidak digunakan lagi] Konfigurasi tambahan. Bidang ini tidak lagi direkomendasikan. Gunakan bidang ProdukInfo, internetInfo, dan aclInfo sebagai gantinya.
aclType	string	Tipe otentikasi instans. Valid values: default : Pengenalan identitas cerdas. apache_acl : Apache RocketMQ ACL.	default
sendReceiveRatio	number	Rasio pengiriman Paket terhadap penerimaan Paket.	0.5
autoScaling	boolean	Apakah kapasitas elastis burstable di luar spesifikasi dasar diaktifkan. Parameter ini hanya berlaku ketika nilai supportAutoScaling adalah enable, yang berarti instans mendukung pengaktifan kapasitas elastis. Valid values: true : Kapasitas elastis diaktifkan. false : Kapasitas elastis tidak diaktifkan.	true
messageRetentionTime	integer	Periode retensi Paket. Unit: hours. Untuk rentang nilai, lihat Batas > Kuota Resource > Periode retensi Paket. Penyimpanan Paket ApsaraMQ for RocketMQ sepenuhnya arsitektur tanpa server dan elastis. Anda dikenakan biaya berdasarkan ruang penyimpanan yang sebenarnya digunakan. Anda dapat mengontrol kapasitas penyimpanan dengan menyesuaikan periode retensi Paket. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.	72
supportAutoScaling	boolean	Apakah instans mendukung pengaktifan kapasitas elastis burstable di luar spesifikasi dasar. Setelah kapasitas elastis burstable diaktifkan, ApsaraMQ for RocketMQ mengizinkan instans melampaui batas TPS spesifikasi dasar dalam rentang tertentu. Biaya spesifikasi elastis tambahan dikenakan untuk bagian yang melampaui spesifikasi dasar. Untuk informasi lebih lanjut tentang penagihan, lihat Biaya komputasi. Catatan Hanya instans dengan spesifikasi tertentu yang mendukung kapasitas elastis burstable. Untuk informasi lebih lanjut tentang instans yang didukung, lihat Spesifikasi instans. Valid values: true : Pengaktifan kapasitas elastis didukung. false : Pengaktifan kapasitas elastis tidak didukung.	true
internetSpec	string	Apakah akses jaringan publik diaktifkan. Instans mendukung akses VPC secara default. Jika akses jaringan publik diaktifkan, ApsaraMQ for RocketMQ mengenakan biaya untuk bandwidth downstream publik. Untuk informasi lebih lanjut tentang penagihan, lihat Biaya akses jaringan publik. Valid values: enable : Akses jaringan publik diaktifkan. disable : Akses jaringan publik dinonaktifkan.	enable
flowOutType	string	Tipe penagihan untuk penggunaan jaringan publik. Valid values: payByTraffic : Bayar berdasarkan lalu lintas. payByBandwidth : Bayar berdasarkan bandwidth. uninvolved : Tidak berlaku.	payByBandwidth
flowOutBandwidth	integer	Spesifikasi bandwidth Internet. Unit: Mbit/s.	10
msgProcessSpec	string	Spesifikasi pemrosesan Paket. Untuk batas atas TPS pengiriman dan penerimaan Paket, lihat Spesifikasi instans.	rmq.s2.2xlarge
resourceGroupId	string	ID kelompok sumber daya.	rg-acfm3tmjruyribi
productInfo	object	Konfigurasi tambahan instans.
msgProcessSpec	string	Spesifikasi pemrosesan Paket. Untuk batas atas TPS pengiriman dan penerimaan Paket, lihat Spesifikasi instans.	rmq.s2.2xlarge
sendReceiveRatio	number	Rasio pengiriman Paket terhadap penerimaan Paket.	0.5
autoScaling	boolean	Apakah kapasitas elastis burstable di luar spesifikasi dasar diaktifkan untuk skalabilitas tanpa hambatan. Parameter ini hanya berlaku ketika nilai supportAutoScaling adalah enable, yang berarti instans mendukung pengaktifan kapasitas elastis. Valid values: true : Kapasitas elastis diaktifkan. false : Kapasitas elastis tidak diaktifkan.	true
messageRetentionTime	integer	Periode retensi Paket. Unit: hours. Untuk rentang nilai, lihat Limits > Kuota Sumber Daya > Periode retensi Paket. Penyimpanan Paket ApsaraMQ for RocketMQ sepenuhnya menggunakan arsitektur tanpa server dan elastis. Anda akan dikenakan biaya berdasarkan ruang penyimpanan yang sebenarnya digunakan. Anda dapat mengontrol kapasitas penyimpanan dengan menyesuaikan periode retensi Paket. Untuk informasi lebih lanjut, lihat Storage fees.	72
supportAutoScaling	boolean	Apakah kemampuan elastis burstable di luar spesifikasi dasar diaktifkan. Setelah kemampuan elastis burstable diaktifkan, ApsaraMQ for RocketMQ memungkinkan Instans melampaui batas TPS spesifikasi dasar dalam rentang tertentu. Biaya spesifikasi elastis tambahan dikenakan untuk bagian yang melampaui spesifikasi dasar. Untuk informasi lebih lanjut tentang penagihan, lihat Computing capability fees. Catatan Hanya Instans dengan spesifikasi tertentu yang mendukung kemampuan elastis burstable. Untuk informasi lebih lanjut tentang Instans yang didukung, lihat Instance specifications. Valid values: true : Pengaktifan kapasitas elastis didukung. false : Pengaktifan kapasitas elastis tidak didukung.	true
traceOn	boolean	Apakah fitur jejak Paket diaktifkan. true: Fitur jejak Paket diaktifkan. false: Fitur jejak Paket dinonaktifkan. Parameter ini tidak berlaku. Instans mendukung fitur jejak Paket secara default terlepas dari apakah parameter ini diaktifkan.	true
storageEncryption	boolean	Apakah enkripsi penyimpanan diaktifkan.	false
storageSecretKey	string	Kunci enkripsi penyimpanan.	xxxxx
capacityType	string	Mode kapasitas. Valid values: provisioned : provisioned + elastic. ondemand : pay-as-you-go.	provisioned
provisionedCapacity	integer	Kapasitas yang disediakan.	3000
drReplicationMode	string	Mode replikasi lintas wilayah.	async_cross_az
maxDelayTime	integer	Interval maksimum untuk Paket terjadwal. Unit: seconds.	3456000
adaptiveElasticity	boolean	Elastisitas adaptif.	false
aclInfo	object	Informasi kontrol akses.
aclTypes	array	Tipe otentikasi instans.
	string	Tipe otentikasi instans. Valid values: default : Pengenalan identitas cerdas. apache_acl : Pengenalan identitas ACL.	default
defaultVpcAuthFree	boolean	Apakah fitur bebas otentikasi di VPC diaktifkan. Valid values: true : Diaktifkan. false : Dinonaktifkan.	true
aclType `deprecated`	string	Tipe otentikasi instans. Parameter ini tidak digunakan lagi. Gunakan parameter aclTypes sebagai gantinya. Valid values: default : Pengenalan identitas cerdas. apache_acl : Pengenalan identitas ACL.	default
software	object	Informasi perangkat lunak Instans.
softwareVersion	string	Versi perangkat lunak.	5.0-rmq-20230619-1
maintainTime `deprecated`	string	Jendela waktu peningkatan, dalam format HH:mm-HH:mm.	02:00-06:00
upgradeMethod	string	Metode peningkatan. Valid values: auto : Peningkatan otomatis. maunal : Peningkatan manual.	auto
topicCount	integer	Jumlah topik.	10
groupCount	integer	Jumlah kelompok konsumen.	10
tags	array<object>	Tag sumber daya.
	object	Tag sumber daya.
key	string	Kunci tag sumber daya.	key
value	string	Nilai tag sumber daya.	value
autoRenew	boolean	Apakah perpanjangan otomatis diaktifkan.	false
autoRenewPeriod	integer	Apakah perpanjangan otomatis diaktifkan.	false
code	string	Kode kesalahan.	MissingInstanceId
message	string	Paket kesalahan.	Parameter InstansId wajib untuk tindakan ini.
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Paket kesalahan dinamis.	InstansId

Contoh

Respons sukses

JSONformat

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou.",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "test Instans",
    "status": "RUNNING.",
    "startTime": "2022-08-01 00:00:00",
    "expireTime": "2022-09-01 00:00:00",
    "releaseTime": "2022-09-07 00:00:00",
    "userId": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn.",
    "serviceCode": "rmq.",
    "seriesCode": "standard.",
    "subSeriesCode": "cluster_ha.",
    "paymentType": "Subscription.",
    "remark": "Ini adalah catatan untuk Instans.",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou."
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET.",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx."
        }
      ],
      "internetInfo": {
        "internetSpec": "enable.",
        "flowOutType": "payByBandwidth.",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT.",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default.",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable.",
      "flowOutType": "payByBandwidth.",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge."
    },
    "resourceGroupId": "rg-acfm3tmjruyribi.",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge.",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": true,
      "storageSecretKey": "xxxxx.",
      "capacityType": "provisioned.",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az.",
      "maxDelayTime": 3456000,
      "adaptiveElasticity": true
    },
    "aclInfo": {
      "aclTypes": [
        "default."
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default."
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto."
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "key.",
        "value": "value."
      }
    ],
    "autoRenew": true,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId.",
  "message": "Parameter InstansId wajib untuk tindakan ini.",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId.",
  "dynamicMessage": "InstansId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.