DescribeInstanceAttribute - Tair (Redis® OSS-Compatible)

Mengambil detail instans Tair (kompatibel dengan Redis).

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

get

*DBInstance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	r-bp1zxszhcgatnx****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	CA40C261-EB72-4EDA-AC57-958722162595
Instances	object
DBInstanceAttribute	array<object>	Detail instans.
	array<object>
VpcId	string	ID virtual private cloud (VPC).	vpc-bp1nme44gek34slfc****
PrivateIp	string	Alamat IP pribadi instans. Catatan Parameter ini tidak dikembalikan jika jenis jaringan instans adalah classic network.	172.16.49.***
Capacity	integer	Kapasitas memori instans. Satuan: MB.	1024
CreateTime	string	Waktu saat instans dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2019-03-06T10:42:03Z
ConnectionDomain	string	Titik akhir internal instans.	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	Menunjukkan apakah instans dikelola oleh RDS. Nilai yang valid: true: Instans dikelola oleh RDS. false: Instans tidak dikelola oleh RDS.	true
ChargeType	string	Metode penagihan instans. Nilai yang valid: PrePaid: subscription PostPaid: pay-as-you-go	PostPaid
StorageType	string	Jenis penyimpanan.	essd_pl1
VpcAuthMode	string	Mode autentikasi untuk instans yang dideploy di VPC. Nilai yang valid: Open: Autentikasi kata sandi diaktifkan. Close: Akses tanpa kata sandi diaktifkan.	Open
ArchitectureType	string	Arsitektur instans. Nilai yang valid: cluster: Instans merupakan instans kluster. standard: Instans merupakan instans standar. rwsplit: Instans merupakan instans read/write splitting.	standard
AvailabilityValue	string	Metrik ketersediaan instans pada bulan berjalan.	100%
NetworkType	string	Jenis jaringan instans. Nilai yang valid: CLASSIC: classic network VPC: VPC	CLASSIC
Port	integer	Port layanan instans.	6379
SecondaryZoneId	string	ID zona sekunder. Catatan Jika instans tidak dideploy di zona sekunder, parameter ini tidak dikembalikan.	cn-hongkong-h
PackageType	string	Edisi instans. Nilai yang valid: standard: edisi standar customized: Edisi khusus telah dihentikan.	standard
EngineVersion	string	Versi mesin database instans. Nilai yang valid: 2.8, 4.0, 5.0, 6.0, dan 7.0.	4.0
Config	string	Pengaturan parameter instans. Pengaturan dalam format JSON. Untuk informasi selengkapnya, lihat Parameters. Untuk melihat konfigurasi log audit, panggil operasi DescribeAuditLogConfig.	{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
VpcCloudInstanceId	string	ID instans yang dideploy di VPC.	r-bp1d72gwl41z7f****
Bandwidth	integer	Bandwidth instans. Satuan: Mbit/s.	10
InstanceName	string	Nama instans.	apitest
SecurityIPList	string	Daftar putih alamat IP.	127.0.0.1
ShardCount	integer	Jumlah shard.	2
ReplicaCount	integer	Jumlah node replika di zona primer. Catatan Parameter ReplicaCount dan SlaveReplicaCount hanya dikembalikan untuk instans cloud-native. Jika instans menggunakan arsitektur kluster, parameter ini menunjukkan jumlah node replika per shard di zona primer dan sekunder.	1
SlaveReplicaCount	integer	Jumlah node replika di zona sekunder.	1
ReadOnlyCount	integer	Jumlah node read-only di zona primer. Catatan Parameter ReadOnlyCount dan SlaveReadOnlyCount hanya dikembalikan untuk instans cloud-native yang telah mengaktifkan read/write splitting. Jika instans menggunakan arsitektur kluster, parameter ini menunjukkan jumlah node read-only per shard di zona primer dan sekunder.	5
SlaveReadOnlyCount	integer	Jumlah node read-only di zona sekunder. Parameter ini hanya dikembalikan ketika read/write splitting diaktifkan untuk instans yang dideploy di beberapa zona.	2
GlobalInstanceId	string	ID instans terdistribusi. Catatan Parameter ini hanya dikembalikan untuk instans anak dari instans terdistribusi.	gr-bp14rkqrhac****
QPS	integer	Permintaan per detik (QPS) maksimum.	100000
AuditLogRetention	string	Periode retensi log audit. Satuan: hari. Nilai 0 menunjukkan bahwa fitur log audit dinonaktifkan. Untuk informasi selengkapnya tentang cara mengaktifkan fitur log audit, lihat Enable audit logging.	15
ZoneType	string	Jenis zona instans. Nilai yang valid: singlezone: single-zone doublezone: multi-zone	singlezone
MaintainStartTime	string	Waktu mulai jendela pemeliharaan. Waktu dalam format HH:mmZ dan ditampilkan dalam UTC.	18:00Z
MaintainEndTime	string	Waktu akhir jendela pemeliharaan. Waktu dalam format HH:mmZ dan ditampilkan dalam UTC.	22:00Z
InstanceClass	string	Tipe instans. Untuk informasi selengkapnya, lihat Instance types.	redis.master.small.default
RealInstanceClass	string	Jika instans merupakan instans kluster cloud-native, parameter ini menunjukkan tipe instans aktual dari shard. Dalam kasus ini, parameter InstanceClass menunjukkan tipe instans virtual. Catatan Untuk menanyakan biaya instans dengan tipe instans ini, tentukan nilai parameter ini dalam operasi DescribePrice.	tair.rdb.with.proxy.1g
InstanceId	string	ID instans.	r-bp1d72gwl41z7f****
InstanceType	string	Mesin database. Nilai yang valid: Tair Redis: Instans Database Apsara untuk Redis Edisi Komunitas dan instans Database Apsara untuk Redis Enhanced Edition (Tair) tipe memori klasik menggunakan mesin database Redis. Memcache	Redis
HasRenewChangeOrder	string	Menunjukkan apakah terdapat pesanan tertunda untuk perpanjangan atau perubahan konfigurasi instans. Nilai yang valid: true false	false
InstanceReleaseProtection	boolean	Menunjukkan apakah perlindungan rilis diaktifkan untuk instans. Nilai yang valid: true: Perlindungan rilis diaktifkan. false: Perlindungan rilis dinonaktifkan.	false
ReplicationMode	string	Arsitektur replikasi. Nilai yang valid: master-slave: arsitektur master-replika cluster: arsitektur kluster, mencakup instans read/write splitting dan instans kluster db: arsitektur kluster sharded cloud-native	master-slave
RegionId	string	ID wilayah.	cn-hangzhou
EndTime	string	Waktu kedaluwarsa instans langganan. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC.	2019-04-06T10:42:03Z
VSwitchId	string	ID vSwitch.	vsw-bp1e7clcw529l773d****
ReplicaId	string	ID node replika.	bls-awxxxxxxxxxxxxx
NodeType	string	Jenis node. Nilai yang valid: double: Instans memiliki dua node data. single: Instans memiliki satu node data. readone: Instans read/write splitting memiliki satu node read-only. readthree: Instans read/write splitting memiliki tiga node read-only.	double
Connections	integer	Jumlah koneksi maksimum.	10000
BackupLogStartTime	string	Titik waktu paling awal untuk memulihkan data. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ dan ditampilkan dalam UTC. Catatan Parameter ini hanya dikembalikan jika fitur Data Flashback diaktifkan untuk instans. Saat Anda memanggil operasi RestoreInstance untuk melakukan flashback data, ini adalah nilai paling awal yang dapat ditentukan untuk parameter RestoreTime.	2021-07-06T05:49:55Z
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-acfmyiu4ekp****
ZoneId	string	ID zona.	cn-hongkong-b
InstanceStatus	string	Status instans. Nilai yang valid: Normal: Instans berjalan sebagaimana mestinya. Creating: Instans sedang dibuat. Changing: Konfigurasi instans sedang diubah. Inactive: Instans dinonaktifkan. Flushing: Instans sedang dirilis. Released: Instans telah dirilis. Transforming: Metode penagihan instans sedang diubah. Migrating: Instans sedang dimigrasi. BackupRecovering: Instans sedang dipulihkan dari backup. MinorVersionUpgrading: Versi minor instans sedang diperbarui. NetworkModifying: Jenis jaringan instans sedang diubah. SSLModifying: Sertifikat SSL instans sedang diubah. MajorVersionUpgrading: Versi utama instans sedang ditingkatkan. Instans tetap dapat diakses selama proses upgrade. Catatan Untuk informasi selengkapnya tentang status instans dan dampaknya, lihat Instance states.	Normal
Engine	string	Mesin database. Nilainya tetap Redis.	Redis
Storage	string	Storage space instans Database Apsara untuk Redis Enhanced Edition (Tair) yang menggunakan enhanced SSD (ESSD).	50
CloudType	string	Parameter ini hanya dikembalikan untuk instans Database Apsara untuk Redis yang dibuat di cloud Alibaba Cloud.	cloudbox
IsOrderCompleted	boolean	Menunjukkan apakah perubahan konfigurasi telah selesai. Nilai yang valid: true: Perubahan konfigurasi telah selesai, atau tidak ada perubahan konfigurasi yang sedang berlangsung. false: Perubahan konfigurasi sedang berlangsung.	true
IsSupportTDE	boolean	Menunjukkan apakah Enkripsi Data Transparan (TDE) didukung. Nilai yang valid: true: TDE didukung. Fitur ini hanya didukung untuk instans Database Apsara untuk Redis Enhanced Edition (Tair) tipe memori. false: TDE tidak didukung.	true
Tags	object
Tag	array<object>	Tag.
	object	Tag.
Key	string	Kunci tag.	tagkey
Value	string	Nilai tag.	tagvalue
AutoSecondaryZone	boolean	Menunjukkan apakah zona sekunder dipilih secara otomatis. Nilai yang valid: true: Zona sekunder dipilih secara otomatis. false: Zona sekunder tidak dipilih secara otomatis.	true
ComputingType	string

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CA40C261-EB72-4EDA-AC57-958722162595",
  "Instances": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "PrivateIp": "172.16.49.***",
        "Capacity": 1024,
        "CreateTime": "2019-03-06T10:42:03Z",
        "ConnectionDomain": "r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com",
        "IsRds": true,
        "ChargeType": "PostPaid",
        "StorageType": "essd_pl1",
        "VpcAuthMode": "Open",
        "ArchitectureType": "standard",
        "AvailabilityValue": "100%",
        "NetworkType": "CLASSIC",
        "Port": 6379,
        "SecondaryZoneId": "cn-hongkong-h",
        "PackageType": "standard",
        "EngineVersion": "4.0",
        "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
        "VpcCloudInstanceId": "r-bp1d72gwl41z7f****",
        "Bandwidth": 10,
        "InstanceName": "apitest",
        "SecurityIPList": "127.0.0.1",
        "ShardCount": 2,
        "ReplicaCount": 1,
        "SlaveReplicaCount": 1,
        "ReadOnlyCount": 5,
        "SlaveReadOnlyCount": 2,
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "QPS": 100000,
        "AuditLogRetention": "15",
        "ZoneType": "singlezone",
        "MaintainStartTime": "18:00Z",
        "MaintainEndTime": "22:00Z",
        "InstanceClass": "redis.master.small.default",
        "RealInstanceClass": "tair.rdb.with.proxy.1g",
        "InstanceId": "r-bp1d72gwl41z7f****",
        "InstanceType": "Redis",
        "HasRenewChangeOrder": "false",
        "InstanceReleaseProtection": false,
        "ReplicationMode": "master-slave",
        "RegionId": "cn-hangzhou",
        "EndTime": "2019-04-06T10:42:03Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "ReplicaId": "bls-awxxxxxxxxxxxxx",
        "NodeType": "double",
        "Connections": 10000,
        "BackupLogStartTime": "2021-07-06T05:49:55Z",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hongkong-b",
        "InstanceStatus": "Normal",
        "Engine": "Redis",
        "Storage": "50",
        "CloudType": "cloudbox",
        "IsOrderCompleted": true,
        "IsSupportTDE": true,
        "Tags": {
          "Tag": [
            {
              "Key": "tagkey",
              "Value": "tagvalue"
            }
          ]
        },
        "AutoSecondaryZone": true,
        "ComputingType": ""
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.