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

Mengambil detail instans tertentu.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah API manajemen untuk mengelola dan menanyakan resource Alibaba Cloud. Gunakan API ini hanya untuk jalur manajemen, bukan untuk jalur data inti dalam transportasi pesan, karena dapat menimbulkan risiko.

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

*Instance

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 ditanyakan.	rmq-cn-7e22ody****

Parameter permintaan

Parameter

Type

Required

Description

Example

Tidak ada parameter yang diperlukan.

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan untuk permintaan tersebut.
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID permintaan ini untuk memecahkan masalah.	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	object	Detail instans.
regionId	string	ID wilayah instans.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
instanceName	string	Nama instans.	test instance
status	string	Status instans. Nilai yang valid: RELEASED: Instans telah dirilis. RUNNING: Instans sedang berjalan. STOPPED: Instans dihentikan. CHANGING: Instans sedang menjalani perubahan konfigurasi. CREATING: Instans sedang dibuat. Valid values: RELEASED : Released RUNNING : Running STOPPED : Stopped CHANGING : Changing CREATING : Creating	RUNNING
startTime	string	Waktu saat instans dimulai.	2022-08-01 00:00:00
expireTime	string	Waktu kedaluwarsa instans.	2022-09-01 00:00:00
releaseTime	string	Waktu saat instans dirilis.	2022-09-07 00:00:00
userId	string	ID pengguna pemilik instans.	111111111111111
bid	string	ID bisnis (BID) komoditas.	26842
commodityCode	string	Kode komoditas instans ApsaraMQ for RocketMQ 5.0, seperti `ons_rmqsub_public_cn`.	ons_rmqsub_public_cn
serviceCode	string	Kode layanan instans. Nilai untuk ApsaraMQ for RocketMQ adalah `rmq`.	rmq
seriesCode	string	Kode seri utama instans. Untuk informasi lebih lanjut mengenai perbedaan antar edisi instans, lihat Pemilihan produk. Nilai yang valid: standard: Standard Edition ultimate: Platinum Edition professional: Professional Edition shared: Shared Edition dedicated: Exclusive Edition Valid values: standard : Standard Edition ultimate : Platinum Edition professional : Professional Edition	standard
subSeriesCode	string	Kode sub-seri instans. Untuk informasi lebih lanjut mengenai perbedaan antar edisi instans, lihat Pemilihan produk. Nilai yang valid: cluster_ha: High-availability Edition single_node: Single Node Edition serverless: Serverless Edition Valid values: cluster_ha : High-availability Edition single_node : Single Node Edition	cluster_ha
paymentType	string	Metode penagihan instans. Nilai yang valid: PayAsYouGo: pay-as-you-go Subscription: subscription Valid values: PayAsYouGo : pay-as-you-go Subscription : subscription	Subscription
remark	string	Catatan instans.	This is remark for instance.
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 sudah tidak digunakan lagi. Gunakan bidang `vSwitches` sebagai gantinya. Untuk kompatibilitas, bidang ini hanya mengembalikan satu vSwitch.	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	Daftar vSwitch yang terkait dengan instans.
	object
vSwitchId	string	ID vSwitch.	vsw-uf6gwtbn6etadpvz7****
zoneId	string	ID zona.	cn-hangzhou
securityGroupIds	string	ID grup keamanan.	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	Daftar titik akhir untuk instans.
	object	Detail satu titik akhir.
endpointType	string	Jenis titik akhir instans. Valid values: TCP_VPC : VPC endpoint TCP_INTERNET : public endpoint	TCP_INTERNET
endpointUrl	string	Titik akhir instans.	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	Daftar putih alamat IP untuk akses jaringan publik. Anda hanya dapat mengonfigurasi daftar putih alamat IP untuk titik akhir publik. Fitur ini tidak didukung untuk titik akhir VPC. Jika tidak ada daftar putih alamat IP yang dikonfigurasi, alamat IP apa pun dapat mengakses server ApsaraMQ for RocketMQ melalui jaringan publik. Jika daftar putih alamat IP dikonfigurasi, hanya alamat IP dalam daftar putih yang dapat mengakses server ApsaraMQ for RocketMQ melalui jaringan publik. Parameter ini sudah tidak digunakan lagi. Kami menyarankan Anda menggunakan parameter `internetInfo.ipWhitelist` sebagai gantinya.	192.168.x.x/24
	string	Alamat IP dalam daftar putih untuk akses jaringan publik.	192.168.x.x/24
endpointId	string	ID titik akhir PrivateLink yang terkait.	ep-bpxxx
internetInfo	object	Informasi jaringan publik instans.
internetSpec	string	Menunjukkan apakah akses jaringan publik diaktifkan. Nilai yang valid: enable: Diaktifkan disable: Dinonaktifkan Secara default, instans hanya dapat diakses dalam VPC. Mengaktifkan akses jaringan publik akan dikenai biaya untuk bandwidth publik keluar. Untuk informasi lebih lanjut, lihat Biaya akses jaringan publik. Valid values: enable : Enabled disable : Disabled	enable
flowOutType	string	Metode penagihan untuk traffic jaringan publik. Nilai yang valid: payByBandwidth: Metode penagihan bayar-per-bandwidth. Nilai ini dikembalikan jika akses jaringan publik diaktifkan. uninvolved: Tidak berlaku. Nilai ini dikembalikan jika akses jaringan publik dinonaktifkan. Valid values: payByBandwidth : pay-by-bandwidth uninvolved : not applicable	payByBandwidth
flowOutBandwidth	integer	Bandwidth publik, dalam satuan Mbit/s.	1
ipWhitelist	array	Daftar putih alamat IP untuk akses jaringan publik. Jika tidak ada daftar putih alamat IP yang dikonfigurasi, alamat IP apa pun dapat mengakses server ApsaraMQ for RocketMQ melalui jaringan publik. Jika daftar putih alamat IP dikonfigurasi, hanya alamat IP dalam daftar putih yang dapat mengakses server ApsaraMQ for RocketMQ melalui jaringan publik.
	string	Alamat IP dalam daftar putih untuk akses jaringan publik.	192.168.x.x/24
accountInfo	object	Informasi akun.
username	string	Username untuk instans. Jika Anda mengakses instans melalui jaringan publik, Anda harus mengonfigurasi username dan password dalam kode SDK Anda untuk verifikasi identitas.	6W0xz2uPfiwp****
instanceQuotas	array<object>	Daftar detail kuota untuk instans.
	object	Detail kuota tertentu.
quotaName	string	Nama kuota instans. Nilai yang valid: TOPIC_COUNT: kuota pembuatan topik untuk instans. Valid values: TOPIC_COUNT : The topic creation quota for the instance.	TOPIC_COUNT
usedCount	number	Jumlah kuota yang telah digunakan.	10
freeCount	number	Sisa jumlah kuota.	20
totalCount	number	Jumlah total kuota.	100
createTime	string	Waktu saat instans dibuat.	2022-08-01 00:00:00
updateTime	string	Waktu saat instans terakhir diperbarui.	2022-08-02 00:00:00
extConfig `deprecated`	object	Konfigurasi tambahan. Parameter ini sudah tidak digunakan lagi. Kami menyarankan Anda menggunakan parameter seperti `productInfo`, `internetInfo`, dan `aclInfo` sebagai gantinya.
aclType	string	Jenis autentikasi instans. Nilai yang valid: default: Intelligent identity verification Valid values: default : intelligent identity verification	default
sendReceiveRatio	number	Rasio pesan terkirim terhadap pesan diterima.	0.5
autoScaling	boolean	Menentukan apakah skalabilitas elastis diaktifkan. Nilai yang valid: true: Diaktifkan false: Dinonaktifkan Parameter ini hanya berlaku jika instans mendukung skalabilitas elastis (ketika `supportAutoScaling` bernilai `true`). Valid values: true : Enabled false : Disabled	true
messageRetentionTime	integer	Periode retensi pesan, dalam satuan jam. Untuk rentang nilai, lihat bagian "Message retention period" dalam topik "Resource quotas" di Limits. ApsaraMQ for RocketMQ menyediakan penyimpanan pesan arsitektur tanpa server dan menagih Anda berdasarkan ruang penyimpanan aktual yang digunakan. Anda dapat mengubah periode retensi pesan untuk mengelola kapasitas penyimpanan. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.	72
supportAutoScaling	boolean	Menunjukkan apakah instans mendukung skalabilitas elastis. Nilai yang valid: true: Didukung false: Tidak didukung Setelah Anda mengaktifkan skalabilitas elastis, ApsaraMQ for RocketMQ memungkinkan instans melebihi batas TPS spesifikasi dasar dalam rentang tertentu. Anda akan dikenai biaya untuk TPS yang melebihi spesifikasi dasar. Untuk informasi lebih lanjut, lihat Biaya kapasitas komputasi. Catatan Hanya edisi instans tertentu yang mendukung skalabilitas elastis. Untuk informasi lebih lanjut mengenai edisi instans yang didukung, lihat Jenis instans. Valid values: true : Supported false : Not supported	true
internetSpec	string	Menunjukkan apakah akses jaringan publik diaktifkan. Nilai yang valid: enable: Diaktifkan disable: Dinonaktifkan Secara default, instans hanya dapat diakses dalam VPC. Mengaktifkan akses jaringan publik akan dikenai biaya untuk bandwidth publik keluar. Untuk informasi lebih lanjut, lihat Biaya akses jaringan publik. Valid values: enable : Enabled disable : Disabled	enable
flowOutType	string	Metode penagihan untuk traffic jaringan publik. Nilai yang valid: payByTraffic: Pay-by-data-transfer payByBandwidth: Pay-by-bandwidth uninvolved: Not applicable Valid values: payByTraffic : pay-by-data-transfer payByBandwidth : pay-by-bandwidth uninvolved : not applicable	payByBandwidth
flowOutBandwidth	integer	Bandwidth publik, dalam satuan Mbit/s.	10
msgProcessSpec	string	Spesifikasi komputasi untuk pengiriman dan penerimaan pesan. Untuk informasi lebih lanjut mengenai TPS maksimum untuk pengiriman dan penerimaan pesan, lihat Jenis instans.	rmq.s2.2xlarge
resourceGroupId	string	ID kelompok sumber daya.	rg-acfm3tmjruyribi
productInfo	object	Konfigurasi tambahan instans.
msgProcessSpec	string	Spesifikasi komputasi untuk pengiriman dan penerimaan pesan. Untuk informasi lebih lanjut mengenai TPS maksimum untuk pengiriman dan penerimaan pesan, lihat Jenis instans.	rmq.s2.2xlarge
sendReceiveRatio	number	Rasio pesan terkirim terhadap pesan diterima.	0.5
autoScaling	boolean	Menentukan apakah skalabilitas elastis diaktifkan. Nilai yang valid: true: Diaktifkan false: Dinonaktifkan Parameter ini hanya berlaku jika instans mendukung skalabilitas elastis (ketika `supportAutoScaling` bernilai `true`). Valid values: true : Enabled false : Disabled	true
messageRetentionTime	integer	Periode retensi pesan, dalam satuan jam. Untuk rentang nilai, lihat bagian "Message retention period" dalam topik "Resource quotas" di Limits. ApsaraMQ for RocketMQ menyediakan penyimpanan pesan arsitektur tanpa server dan menagih Anda berdasarkan ruang penyimpanan aktual yang digunakan. Anda dapat mengubah periode retensi pesan untuk mengelola kapasitas penyimpanan. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.	72
supportAutoScaling	boolean	Menunjukkan apakah instans mendukung skalabilitas elastis. Nilai yang valid: true: Didukung false: Tidak didukung Setelah Anda mengaktifkan skalabilitas elastis, ApsaraMQ for RocketMQ memungkinkan instans melebihi batas TPS spesifikasi dasar dalam rentang tertentu. Anda akan dikenai biaya untuk TPS yang melebihi spesifikasi dasar. Untuk informasi lebih lanjut, lihat Biaya kapasitas komputasi. Catatan Hanya edisi instans tertentu yang mendukung skalabilitas elastis. Untuk informasi lebih lanjut mengenai edisi instans yang didukung, lihat Jenis instans. Valid values: true : Supported false : Not supported	true
traceOn	boolean	Menentukan apakah fitur jejak pesan diaktifkan. true: Diaktifkan false: Dinonaktifkan Parameter ini diabaikan. Fitur jejak pesan diaktifkan secara default terlepas dari nilai parameter ini.	true
storageEncryption	boolean	Menunjukkan apakah enkripsi penyimpanan diaktifkan.	false
storageSecretKey	string	Kunci rahasia untuk enkripsi penyimpanan.	xxxxx
capacityType	string	Mode kapasitas. provisioned: kapasitas disediakan dan skalabilitas elastis ondemand: on-demand Valid values: provisioned : provisioned capacity and elastic scaling ondemand : on-demand	provisioned
provisionedCapacity	integer	Kapasitas yang disediakan.	3000
drReplicationMode	string		async_cross_az
aclInfo	object	Informasi kontrol akses.
aclTypes	array	Daftar jenis autentikasi untuk instans.
	string	Jenis autentikasi instans. Valid values: default : Intelligent identity verification apache_acl : ACL-based identity verification	default
defaultVpcAuthFree	boolean	Menentukan apakah akses tanpa autentikasi dari dalam VPC diaktifkan. Valid values: true : Enabled false : Disabled	true
aclType `deprecated`	string	Jenis autentikasi instans. Parameter ini sudah tidak digunakan lagi. Kami menyarankan Anda menggunakan parameter `aclTypes` sebagai gantinya. Valid values: default : Intelligent identity verification apache_acl : ACL-based identity verification	default
software	object	Informasi perangkat lunak instans.
softwareVersion	string	Versi perangkat lunak.	5.0-rmq-20230619-1
maintainTime	string	Jendela pemeliharaan.	02:00-06:00
upgradeMethod	string	Menggunakan metode upgrade berikut: Nilai yang valid: auto: Otomatis manual: Manual Valid values: auto : Otomatis maunal : Manual	auto
topicCount	integer	Jumlah topik.	10
groupCount	integer	Jumlah kelompok konsumen.	10
tags	array<object>	Daftar tag sumber daya.
	object	Tag sumber daya.
key	string	Kunci tag sumber daya.	key
value	string	Nilai tag sumber daya.	value
code	string	Kode kesalahan.	MissingInstanceId
message	string	Pesan kesalahan.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "test instance",
    "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": "This is remark for instance.",
    "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": false,
      "storageSecretKey": "xxxxx",
      "capacityType": "provisioned",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az"
    },
    "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"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.