Gunakan API GetSecretParametersByPath untuk mengambil parameter rahasia - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Mengambil parameter enkripsi berdasarkan path. 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:GetSecretParametersByPath

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
Path	string	Yes	Path parameter. Path harus kurang dari 200 karakter. Misalnya, jika parameter adalah /secretParameter/mySecretParameter, path parameter ini adalah /secretParameter.	/secretParameter
Recursive	boolean	No	Apakah akan mengkueri path secara rekursif. Misalnya, jika parameter /secretParameter/mySecretParameter dan /secretParameter/secretParameter1/mySecretParameter ada, nilai valid: true: /secretParameter/mySecretParameter dan /secretParameter/secretParameter1/mySecretParameter dikembalikan. false: Hanya /secretParameter/mySecretParameter yang dikembalikan.	false
NextToken	string	No	Token paginasi.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
MaxResults	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 10. Nilai default: 10.	10
WithDecryption	boolean	No	Apakah akan mendekripsi nilai parameter. Nilai valid: true false (default)	true

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	Token paginasi.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	ID permintaan.	25156E99-7437-4590-AA58-2ACA17DE405C
TotalCount	integer	Jumlah total parameter enkripsi yang dikembalikan.	10
MaxResults	integer	Jumlah entri per halaman.	10
Parameters	array<object>	Informasi parameter.
	object
Type	string	Tipe parameter.	Secret
UpdatedDate	string	Waktu ketika parameter terakhir diperbarui, dalam format ISO 8601 (UTC).	2020-10-21T06:22:48Z
UpdatedBy	string	Pengguna yang terakhir memperbarui parameter.	root(130900000)
KeyId	string	ID kunci.	090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex
Value	string	Nilai parameter.	secretParameter
Description	string	Deskripsi parameter.	secretParameter
Constraints	string	Batasan parameter.	{\"AllowedPattern\": \"^[a-g]*$\"}
CreatedBy	string	Pengguna yang membuat parameter.	root(130900000)
CreatedDate	string	Waktu ketika parameter dibuat, dalam format ISO 8601 (UTC).	2020-10-21T06:22:48Z
ParameterVersion	integer	Nomor versi parameter.	1
Name	string	Nama parameter.	mySecretParameter
Id	string	ID parameter.	p-7cdc0000000000000000
ShareType	string	Tipe berbagi parameter.	Private

Contoh

Respons sukses

JSONformat

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
  "TotalCount": 10,
  "MaxResults": 10,
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-21T06:22:48Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
      "Value": "secretParameter",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedPattern\\\": \\\"^[a-g]*$\\\"}",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-21T06:22:48Z",
      "ParameterVersion": 1,
      "Name": "mySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.