Buat instans Tair (Edisi Perusahaan) yang cloud-native.
Deskripsi operasi
Untuk panduan pemilihan instans, lihat Panduan Pemilihan Instans ApsaraDB Tair (Kompatibel dengan Redis OSS).
Pastikan Anda memahami sepenuhnya metode penagihan dan harga ApsaraDB Tair (Kompatibel dengan Redis OSS) sebelum menggunakan API ini.
Untuk petunjuk melakukan operasi ini di Konsol, lihat Buat instans Tair.
Untuk membuat tipe instans lain, seperti open source atau instans klasik Tair memory-optimized, Anda dapat memanggil API CreateInstance.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
kvstore:CreateTairInstance |
create |
*DBInstance
|
|
None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru. |
cn-hangzhou |
| InstanceName |
string |
No |
Nama instans. Nama harus memenuhi persyaratan berikut:
|
apitest |
| Password |
string |
No |
Password yang digunakan untuk menghubungkan ke instans. Password harus memenuhi persyaratan berikut:
|
Pass!123456 |
| InstanceClass |
string |
Yes |
Seri instans. Untuk informasi lebih lanjut, lihat topik berikut: |
tair.scm.standard.4m.32d |
| ZoneId |
string |
No |
ID zona primer. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar zona terbaru. Catatan
Anda juga dapat mengatur parameter SecondaryZoneId untuk menentukan zona sekunder. Node primer dan sekunder kemudian akan diterapkan di zona primer dan sekunder yang ditentukan untuk menerapkan arsitektur disaster recovery master-replica antar-zona. Misalnya, Anda dapat mengatur parameter ZoneId ke cn-hangzhou-h dan parameter SecondaryZoneId ke cn-hangzhou-g. |
cn-hangzhou-h |
| SecondaryZoneId |
string |
No |
ID zona sekunder. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID zona sekunder. Catatan
Anda tidak dapat menentukan beberapa ID zona atau mengatur parameter ini ke nilai yang sama dengan parameter ZoneId. |
cn-hangzhou-g |
| ChargeType |
string |
No |
Metode penagihan instans. Nilai yang valid:
Valid values:
|
PrePaid |
| VpcId |
string |
Yes |
ID VPC. Anda dapat memanggil operasi DescribeVpcs untuk mengkueri ID VPC. |
vpc-bp1nme44gek34slfc**** |
| VSwitchId |
string |
Yes |
ID vSwitch yang termasuk dalam VPC. Anda dapat memanggil operasi DescribeVpcs untuk mengkueri ID vSwitch. |
vsw-bp1e7clcw529l773d**** |
| Period |
integer |
No |
Durasi langganan. Nilai yang valid: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24,36, dan 60. Satuan: bulan. Catatan
Parameter ini wajib hanya jika parameter ChargeType diatur ke PrePaid. |
1 |
| BusinessInfo |
string |
No |
ID event promosi atau informasi bisnis. |
000000000 |
| CouponNo |
string |
No |
Kode kupon. |
youhuiquan_promotion_option_id_for_blank |
| SrcDBInstanceId |
string |
No |
Jika Anda ingin membuat instans berdasarkan set cadangan dari instans yang ada, atur parameter ini ke ID instans sumber. Catatan
Setelah Anda menentukan parameter SrcDBInstanceId, gunakan parameter BackupId, ClusterBackupId (disarankan untuk instans kluster cloud-native), atau RestoreTime untuk menentukan set cadangan atau titik waktu tertentu yang ingin Anda gunakan untuk membuat instans. Parameter SrcDBInstanceId harus digunakan bersama salah satu dari tiga parameter tersebut. |
r-bp1zxszhcgatnx**** |
| BackupId |
string |
No |
Anda dapat mengatur parameter BackupId ke ID set cadangan dari instans sumber. Sistem menggunakan data yang disimpan dalam set cadangan untuk membuat instans. Anda dapat memanggil operasi DescribeBackups untuk mengkueri ID set cadangan. Jika instans sumber adalah instans kluster, atur parameter BackupId ke ID set cadangan semua shard dari instans sumber, dipisahkan dengan koma (,). Contoh: "10**,11**,15**". Catatan
Jika instans Anda adalah instans kluster cloud-native, kami menyarankan Anda menggunakan DescribeClusterBackupList untuk mengkueri ID set cadangan instans kluster, seperti cb-xx. Kemudian, atur parameter permintaan ClusterBackupId ke ID set cadangan tersebut untuk mengkloning instans kluster. Hal ini menghilangkan kebutuhan untuk menentukan ID set cadangan setiap shard. |
2158****20 |
| ClusterBackupId |
string |
No |
Parameter ini didukung untuk instans kluster baru tertentu. Anda dapat mengkueri ID set cadangan dengan memanggil operasi DescribeClusterBackupList.
|
cb-hyxdof5x9kqb**** |
| RecoverConfigMode |
string |
No |
Menentukan apakah akan memulihkan informasi akun, parameter kernel, dan daftar putih dari set cadangan asli saat Anda membuat instans dari set cadangan yang ditentukan. Misalnya, jika Anda ingin memulihkan informasi akun, atur parameter ke Parameter ini kosong secara default, yang menunjukkan bahwa informasi akun, parameter kernel, dan daftar putih tidak dipulihkan dari set cadangan asli. Catatan
Parameter ini hanya berlaku untuk instans kluster cloud-native. Informasi akun, parameter kernel, dan daftar putih harus disimpan dalam set cadangan asli. Anda dapat memanggil operasi DescribeBackups untuk memeriksa apakah konfigurasi RecoverConfigMode dalam set cadangan yang ditentukan berisi informasi tersebut. |
whitelist,config,account |
| PrivateIpAddress |
string |
No |
Alamat IP internal instans. Catatan
Alamat IP harus berada dalam Blok CIDR dari vSwitch tempat instans akan terhubung. Anda dapat memanggil operasi DescribeVSwitches dari VPC untuk mengkueri informasi Blok CIDR. |
172.16.88.*** |
| AutoUseCoupon |
string |
No |
Menentukan apakah akan menggunakan kupon. Nilai yang valid:
|
true |
| AutoRenew |
string |
No |
Menentukan apakah akan mengaktifkan perpanjangan otomatis untuk instans. Nilai yang valid:
|
true |
| AutoRenewPeriod |
string |
No |
Durasi langganan yang didukung oleh perpanjangan otomatis. Satuan: bulan. Nilai yang valid: 1, 2, 3, 6, dan 12. Catatan
Parameter ini wajib jika parameter AutoRenew diatur ke true. |
3 |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya yang ingin Anda kelola. Catatan
|
rg-acfmyiu4ekp**** |
| AutoPay |
boolean |
No |
Menentukan apakah akan mengaktifkan pembayaran otomatis. Atur nilainya ke true. |
true |
| ClientToken |
string |
No |
Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda dan peka terhadap huruf besar/kecil. Token hanya dapat berisi karakter ASCII dan tidak boleh melebihi 64 karakter. |
ETnLKlblzczshOTUbOCz**** |
| StorageType |
string |
No |
Tipe penyimpanan. Nilai yang valid: essd_pl1, essd_pl2, dan essd_pl3. Catatan
Parameter ini wajib hanya ketika Anda mengatur parameter InstanceType ke tair_essd untuk membuat instans berbasis ESSD. Nilai yang diizinkan:
|
essd_pl1 |
| Storage |
integer |
No |
Kapasitas penyimpanan instans berbasis ESSD/SSD. Nilai yang valid bervariasi berdasarkan tipe instans. Untuk informasi lebih lanjut, lihat Instans berbasis ESSD/SSD. Catatan
Parameter ini wajib hanya ketika Anda mengatur parameter InstanceType ke tair_essd untuk membuat instans berbasis ESSD. Jika Anda membuat instans Tair berbasis SSD, parameter Storage secara otomatis ditentukan berdasarkan spesifikasi yang telah ditentukan. Anda tidak perlu menentukan parameter ini. |
60 |
| ShardType |
string |
No |
Tipe shard instans. Nilai yang valid:
|
MASTER_SLAVE |
| ShardCount |
integer |
No |
Jumlah node data dalam instans. Nilai yang valid:
Catatan
Ketika parameter InstanceType diatur ke tair_rdb atau tair_scm, parameter ini dapat diatur ke nilai dalam rentang 2 hingga 32. Hanya instans berbasis DRAM dan instans yang dioptimalkan untuk memori persisten yang mendukung arsitektur kluster. |
2 |
| ReplicaCount |
integer |
No |
Jumlah node replika di zona primer. Parameter ini hanya berlaku untuk instans kluster multi-replika cloud-native. Nilai yang valid: 1 hingga 4. Catatan
|
2 |
| SlaveReplicaCount |
integer |
No |
Jumlah node replika di zona sekunder saat Anda membuat instans kluster multi-replika cloud-native yang diterapkan di beberapa zona. Jumlah nilai parameter ini dan parameter ReplicaCount tidak boleh melebihi 4. Catatan
Saat Anda membuat instans kluster multi-replika cloud-native yang diterapkan di beberapa zona, Anda harus menentukan SlaveReplicaCount dan SecondaryZoneId. |
2 |
| ReadOnlyCount |
integer |
No |
Jumlah replika baca saja di zona primer. Parameter ini hanya berlaku untuk instans pemisahan baca/tulis cloud-native. Nilai yang valid: 1 hingga 9. Catatan
Jumlah nilai parameter ini dan parameter SlaveReadOnlyCount tidak boleh melebihi 9. |
5 |
| SlaveReadOnlyCount |
integer |
No |
Jumlah replika baca saja di zona sekunder saat Anda membuat instans pemisahan baca/tulis multi-zona. Jumlah nilai parameter ini dan parameter ReadOnlyCount tidak boleh melebihi 9. Catatan
Saat Anda membuat instans pemisahan baca/tulis multi-zona, Anda harus menentukan SlaveReadOnlyCount dan SecondaryZoneId. |
1 |
| EngineVersion |
string |
No |
Versi mesin database. Nilai default: 1.0. Nilai parameter bervariasi berdasarkan seri instans Tair.
|
1.0 |
| InstanceType |
string |
Yes |
Seri instans. Nilai yang valid:
|
tair_scm |
| GlobalInstanceId |
string |
No |
Menentukan apakah akan menggunakan instans yang dibuat sebagai instans anak dari instans terdistribusi.
Catatan
Jika Anda ingin instans yang dibuat digunakan sebagai instans terdistribusi, instans yang dibuat harus merupakan instans Tair berbasis DRAM. |
gr-bp14rkqrhac**** |
| Tag |
array<object> |
No |
Detail tag. |
|
|
object |
No |
Informasi tentang tag. |
||
| Key |
string |
No |
Kunci tag. Tag adalah pasangan kunci-nilai. Catatan
Maksimal lima pasangan kunci-nilai dapat ditentukan sekaligus. |
key1_test |
| Value |
string |
No |
Nilai tag. Catatan
N menentukan nilai tag ke-N. Misalnya, Tag.1.Value menentukan nilai tag pertama, dan Tag.2.Value menentukan nilai tag kedua. |
value1_test |
| DryRun |
boolean |
No |
Menentukan apakah hanya akan melakukan dry run, tanpa menjalankan permintaan sebenarnya. Nilai yang valid:
|
false |
| Port |
integer |
No |
Nomor port layanan instans. Nilai yang valid: 1024 hingga 65535. Nilai default: 6379. |
6379 |
| GlobalSecurityGroupIds |
string |
No |
Templat daftar putih IP global dari instans. Pisahkan beberapa templat daftar putih IP dengan koma (,). Setiap templat daftar putih IP harus unik. |
g-zsldxfiwjmti0kcm**** |
| ParamGroupId |
string |
No |
ID template parameter. Instans dibuat berdasarkan parameter dalam template parameter. ID harus unik. |
g-50npzjcqb1ua6q6j**** |
| RestoreTime |
string |
No |
Jika flashback data diaktifkan untuk instans sumber, Anda dapat menggunakan parameter ini untuk menentukan titik waktu dalam periode retensi cadangan instans sumber. Sistem menggunakan data cadangan instans sumber pada titik waktu tersebut untuk membuat instans. Tentukan waktu dalam standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. |
2021-07-06T07:25:57Z |
| ConnectionStringPrefix |
string |
No |
Awalan titik akhir. Awalan harus terdiri dari 8 hingga 40 karakter dan dapat berisi huruf kecil dan angka. Awalan harus dimulai dengan huruf kecil. Catatan
Titik akhir harus dalam format <awalan>.redis.rds.aliyuncs.com. |
r-bp1zxszhcgatnx**** |
| InstanceEndpointType |
string |
No |
Tipe alamat koneksi yang digunakan saat membuat instans penyebaran dual-zone cloud-native dengan pemisahan baca/tulis. Jika parameter ini tidak ditentukan secara eksplisit, nilai default-nya adalah AzIndependentEndpoint.
Penting Parameter ini hanya berlaku untuk instans penyebaran dual-zone cloud-native dengan pemisahan baca/tulis. Untuk tipe instans lain, hanya alamat koneksi independen per zona yang didukung; menentukan UnifiedEndpoint tidak akan berpengaruh. Penting Opsi UnifiedEndpoint saat ini hanya tersedia untuk pengguna daftar putih. Pengguna non-daftar putih yang menentukan parameter ini akan menerima kesalahan saat pemanggilan. Untuk meminta akses, kirim tiket untuk mengajukan penambahan ke daftar putih. |
AzIndependentEndpoint |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Parameter respons. |
||
| QPS |
integer |
Jumlah maksimum operasi baca dan tulis yang dapat diproses oleh instans per detik. Nilai ini merupakan nilai teoretis. |
100000 |
| ConnectionDomain |
string |
Titik akhir internal instans. |
r-bp13ac3d047b****.tairpena.rds.aliyuncs.com |
| ChargeType |
string |
Metode penagihan instans. Nilai yang valid:
|
PrePaid |
| InstanceId |
string |
ID instans. |
r-bp13ac3d047b**** |
| Port |
integer |
Nomor port layanan instans. |
6379 |
| Config |
string |
Konfigurasi detail instans. Nilainya adalah string JSON. Untuk informasi lebih lanjut tentang parameter, lihat Konfigurasikan parameter. |
{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64} |
| RegionId |
string |
ID wilayah. |
cn-hangzhou |
| RequestId |
string |
ID permintaan. |
12123216-4B00-4378-BE4B-08005BFC**** |
| Bandwidth |
integer |
Bandwidth maksimum instans. Satuan: Mbit/s. |
96 |
| Connections |
integer |
Jumlah maksimum koneksi ke instans. |
10000 |
| InstanceName |
string |
Nama instans. Catatan
Parameter ini hanya dikembalikan jika parameter InstanceName ditentukan dalam permintaan. |
redistest |
| ZoneId |
string |
ID zona. |
cn-hangzhou-h |
| InstanceStatus |
string |
Status saat ini dari instans. Nilainya adalah Creating. |
Creating |
| TaskId |
string |
ID tugas. |
10**** |
| OrderId |
integer |
ID pesanan. |
2084452111111 |
Contoh
Respons sukses
JSONformat
{
"QPS": 100000,
"ConnectionDomain": "r-bp13ac3d047b****.tairpena.rds.aliyuncs.com",
"ChargeType": "PrePaid",
"InstanceId": "r-bp13ac3d047b****",
"Port": 6379,
"Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"list-max-ziplist-entries\\\":512,\\\"list-max-ziplist-value\\\":64,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
"RegionId": "cn-hangzhou",
"RequestId": "12123216-4B00-4378-BE4B-08005BFC****",
"Bandwidth": 96,
"Connections": 10000,
"InstanceName": "redistest",
"ZoneId": "cn-hangzhou-h",
"InstanceStatus": "Creating",
"TaskId": "10****",
"OrderId": 2084452111111
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | MissingParameter | Period is mandatory for this action. | |
| 400 | InvalidToken.Malformed | The Specified parameter Token is not valid. | |
| 400 | InvalidInstanceName.Malformed | The Specified parameter InstanceName is not valid. | |
| 400 | InvalidPassword.Malformed | The Specified parameter Password is not valid. | |
| 400 | InsufficientBalance | Your account does not have enough balance. | |
| 400 | QuotaExceed.AfterpayInstance | Living afterpay instances quota exceeded. | |
| 400 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | |
| 400 | ResourceNotAvailable | Resource you requested is not available for finance user. | |
| 400 | PaymentMethodNotFound | No payment method has been registered on the account. | |
| 400 | IdempotentParameterMismatch | Request uses a client token in a previous request but is not identical to that request. | |
| 400 | QuotaNotEnough | Quota not enough in this zone. | |
| 400 | QuotaExceed | Living afterpay instances quota exceed. | |
| 400 | VpcServiceError | Invoke vpc service failed. | |
| 400 | IzNotSupportVpcError | Specify iz not support vpc. | |
| 400 | InvalidvSwitchId | The vpc does not cover the vswitch. | |
| 400 | InvalidIzNo.NotSupported | The Specified vpc zone not supported. | |
| 400 | InvalidAccountPassword.Format | Specified account password is not valid. | |
| 400 | InstanceClass.NotMatch | Current instance class and instance type is not match. | |
| 400 | InvalidVPCId.NotFound | Specified virtual vpc is not found. | |
| 400 | AccountMoneyValidateError | Account money validate error. | |
| 400 | RequestTokenConflict | Specified request token conflict. | |
| 400 | InvalidIPNotInSubnet | Error ip not in subnet. | |
| 400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | |
| 400 | Zone.Closed | The specified zone is closed. | |
| 400 | VSwithNotBelongToNotVpcFault | The vSwitch does not belong to current vpc. | |
| 400 | PayIllegalAgreement | Pay mayi with holding agreement illegal. | |
| 400 | IllegalParamError | validateSaleConditionWithSubArticle failed. | |
| 400 | CASH_BOOK_INSUFFICIENT | No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000. | |
| 400 | InvalidRegion.Format | Specified Region is not valid. | |
| 403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | |
| 403 | AuthorizationFailure | The request processing has failed due to authorization failure. | |
| 403 | TokenServiceError | The specified token is duplicated, please change it. | |
| 403 | UserCannotBuyNotInnerCommodity | The user can not buy this commodity without alibaba group tag. | |
| 404 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | |
| 404 | InvalidvSwitchId | The Specified vSwitchId zone not supported. | |
| 404 | InvalidVpcIdOrVswitchId.NotSupported | The Specified vpcId or vSwitchId not supported. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.