Membuat secret dan menyimpan versi awalnya.
Deskripsi operasi
-
Untuk informasi mengenai kebijakan akses yang diperlukan agar Pengguna Resource Access Management (RAM) atau Peran RAM dapat memanggil operasi ini, lihat Resource Access Management.
-
Tentukan nama secret, nilai secret untuk versi awal, dan nomor versi. Versi awal ditandai dengan label tahap ACSCurrent.
-
Key Management Service (KMS) menggunakan kunci yang Anda tentukan untuk mengenkripsi nilai secret. Kunci dan secret harus berada dalam instans KMS yang sama, serta kunci tersebut harus berupa kunci simetris.
CatatanKMS mengenkripsi nilai secret setiap versi. Metadata seperti nama secret, nomor versi, dan label tahap versi tidak dienkripsi.
-
Sebelum mengenkripsi nilai secret, Anda harus memiliki izin
kms:GenerateDataKeypada kunci tersebut.
Topik ini memberikan contoh cara membuat secret RDS. Secret tersebut diberi nama mydbconninfo. VersionId dari versi awal adalah v1. SecretData adalah {"Accounts":[{"AccountName":"user1","AccountPassword":"****"}]}.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| SecretName |
string |
Yes |
Nama secret. Nama tersebut harus unik dalam wilayah yang sama. Nama dapat terdiri hingga 192 karakter dan boleh mengandung huruf, angka, garis bawah (_), garis miring (/), tanda plus (+), tanda sama dengan (=), titik (.), tanda hubung (-), dan tanda at (@). Batasan berikut berlaku untuk nama secret jenis tertentu:
|
mydbconninfo |
| VersionId |
string |
Yes |
Nomor versi dari versi awal. Nomor versi harus unik dalam satu secret. Nomor versi dapat terdiri hingga 64 karakter. |
v1 |
| EncryptionKeyId |
string |
No |
ID kunci yang digunakan untuk mengenkripsi nilai secret. Catatan
Kunci dan secret harus berada dalam instans KMS yang sama. Kunci tersebut harus berupa kunci simetris. |
key-gzz63ff0db5hg3qje**** |
| SecretData |
string |
Yes |
Nilai secret. Nilai tersebut dapat terdiri hingga 30.720 byte (30 KB). KMS mengenkripsi nilai secret dengan kunci yang ditentukan dan menyimpan nilai terenkripsi tersebut dalam versi awal.
|
{"Accounts":[{"AccountName":"user1","AccountPassword":"****"}]} |
| SecretDataType |
string |
No |
Jenis nilai secret. Nilai yang valid:
Catatan
Jika SecretType diatur ke Rds, Redis, PolarDB, RAMCredentials, atau ECS, SecretDataType harus diatur ke text. |
text |
| Description |
string |
No |
Deskripsi secret. |
mydbinfo |
| Tags |
string |
No |
Tag secret. Setiap tag terdiri dari pasangan kunci-nilai. Tag terdiri dari kunci tag dan nilai tag. Kunci tag dan nilai tag dapat terdiri hingga 128 karakter dan boleh mengandung huruf, angka, garis miring (/), garis miring terbalik (\), garis bawah (_), tanda hubung (-), titik (.), tanda plus (+), tanda sama dengan (=), titik dua (:), dan tanda at (@).
|
[{\"TagKey\":\"key1\",\"TagValue\":\"val1\"},{\"TagKey\":\"key2\",\"TagValue\":\"val2\"}] |
| SecretType |
string |
No |
Jenis secret. Nilai yang valid:
|
Rds |
| ExtendedConfig |
object |
No |
Konfigurasi tambahan secret. Parameter ini menentukan properti secret jenis tertentu. Nilainya dapat terdiri hingga 1.024 karakter.
Catatan
Jika SecretType diatur ke Rds, Redis, PolarDB, RAMCredentials, atau ECS, Anda harus mengonfigurasi parameter ini. |
{"SecretSubType":"SingleUser", "DBInstanceId":"rm-bp1b3dd3a506e****" ,"CustomData":{"Key1": "v1", "fds":"fdsf"}} |
| EnableAutomaticRotation |
boolean |
No |
Menentukan apakah rotasi otomatis diaktifkan. Nilai yang valid:
Catatan
Parameter ini hanya berlaku jika SecretType diatur ke Rds, PolarDB, Redis, RAMCredentials, atau ECS. Jika SecretType diatur ke Generic, rotasi otomatis tidak didukung. Anda dapat memanggil operasi PutSecretValue untuk memutar secret secara manual. |
true |
| RotationInterval |
string |
No |
Interval untuk rotasi otomatis. Nilainya berada dalam rentang 6 jam hingga 8.760 jam (365 hari). Catatan
Anda harus menentukan parameter ini jika mengatur EnableAutomaticRotation ke true. Anda tidak perlu menentukan parameter ini jika mengatur EnableAutomaticRotation ke false. |
30d |
| DKMSInstanceId |
string |
No |
ID instans KMS. |
kst-bjj62d8f5e0sgtx8h**** |
| Policy |
string |
No |
Konten kebijakan secret. Nilainya dalam format JSON. Nilainya dapat terdiri hingga 32.768 byte. Untuk informasi selengkapnya mengenai kebijakan secret, lihat Ikhtisar kebijakan secret. Jika Anda tidak menentukan parameter ini, kebijakan secret default akan digunakan. Kebijakan secret terdiri dari bagian-bagian berikut:
Berikut adalah format kebijakan secret:
Detail mengenai pernyataan:
Catatan
Setelah Anda memberikan izin kepada Pengguna RAM atau Peran RAM dari Akun Alibaba Cloud lain, Anda harus menggunakan Akun Alibaba Cloud tempat Pengguna RAM atau Peran RAM tersebut berada untuk memberikan izin kepada Pengguna RAM atau Peran RAM tersebut agar dapat menggunakan secret di Konsol RAM. Baru setelah itu, Pengguna RAM atau Peran RAM tersebut dapat menggunakan secret tersebut. Untuk informasi selengkapnya, lihat Kebijakan kustom untuk KMS, Memberikan izin kepada Pengguna RAM, dan Memberikan izin kepada Peran RAM. |
{"Version":"1","Statement": [{"Sid":"kms default secret policy","Effect":"Allow","Principal":{"RAM": ["acs:ram::119285303511****:*"]},"Action":["kms:*"],"Resource": ["*"] }] } |
Untuk informasi mengenai parameter permintaan umum, lihat Parameter umum.
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
ID permintaan, yaitu pengenal unik yang dihasilkan oleh Alibaba Cloud. Anda dapat menggunakan ID ini untuk memecahkan masalah. |
3bf02f7a-015b-4f93-be0f-cc043fda2dd3 |
| AutomaticRotation |
string |
Menunjukkan apakah rotasi otomatis diaktifkan. Nilai yang valid:
Catatan
Parameter ini dikembalikan jika SecretType diatur ke Rds, Redis, PolarDB, RAMCredentials, atau ECS. |
Enabled |
| SecretName |
string |
Nama secret. |
mydbconninfo |
| VersionId |
string |
Nomor versi secret. |
v1 |
| NextRotationDate |
string |
Waktu rotasi secret berikutnya. Catatan
Parameter ini dikembalikan jika rotasi otomatis diaktifkan. |
2023-07-06T18:22:03Z |
| SecretType |
string |
Jenis secret. Nilai yang valid:
|
Rds |
| RotationInterval |
string |
Interval untuk rotasi otomatis. Catatan
Parameter ini dikembalikan jika rotasi otomatis diaktifkan. |
604800s |
| Arn |
string |
Nama Sumber Daya Alibaba Cloud (ARN) dari secret tersebut. |
acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo |
| ExtendedConfig |
string |
Konfigurasi tambahan secret. Catatan
Parameter ini dikembalikan jika SecretType diatur ke Rds, Redis, PolarDB, RAMCredentials, atau ECS. |
{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":"Key1": "v1", "fds":"fdsf"} } |
| DKMSInstanceId |
string |
ID instans KMS. |
kst-bjj62d8f5e0sgtx8h**** |
Contoh
Respons sukses
JSONformat
{
"RequestId": "3bf02f7a-015b-4f93-be0f-cc043fda2dd3",
"AutomaticRotation": "Enabled",
"SecretName": "mydbconninfo",
"VersionId": "v1",
"NextRotationDate": "2023-07-06T18:22:03Z",
"SecretType": "Rds",
"RotationInterval": "604800s",
"Arn": "acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo",
"ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\", \\\"CustomData\\\":\"Key1\": \"v1\", \"fds\":\"fdsf\"} }",
"DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | UnsupportedOperation | This action is not supported. | The operation is not supported. |
| 400 | Rejected.LimitExceeded | The request was rejected because user create resource limit was exceeded | The request is rejected because the number of created resources reaches the upper limit. |
| 400 | InvalidParameter | The specified parameter is not valid. | An invalid value is specified for the parameter. |
| 400 | Rejected.ShareQuotaExceedLimit | Instance Share Quota Exceed Limit. | The instance share quota exceeds the limit. |
| 500 | InternalFailure | Internal Failure | An internal error occurred. |
| 403 | Forbidden.DKMSInstanceNotFound | The specified DKMS Instance is not found. | Your dedicated KMS instance is not found. |
| 404 | Forbidden.ResourceNotFound | The resource is not found. | The resource does not exist. |
| 409 | Rejected.ResourceExist | The resource already exists. | The resource already exists. |
| 409 | Rejected.ResourceInDeleteWindow | The secret is planned to be deleted. | The secret is to be deleted. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.