ListKeys - Key Management Service - Alibaba Cloud Documentation Center

Deskripsi operasi

Untuk informasi selengkapnya mengenai kebijakan akses yang diperlukan oleh pengguna RAM atau peran RAM untuk memanggil API ini, lihat Resource Access Management.

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.

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman. Nilai yang valid: lebih besar dari 0. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 1 hingga 100. Nilai default: 10.	10
Filters	string	No	Filter untuk master key. Filter terdiri dari 0 hingga 10 pasangan kunci-nilai. Key Description: Properti yang digunakan untuk filter. Type: String. Values Description: Nilai yang disertakan setelah difilter. Type: Array string. Panjang: 0 hingga 10. Nilai yang valid: Jika `Key` diatur ke `KeyState`, ini menentukan status kunci. Nilai yang valid untuk `Value` adalah `Enabled`, `Disabled`, `PendingDeletion`, dan `PendingImport`. Jika `Key` diatur ke `KeySpec`, ini menentukan tipe kunci. Nilai yang valid untuk `Value` adalah `Aliyun_AES_256`, `Aliyun_SM4`, `RSA_2048`, `EC_P256`, `EC_P256K`, `EC_SM2`, dan `Aliyun_SM4`. Catatan: Anda hanya dapat membuat kunci dengan tipe `EC_SM2` dan `Aliyun_SM4` di wilayah yang mendukung HSM terkelola dan telah lulus penilaian kepatuhan dari Office of State Commercial Cryptography Administration (OSCCA). Untuk informasi selengkapnya mengenai wilayah yang didukung, lihat Supported regions. Jika Anda menentukan `EC_SM2` atau `Aliyun_SM4` di wilayah yang tidak mendukung tipe kunci tersebut, parameter tersebut akan diabaikan. Jika `Key` diatur ke `KeyUsage`, ini menentukan penggunaan kunci. Nilai yang valid untuk `Value` adalah `ENCRYPT/DECRYPT` (untuk enkripsi dan dekripsi data) dan `SIGN/VERIFY` (untuk menghasilkan dan memverifikasi tanda tangan digital). Jika `Key` diatur ke `ProtectionLevel`, ini menentukan tingkat perlindungan kunci. Nilai yang valid untuk `Value` adalah `SOFTWARE` dan `HSM`. Catatan: Tingkat perlindungan HSM hanya didukung di wilayah tertentu. Untuk informasi selengkapnya mengenai wilayah yang didukung, lihat Supported regions. Jika Anda menentukan `HSM` di wilayah yang tidak mendukungnya, parameter tersebut akan diabaikan. Jika `Key` diatur ke `CreatorType`, ini menentukan tipe pembuat. Nilai yang valid untuk `Value` adalah `User` (mengembalikan master key yang dibuat oleh pengguna) dan `Service` (mengembalikan master key yang secara otomatis dibuat oleh layanan Alibaba Cloud lain berdasarkan otorisasi Anda). Jika `Key` diatur ke `DKMSInstanceId`, ini menentukan ID instans KMS. Atur `Value` sesuai kebutuhan. Jika `Key` diatur ke `keyId`, ini menentukan ID kunci. Atur `Value` sesuai kebutuhan. Jika `Key` diatur ke `AliasName`, ini menentukan alias kunci. Atur `Value` sesuai kebutuhan. Jika `Key` diatur ke `Creator`, ini menentukan pembuat kunci. Atur `Value` sesuai kebutuhan. Jika `Key` diatur ke `TagKey`, ini menentukan kunci dari tag kunci. Atur `Value` sesuai kebutuhan. Jika `Key` diatur ke `TagValue`, ini menentukan nilai dari tag kunci. Atur `Value` sesuai kebutuhan. Hubungan logis antara kunci yang berbeda dalam `Filters` adalah `AND`. Hubungan logis antara beberapa nilai untuk kunci yang sama adalah `OR`. Misalnya, jika Anda memasukkan `[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]`, semantiknya adalah: `(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256)`.	[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

Elemen respons

Element	Type	Description	Example
	object
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
RequestId	string	ID permintaan. Ini merupakan identifier unik global (GUID) yang dihasilkan oleh Alibaba Cloud. Anda dapat menggunakan ID permintaan ini untuk memecahkan masalah.	8252db58-2036-408c-a3d5-56e656dc2551
TotalCount	integer	Jumlah total master key.	3
Keys	object
Key	array<object>	Master key.
	object	Master key.
KeyId	string	Identifier unik global dari master key.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
KeyArn	string	Nama Sumber Daya Alibaba Cloud (ARN) dari master key.	acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****

Contoh

Respons sukses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "TotalCount": 3,
  "Keys": {
    "Key": [
      {
        "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
        "KeyArn": "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.