GetSecretValue - Key Management Service - Alibaba Cloud Documentation Center

Mengambil nilai rahasia.

Deskripsi operasi

Untuk detail kebijakan akses yang diperlukan pengguna Resource Access Management (RAM) atau peran RAM untuk memanggil operasi ini, lihat Kontrol akses.
Jika Anda tidak menentukan nomor versi atau tahap versi, KMS akan mengembalikan nilai kredensial dari versi yang ditandai sebagai ACSCurrent secara default.
Jika kredensial menggunakan master key kustom untuk melindungi nilai kredensial, pemanggil juga harus memiliki izin kms:Decrypt pada master key yang sesuai.

Topik ini menyediakan contoh cara mengambil nilai kredensial dari kredensial bernama secret001. Tanggapan menunjukkan bahwa nilai kredensial SecretData adalah testdata1.

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
SecretName	string	Yes	Nama rahasia atau Nama Sumber Daya Alibaba Cloud (ARN) rahasia. Catatan Untuk mengakses rahasia di akun Alibaba Cloud lain, Anda harus menentukan ARN rahasia. Format ARN rahasia adalah `acs:kms:${region}:${account}:secret/${secret-name}`.	secret001
VersionStage	string	No	Tahap versi. Nilai default: ACSCurrent. Jika Anda menentukan parameter ini, nilai rahasia dari tahap versi yang ditentukan akan dikembalikan. Jika Anda tidak menentukan parameter ini, nilai rahasia dari tahap versi ACSCurrent akan dikembalikan. Catatan Untuk rahasia ApsaraDB RDS, rahasia PolarDB, rahasia Redis/Tair, rahasia RAM, dan rahasia ECS, Anda hanya dapat mengambil nilai rahasia dari versi ACSPrevious dan ACSCurrent.	ACSCurrent
VersionId	string	No	Nomor versi. Catatan Rahasia ApsaraDB RDS, rahasia PolarDB, rahasia Redis/Tair, rahasia RAM, dan rahasia ECS tidak mendukung penentuan VersionId. Parameter ini akan diabaikan jika ditentukan.	v1
FetchExtendedConfig	boolean	No	Apakah akan mengambil konfigurasi tambahan rahasia. Nilai valid: true: Mengambil konfigurasi tambahan. false (default): Tidak mengambil konfigurasi tambahan. Catatan Rahasia generik tidak mendukung konfigurasi tambahan. Parameter ini akan diabaikan jika ditentukan.	true
DryRun	string	No	Apakah akan mengaktifkan mode DryRun. Nilai valid: true: Mengaktifkan mode DryRun. false (default): Menonaktifkan mode DryRun. Mode DryRun digunakan untuk menguji panggilan API dan memverifikasi apakah Anda memiliki izin yang diperlukan pada resource yang sesuai dan apakah parameter permintaan telah dikonfigurasi dengan benar. Saat mode DryRun diaktifkan, KMS selalu mengembalikan kegagalan dan memberikan alasan kegagalan. Alasan kegagalan meliputi: DryRunOperationError: Permintaan akan berhasil jika parameter DryRun tidak ditentukan. ValidationError: Parameter yang ditentukan di permintaan tidak valid. AccessDeniedError: Anda tidak diizinkan untuk melakukan operasi ini pada resource KMS.	false

Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element	Type	Description	Example
	object
SecretDataType	string	Tipe nilai rahasia. Nilai valid: text binary	binary
CreateTime	string	Waktu saat rahasia dibuat.	2024-02-21T15:39:26Z
VersionId	string	Nomor versi rahasia.	v1
NextRotationDate	string	Waktu rotasi berikutnya. Catatan Parameter ini hanya dikembalikan saat rotasi otomatis diaktifkan.	2024-07-06T18:22:03Z
SecretData	string	Nilai rahasia. KMS mendekripsi nilai rahasia ciphertext yang disimpan dan mengembalikan parameter ini. Untuk rahasia generik, nilai rahasia yang Anda tentukan akan dikembalikan. Untuk rahasia ApsaraDB RDS dan rahasia Redis/Tair, nilai rahasia dikembalikan dalam format berikut: `{"AccountName":"","AccountPassword":""}`. Untuk rahasia RAM, nilai rahasia dikembalikan dalam format berikut: `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`. Untuk rahasia ECS, nilai rahasia dikembalikan dalam format berikut: Rahasia tipe kata sandi: `{"UserName":"ecs-user","Password":"H5asdasdsads**"}`. Rahasia tipe pasangan kunci publik-privat (kunci privat dalam format PEM): `{"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}`. Untuk rahasia PolarDB, nilai rahasia dikembalikan dalam format berikut: `{"AccountName":"","AccountPassword":""}`.	testdata1
RotationInterval	string	Interval untuk rotasi otomatis rahasia. Formatnya adalah `integer[unit]`, di mana `integer` menentukan panjang waktu dan `unit` menentukan unit waktu. Nilai `unit` adalah s (detik). Misalnya, interval rotasi 7 hari adalah 604800s. Catatan Parameter ini hanya dikembalikan saat rotasi otomatis diaktifkan.	604800s
ExtendedConfig	string	Konfigurasi tambahan rahasia. Catatan Parameter ini hanya dikembalikan untuk rahasia ApsaraDB RDS, rahasia PolarDB, rahasia Redis/Tair, rahasia RAM, atau rahasia ECS saat FetchExtendedConfig diatur ke true.	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	Waktu rotasi terbaru. Catatan Parameter ini hanya dikembalikan saat rahasia telah dirotasi.	2023-07-05T08:22:03Z
RequestId	string	ID permintaan. Ini adalah pengidentifikasi unik yang dihasilkan oleh Alibaba Cloud untuk permintaan dan dapat digunakan untuk pemecahan masalah.	6a3e9c36-1150-4881-84d3-eb8672fcafad
SecretName	string	Nama rahasia.	secret001
AutomaticRotation	string	Apakah rotasi otomatis diaktifkan. Nilai valid: Enabled: Rotasi otomatis diaktifkan. Disabled: Rotasi otomatis dinonaktifkan. Invalid: Status rotasi tidak normal. KMS tidak dapat merotasi rahasia secara otomatis. Catatan Parameter ini hanya dikembalikan untuk rahasia ApsaraDB RDS, rahasia PolarDB, rahasia Redis/Tair, rahasia RAM, atau rahasia ECS.	Enabled
SecretType	string	Tipe rahasia. Nilai valid: Generic: rahasia generik. Rds: rahasia ApsaraDB RDS. Redis: rahasia Redis/Tair. RAMCredentials: rahasia RAM. ECS: rahasia ECS. PolarDB: rahasia PolarDB.	Generic
VersionStages	object	The stage labels that mark the secret version.
VersionStage	array	Label tahap versi rahasia.
	string	Label tahap versi rahasia.	{ "VersionStage": [ "ACSCurrent" ] }
CiphertextForRecipient	string		*CipherForRecipient*

Contoh

Respons sukses

JSONformat

{
  "SecretDataType": "binary",
  "CreateTime": "2024-02-21T15:39:26Z",
  "VersionId": "v1",
  "NextRotationDate": "2024-07-06T18:22:03Z",
  "SecretData": "testdata1",
  "RotationInterval": "604800s",
  "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate": "2023-07-05T08:22:03Z",
  "RequestId": "6a3e9c36-1150-4881-84d3-eb8672fcafad",
  "SecretName": "secret001",
  "AutomaticRotation": "Enabled",
  "SecretType": "Generic",
  "VersionStages": {
    "VersionStage": [
      "{ \"VersionStage\": [ \t\"ACSCurrent\" \t] }"
    ]
  },
  "CiphertextForRecipient": "***CipherForRecipient***"
}

Kode kesalahan

HTTP status code	Error code	Error message
403	Forbidden.DKMSInstanceStateInvalid	The DKMS instance state is invalid.
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.
404	Forbidden.ResourceNotFound	Resource not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.