全部产品
Search
文档中心

Key Management Service:GetSecretValue

更新时间:Jun 28, 2025

Mengambil nilai rahasia menggunakan gateway KMS Instance.

Parameter permintaan

Parameter

Tipe

Diperlukan

Contoh

Deskripsi

SecretName

string

Ya

secret001

Nama rahasia.

VersionStage

String

Tidak

ACSCurrent

Label tahap yang menandai versi rahasia. Jika Anda menentukan parameter ini, KMS mengembalikan nilai rahasia dari versi yang ditandai dengan label tahap yang ditentukan.

Nilai default: ACSCurrent.

Catatan
  • Untuk rahasia Resource Access Management (RAM), rahasia basis data, dan rahasia Elastic Compute Service (ECS), KMS hanya mengembalikan nilai rahasia dari versi yang ditandai dengan ACSPrevious dan ACSCurrent. Rahasia basis data mencakup rahasia ApsaraDB RDS, rahasia PolarDB, dan rahasia ApsaraDB for Redis/Tair.

  • Jika Anda mengonfigurasi VersionStage dan VersionId, sistem akan memeriksa apakah nilai rahasia yang ditentukan oleh parameter tersebut ada. Jika nilai rahasia ada, nilai rahasia tersebut dikembalikan. Jika nilai rahasia tidak ada, kesalahan parameter dikembalikan.

VersionId

String

Tidak

00000000000000000000000000000001

ID versi. Jika Anda mengonfigurasi parameter ini, KMS mengembalikan nilai rahasia dari versi yang ditentukan.

Catatan
  • Rahasia RAM, rahasia basis data, dan rahasia ECS tidak mendukung parameter ini. Jika Anda mengonfigurasi parameter ini untuk rahasia RAM, rahasia basis data, dan rahasia ECS, konfigurasi diabaikan.

  • Jika Anda mengonfigurasi VersionStage dan VersionId, sistem memeriksa apakah nilai rahasia yang ditentukan oleh parameter tersebut ada. Jika nilai rahasia ada, nilai rahasia tersebut dikembalikan. Jika nilai rahasia tidak ada, kesalahan parameter dikembalikan.

FetchExtendedConfig

Boolean

Tidak

false

Menentukan apakah akan mendapatkan konfigurasi tambahan dari rahasia.

  • true (default): ya

  • false

Parameter respons

Parameter

Tipe

Contoh

Deskripsi

SecretName

String

secret001

Nama rahasia.

SecretType

String

Generic

Tipe rahasia. Nilai valid:

  • Generic: menunjukkan rahasia generik.

  • Rds: menunjukkan rahasia ApsaraDB RDS.

  • Redis: menunjukkan rahasia ApsaraDB Redis/Tair.

  • RAMCredentials: menunjukkan rahasia RAM.

  • ECS: menunjukkan rahasia ECS.

  • PolarDB: menunjukkan rahasia PolarDB.

SecretData

String

testdata1

Nilai rahasia. KMS mendekripsi ciphertext dari nilai rahasia dan mengembalikan plaintext dari nilai rahasia untuk parameter ini.

SecretDataType

String

binary

Tipe nilai rahasia. Nilai valid:

  • text

  • binary

VersionId

String

00000000000000000000000000000001

Nomor versi dari nilai rahasia.

VersionStages

List

[ "ACSCurrent" ]

Label tahap yang menandai versi rahasia.

CreateTime

String

2020-02-21T15:39:26Z

Waktu saat rahasia dibuat.

RequestId

String

6a3e9c36-1150-4881-84d3-eb8672fcafad

ID permintaan, yang digunakan untuk melokasi dan menyelesaikan masalah.

LastRotationDate

String

2020-07-05T08:22:03Z

Waktu saat rotasi terakhir dilakukan.

NextRotationDate

String

2020-07-06T18:22:03Z

Waktu saat rotasi berikutnya dilakukan.

ExtendedConfig

String

{\"SecretSubType\":\"SingleUser\",\"DBInstanceId\":\"rm-uf667446pc955****\",\"CustomData\":{}}

Konfigurasi tambahan dari rahasia.

AutomaticRotation

String

Enabled

Menunjukkan apakah rotasi otomatis diaktifkan. Nilai valid:

  • Enabled: menunjukkan bahwa rotasi otomatis diaktifkan.

  • Disabled: menunjukkan bahwa rotasi otomatis dinonaktifkan.

  • Invalid: menunjukkan bahwa status rotasi otomatis abnormal. Dalam hal ini, KMS tidak dapat secara otomatis merotasi rahasia.

RotationInterval

String

604800s

Interval untuk rotasi otomatis. Nilainya harus dalam format integer[unit].

  • integer: menunjukkan durasi waktu.

  • [unit]: menunjukkan satuan waktu. Nilai valid: s (detik).

Sebagai contoh, jika periode rotasi adalah 7 hari, parameter ini disetel ke 604800s.

Kode kesalahan

Kode status HTTP

Kode kesalahan

Pesan kesalahan

Deskripsi

404

Forbidden.ResourceNotFound

Sumber daya tidak ada dalam sistem.

Rahasia tidak ada.

409

Rejected.Disabled

Permintaan ditolak karena status kunci adalah Dinonaktifkan.

Kunci yang digunakan untuk mengenkripsi rahasia dinonaktifkan.

Untuk daftar kode kesalahan, lihat Kode Kesalahan Layanan.