Gunakan GetSecretParameter untuk kueri parameter terenkripsi - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Mengambil parameter terenkripsi, termasuk nilainya. Pastikan Anda memiliki izin untuk memanggil operasi API KMS GetSecretValue sebelum memanggil operasi ini.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

oos:GetSecretParameter

get

*secretparameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

oos:TLSVersion

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-hangzhou
Name	string	Yes	Nama parameter. Nama dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_). Panjang nama dapat mencapai 180 karakter dan tidak boleh diawali dengan ALIYUN, ACS, ALIBABA, ALICLOUD, atau OOS.	MySecretParameter
ParameterVersion	integer	No	Nomor versi parameter. Nilai valid: 1 hingga 100.	1
WithDecryption	boolean	No	Apakah akan mendekripsi nilai parameter. Bidang value dalam tanggapan hanya diisi jika parameter ini diatur ke true. Jika tidak, bidang value akan kosong.	false

Elemen respons

Element	Type	Description	Example
	object	Informasi tentang parameter terenkripsi.
RequestId	string	ID permintaan.	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameter	object	Informasi parameter terenkripsi.
Type	string	Tipe parameter.	Secret
UpdatedDate	string	Pengatur waktu ketika parameter terakhir diperbarui.	2020-09-01T09:35:17Z
UpdatedBy	string	Pengguna yang terakhir memperbarui parameter.	root(130900000)
KeyId	string	ID kunci KMS yang digunakan untuk enkripsi.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	Tag.	{"k1": "v1", "k2": "v2"}
Value	string	Nilai parameter.	SecretParameter
Description	string	Deskripsi parameter.	SecretParameter
Constraints	string	Batasan parameter.	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmxsn4m4******
CreatedBy	string	Pengguna yang membuat parameter.	root(130900000)
CreatedDate	string	Pengatur waktu ketika parameter dibuat.	2020-09-01T09:28:47Z
ParameterVersion	integer	Nomor versi parameter.	1
Name	string	Nama parameter terenkripsi.	MySecretParameter
Id	string	ID parameter terenkripsi.	p-14ed150fdcd048xxxxxx
ShareType	string	Tipe berbagi parameter.	Private
DKMSInstanceId	string	ID instans dari instans KMS.	kst-hzz****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:35:17Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "SecretParameter",
    "Description": "SecretParameter",
    "Constraints": "'{''AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\".*\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:28:47Z",
    "ParameterVersion": 1,
    "Name": "MySecretParameter",
    "Id": "p-14ed150fdcd048xxxxxx",
    "ShareType": "Private",
    "DKMSInstanceId": "kst-hzz****"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.