CreateBatchConsumer - PolarDB - Alibaba Cloud Documentation Center

Membuat Kunci API dalam Batch.

Deskripsi operasi

Catatan

Setiap Kluster dapat memiliki maksimum tiga cadangan yang dibuat secara manual dalam satu pengatur waktu.
Jika Paket error Exceeding the daily backup times of this DB cluster dikembalikan, tiga cadangan yang dibuat secara manual sudah ada di Kluster Anda. Hapus cadangan sebelum Anda memanggil operasi ini.
Setelah Anda memanggil operasi ini, tugas cadangan dibuat di latar belakang. Jika volume data Tingkat Tinggi, pencadangan mungkin memerlukan pengatur waktu lama. Tunggu hingga pencadangan selesai.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
GwClusterId	string	Yes	ID instans gerbang.	pg-xxxxxxxx
Count	integer	No	Jumlah Kunci API pengguna.	1
ConsumerGroupId	string	No	ID kelompok pengguna.	cg-xxxxxx
ClientToken	string	No	Token Klien yang digunakan untuk memastikan idempotensi permintaan dan mencegah pengiriman berulang. Token dihasilkan oleh Klien dan harus unik di antara permintaan yang berbeda. Token bersifat case-sensitive dan panjangnya tidak boleh melebihi 64 karakter ASCII.	6000170000591aed949d0f5********************
CreditToken	string	No	Kode penukaran. Jika ditentukan, cabang aktivasi isi ulang akan digunakan, dan jumlah serta Kuota diisi dari database.	"9"
Description	string	No	Awalan deskripsi konsumen.	myapp
RegionId	string	Yes	ID Wilayah.	cn-beijing

Elemen respons

Element	Type	Description	Example
	object	Skema Tanggapan.
RequestId	string	ID permintaan.	A7E6A8FD-C50B-46B2-BA85-D8B8D3******
TotalRecordCount	integer	Jumlah total Catatan.	2
PageRecordCount	integer	Jumlah Catatan pada halaman saat ini.	1
PageNumber	integer	Nomor halaman. Nilai default: 1.	1
PageSize	integer	Jumlah Catatan per halaman. Nilai valid: 30 50 100 Nilai default: 30.	30
TotalPages	integer	Jumlah total halaman.	1
Items	array<object>	Daftar objek konsumen.
	object	Objek konsumen.
ConsumerId	string	ID pengguna.	c-mqveroemc***
Name	string	Nama.	test
ConsumerGroupId	string	ID kelompok pengguna.	cg-xxxxxx
ConsumerTag	string	Tag konsumen.	test
ApiKey	string	Kunci API lengkap. Hanya dikembalikan dalam tanggapan ini.	xxxxxxxx
GwClusterId	string	ID instans gerbang.	pg-xxxxxxxxxx
ApiStatus	string	Status Kunci API. Nilai default: Active.	Active
ApiKeyStatus	string	Status Kunci API. Nilai default: Active.	Active
Status	string	Status konsumen. Nilai default: Enabled.	Enabled
GmtCreated	string	pengatur waktu pembuatan.	2024-10-16 16:46:20
GmtModified	string	pengatur waktu pembaruan.	2026-01-04T16:09:29+08:00
Description	string	Deskripsi aplikasi atau Catatan.	myapp
ApiKeyMd5	string	Hash MD5 Kunci API.	0769a11c2d474f96fbb527f8e273d3de
BudgetPolicyId	string	ID Kebijakan Anggaran. Setiap kunci memiliki Kebijakan Anggaran yang independen.	023aacc1effc4b56bb154bfbec6ba9**
BudgetLimit	integer	Batas Anggaran, yang sama dengan jumlah kredit per paket.	3000
BudgetUsed	integer	Kuota yang digunakan.	0
ExpireTime	string	pengatur waktu kedaluwarsa. pengatur waktu menggunakan standar ISO 8601 di zona waktu UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2025-06-25T09:37:10Z
Active	boolean	Apakah kunci aktif.	true
Expired	boolean	Apakah kunci telah kedaluwarsa.	false

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "TotalRecordCount": 2,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "TotalPages": 1,
  "Items": [
    {
      "ConsumerId": "c-mqveroemc***",
      "Name": "test.",
      "ConsumerGroupId": "cg-xxxxxx.",
      "ConsumerTag": "test.",
      "ApiKey": "xxxxxxxx.",
      "GwClusterId": "pg-xxxxxxxxxx.",
      "ApiStatus": "Active.",
      "ApiKeyStatus": "Active.",
      "Status": "Enabled.",
      "GmtCreated": "2024-10-16 16:46:20\n",
      "GmtModified": "2026-01-04T16:09:29+08:00",
      "Description": "myapp.",
      "ApiKeyMd5": "0769a11c2d474f96fbb527f8e273d3de.",
      "BudgetPolicyId": "023aacc1effc4b56bb154bfbec6ba9**",
      "BudgetLimit": 3000,
      "BudgetUsed": 0,
      "ExpireTime": "2025-06-25T09:37:10Z",
      "Active": true,
      "Expired": true
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.