GetSecretValue - Key Management Service - Alibaba Cloud Documentation Center

Mendapatkan nilai sebuah secret.

Deskripsi operasi

Untuk informasi mengenai kebijakan akses yang diperlukan bagi pengguna atau role RAM untuk memanggil operasi API ini, lihat Resource Access Management.
Jika Anda tidak menentukan nomor versi atau stage, KMS akan mengembalikan nilai secret dari versi yang ditandai sebagai ACSCurrent.
Jika kunci yang ditentukan pengguna digunakan untuk melindungi nilai secret, pemanggil harus memiliki izin kms:Decrypt pada master key yang sesuai.

Topik ini memberikan contoh cara mendapatkan nilai secret bernama secret001. Respons menunjukkan bahwa nilai secret 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 atau Alibaba Cloud Resource Name (ARN) dari secret tersebut. Catatan Saat Anda mengakses secret di Akun Alibaba Cloud lain, Anda harus menentukan ARN dari secret tersebut. Format ARN secret adalah `acs:kms:${region}:${account}:secret/${secret-name}`.	secret001
VersionStage	string	No	Label stage yang menandai versi secret. Nilai default-nya adalah ACSCurrent. Jika Anda menentukan parameter ini, nilai secret dari versi dengan label stage yang ditentukan akan dikembalikan. Jika Anda tidak menentukan parameter ini, nilai secret dari versi yang ditandai dengan ACSCurrent akan dikembalikan. Catatan Untuk secret RDS, secret PolarDB, secret Redis/Tair, secret RAM, dan secret ECS, Anda hanya dapat memperoleh nilai secret dari versi yang ditandai dengan ACSPrevious dan ACSCurrent.	ACSCurrent
VersionId	string	No	Nomor versi. Catatan Anda tidak dapat menentukan parameter VersionId untuk secret RDS, secret PolarDB, secret Redis/Tair, secret RAM, atau secret ECS. Jika Anda mengatur parameter ini, pengaturan tersebut akan diabaikan.	v1
FetchExtendedConfig	boolean	No	Menentukan apakah akan mengambil konfigurasi tambahan dari secret tersebut. Nilai yang valid: true: mengambil konfigurasi tambahan. false (default): tidak mengambil konfigurasi tambahan. Catatan Secret generik tidak mendukung konfigurasi tambahan. Jika Anda mengatur parameter ini untuk secret generik, pengaturan tersebut akan diabaikan.	true
DryRun	string	No	Menentukan apakah akan mengaktifkan fitur dry run. true: mengaktifkan fitur dry run. false (default): menonaktifkan fitur dry run. Fitur dry run digunakan untuk menguji panggilan API. Fitur ini memverifikasi apakah Anda memiliki izin yang diperlukan pada sumber daya dan apakah parameter permintaan valid. Jika Anda mengaktifkan fitur dry run, KMS selalu mengembalikan respons kegagalan yang menunjukkan penyebab kegagalannya. Penyebab kegagalan berikut mungkin terjadi: DryRunOperationError: Permintaan akan berhasil jika parameter DryRun tidak ditentukan. ValidationError: Parameter yang ditentukan dalam permintaan tidak valid. AccessDeniedError: Anda tidak berwenang untuk melakukan operasi ini pada sumber daya KMS.	false

Untuk informasi selengkapnya mengenai parameter permintaan umum, lihat Common parameters.

Elemen respons

Element	Type	Description	Example
	object
SecretDataType	string	Tipe nilai secret. Nilai yang valid: text binary	binary
CreateTime	string	Waktu saat secret dibuat.	2024-02-21T15:39:26Z
VersionId	string	Nomor versi secret.	v1
NextRotationDate	string	Waktu rotasi secret berikutnya. Catatan Parameter ini hanya dikembalikan jika rotasi otomatis diaktifkan.	2024-07-06T18:22:03Z
SecretData	string	Nilai secret. Nilai ini didekripsi dari ciphertext oleh KMS dan dikembalikan. Untuk secret generik, nilai yang Anda tentukan akan dikembalikan. Untuk secret RDS atau secret Redis/Tair, nilainya dalam format berikut: `{"AccountName":"","AccountPassword":""}`. Untuk secret RAM, nilainya dalam format berikut: `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`. Untuk secret ECS, nilainya dalam salah satu format berikut: Untuk kredensial berbasis password: `{"UserName":"ecs-user","Password":"H5asdasdsads**"}` . Untuk kredensial berbasis pasangan kunci (kunci privat dalam format PEM): `{"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}` . Untuk secret PolarDB, nilainya dalam format berikut: `{"AccountName":"","AccountPassword":""}` .	testdata1
RotationInterval	string	Interval rotasi otomatis. Nilainya dalam format `integer[unit]`. `integer` menunjukkan panjang waktu. `unit` menunjukkan satuan waktu. `unit` dapat berupa s (detik). Misalnya, periode rotasi 7 hari adalah 604800s. Catatan Parameter ini hanya dikembalikan jika rotasi otomatis diaktifkan.	604800s
ExtendedConfig	string	Konfigurasi tambahan dari secret tersebut. Catatan Parameter ini hanya dikembalikan untuk secret RDS, secret PolarDB, secret Redis/Tair, secret RAM, atau secret ECS ketika FetchExtendedConfig diatur ke true.	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	Waktu terakhir secret dirotasi. Catatan Parameter ini hanya dikembalikan jika secret pernah dirotasi.	2023-07-05T08:22:03Z
RequestId	string	ID permintaan, yaitu pengenal unik yang dihasilkan oleh Alibaba Cloud. Anda dapat menggunakan ID ini untuk memecahkan masalah.	6a3e9c36-1150-4881-84d3-eb8672fcafad
SecretName	string	Nama secret tersebut.	secret001
AutomaticRotation	string	Menunjukkan apakah rotasi otomatis diaktifkan. Nilai yang valid: Enabled: Rotasi otomatis diaktifkan. Disabled: Rotasi otomatis tidak diaktifkan. Invalid: Status rotasi tidak normal, dan KMS tidak dapat secara otomatis merotasi secret tersebut. Catatan Parameter ini hanya dikembalikan untuk secret RDS, secret PolarDB, secret Redis/Tair, secret RAM, atau secret ECS.	Enabled
SecretType	string	Tipe secret tersebut. Nilai yang valid: Generic: secret generik. Rds: secret RDS. Redis: secret Redis/Tair. RAMCredentials: secret RAM. ECS: secret ECS. PolarDB: secret PolarDB.	Generic
VersionStages	array	Label stage yang menandai versi secret tersebut.
	string	Label stage yang menandai versi secret tersebut.	{ "VersionStage": [ "ACSCurrent" ] }

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\": [ \t\"ACSCurrent\" \t] }"
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Forbidden.DKMSInstanceStateInvalid	The DKMS instance state is invalid.	Your dedicated KMS instance is invalid.
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.	Your dedicated KMS instance is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.	The error message returned because the specified CMK does not exist.
404	Forbidden.ResourceNotFound	Resource not found.	The resource is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.