取得組態套件
擷取組態套件以檢查其中繼資料或讀取特定版本的完整組態內容。有兩個可用的操作:
-
GetConfigurationBundle — 傳回套件的最新版本。如果指定
branchName, 會傳回該分支的最新版本。如果省略, 會傳回所有分支的最新版本。使用此項目可讀取目前的作用中組態。 -
GetConfigurationBundleVersion — 依版本 ID 傳回特定歷史版本。使用此項目來檢查過去的組態或比較版本。
套件中繼資料與版本內容
GetConfigurationBundle 會同時傳回套件層級中繼資料 (名稱、描述、ARN) 和完整版本內容 (具有其組態金鑰/值對的元件)。如果您只需要知道哪些版本存在,而不擷取其完整內容,請ListConfigurationBundleVersions改用 。
GetConfigurationBundleVersion 會傳回相同的欄位加上 versionCreatedAt,告訴您確切建立該特定版本的時間 (而不是 createdAt,也就是第一次建立套件本身的時間)。
程式碼範例
範例
請求參數
GetConfigurationBundle
| 參數 | Type | 必要 | 描述 |
|---|---|---|---|
|
|
String |
是 |
組態套件的 ID。以路徑參數傳遞。 |
|
|
String |
否 |
要從中取得最新版本的分支名稱。如果省略, 會傳回所有分支的最新版本。 |
GetConfigurationBundleVersion
| 參數 | Type | 必要 | 描述 |
|---|---|---|---|
|
|
String |
是 |
組態套件的 ID。以路徑參數傳遞。 |
|
|
String |
是 |
要擷取之特定版本的 UUID。以路徑參數傳遞。 |
回應
這兩個操作都會傳回相同的欄位。 GetConfigurationBundleVersion也會傳回 versionCreatedAt。
| 欄位 | Type | Description |
|---|---|---|
|
|
String |
組態套件的 ARN。 |
|
|
String |
組態套件的 ID。 |
|
|
String |
套件的名稱。 |
|
|
String |
套件的描述 (如果設定)。 |
|
|
String |
傳回的 版本的 UUID。 |
|
|
Map |
元件識別符與元件組態的映射。每個值都包含一個 |
|
|
物件 |
版本歷程中繼資料,包括 |
|
|
時間戳記 |
原始建立套件的時間。 |
|
|
時間戳記 |
套件上次更新的時間 (僅限 GetConfigurationBundle)。 |
|
|
時間戳記 |
建立此特定版本時 (僅限 GetConfigurationBundleVersion)。 |
錯誤
| 錯誤 | HTTP 狀態 | 說明 |
|---|---|---|
|
|
400 |
無效的請求參數。 |
|
|
404 |
指定的 |
|
|
403 |
許可不足。驗證 IAM 政策包含 |
|
|
429 |
超過請求率。以指數退避重試。 |
|
|
500 |
服務端錯誤。重試 請求。 |