DescribeDBInstanceNetInfo - Tair (Redis® OSS-Compatible)

Mengambil informasi jaringan instans ApsaraDB for Tair.

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

kvstore:DescribeDBInstanceNetInfo

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	r-bp1zxszhcgatnx****
NetType	string	No	Jenis jaringan.

Elemen respons

Element	Type	Description	Example
	object
InstanceNetworkType	string	Jenis jaringan. Nilai yang valid: CLASSIC: Classic Network. VPC: VPC.	CLASSIC
RequestId	string	ID permintaan.	FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B
NetInfoItems	object	Detail mengenai koneksi jaringan instans.
InstanceNetInfo	array<object>	Array berisi detail koneksi jaringan untuk instans.
	object	Detail koneksi jaringan.
DirectConnection	integer	Menunjukkan apakah alamat tersebut digunakan untuk koneksi langsung. Nilai yang valid: 0: Alamat tidak digunakan untuk koneksi langsung. 1: Alamat digunakan untuk koneksi langsung.	0
VSwitchId	string	ID vSwitch.	vsw-bp1e7clcw529l773d****
DBInstanceNetType	string	Jenis jaringan. Nilai yang valid: 0: jaringan publik. 1: Classic Network. 2: jaringan VPC.	1
Upgradeable	string	Sisa periode validitas string koneksi Classic Network, dalam detik. Catatan Nilai 0 menunjukkan bahwa string koneksi tidak kedaluwarsa.	0
ExpiredTime	string	Periode validitas string koneksi Classic Network, dalam detik.	5183778
ConnectionString	string	String koneksi instans.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
IPType	string	Jenis jaringan alamat IP. Nilai yang valid: Public: jaringan publik. Inner: Classic Network. Private: jaringan VPC.	Inner
VPCInstanceId	string	ID instans yang terkait dengan VPC.	r-bp1ky7j6qc7umk****
Port	string	Port layanan instans.	6379
VPCId	string	ID VPC tempat instans berada.	vpc-bp1nme44gek34slfc****
IPAddress	string	Alamat IP.	172.16.49.***
IsSlaveProxy	integer	Nilai 1 menunjukkan bahwa alamat jaringan ini digunakan untuk node replika di zona cadangan. Catatan Alamat ini hanya dikembalikan ketika Pemisahan baca/tulis multi-zona diaktifkan untuk instans.	1

Contoh

Respons sukses

JSONformat

{
  "InstanceNetworkType": "CLASSIC",
  "RequestId": "FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B",
  "NetInfoItems": {
    "InstanceNetInfo": [
      {
        "DirectConnection": 0,
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "DBInstanceNetType": "1",
        "Upgradeable": "0",
        "ExpiredTime": "5183778",
        "ConnectionString": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "IPType": "Inner",
        "VPCInstanceId": "r-bp1ky7j6qc7umk****",
        "Port": "6379",
        "VPCId": "vpc-bp1nme44gek34slfc****",
        "IPAddress": "172.16.49.***",
        "IsSlaveProxy": 1
      }
    ]
  }
}

Respons error

JSONformat

{
 "RequestId":"314C4FB3-4256-424F-9AD9-1A6B3444160A",
 "InstanceNetworkType":"Classic",
 "NetInfoItems":{
   "InstanceNetInfo":[{
     "DBInstanceNetType":"1",
     "Port":"6379",
     "ConnectionString":"r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com",
     "VPCId":"",
     "IPAddress":"xxx.xxx.xxx.xxx",
     "IPType":"Inner",
     "Upgradeable":"0"
   				   }]
   			 }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.