列出所有套件
GET /accounts/{account_id}/core/v1/packages
傳回集合中所有符合資源的 JSON 陣列。如果在請求中指定了個別欄位,則項目 JSON 陣列將按指定順序包含每個相符資源所請求的欄位。
參數
| Name | 類型 | 在 | 必要 | 說明 |
|---|---|---|---|---|
account_id |
字串 |
路徑 |
True |
包含帳戶資源的 ID
|
篩選器 |
字串 |
查詢 |
錯誤 |
指示在列出集合時,為了傳回資源而應符合哪些欄位。 支援的運算子包括:
URL 範例:「filter=field%20eq%20%27value%27」 OpenAPI 範例:"field eq 'value'" |
訂單者 |
字串 |
查詢 |
錯誤 |
指示列出集合時資源的排序順序。 URL 範例:「orderBy=name」、「orderBy=name%20desc」 OpenAPI 範例:"name desc" |
包括 |
字串 |
查詢 |
錯誤 |
指示列出集合時應傳回哪些欄位。 URL 範例:「include=id」、「include=id,name」 OpenAPI 範例:"id"
|
限制 |
字串 |
查詢 |
錯誤 |
表示列出集合時要傳回的資源數量上限。 URL 範例:「limit=2」 OpenAPI 範例:「2」 |
回應
Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
項目 |
array[任何一個: "package_1.0_get_response_body"、array[]] |
True |
|
中繼資料 |
True |
範例回應
{
"type": "application/astra-packages",
"version": "1.0",
"items": [
[
"e280ff62-be35-4f31-a31b-a210a1ad1b33",
"acc",
"22.01.0",
"install"
],
[
"e8507dad-d33f-44b3-9c15-ec55ba6f6473",
"acc",
"22.01.1",
"patch"
]
],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
回應
Status: 401, Unauthorized
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例回應
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
回應
Status: 400, Bad request
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
|
invalidParams |
陣列["invalidParams"] |
錯誤 |
無效查詢參數清單 |
範例回應
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
回應
Status: 403, Forbidden
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例回應
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
錯誤
Status: 404, Not found
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例錯誤回應
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
定義
請參閱定義
type_astra_stateTransition
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
從 |
字串 |
True |
|
到 |
陣列[string] |
True |
additionalDetails
type_astra_stateDetail
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
additionalDetails |
錯誤 |
dependsOnImages
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
imagePath |
字串 |
True |
包含此 Docker 映像路徑的 JSON 字串。它不能包含登錄名稱,只能包含從根目錄到映像的絕對路徑。範例:/globalcicd/acc 已定義的值包括:
|
imageName |
字串 |
True |
包含 Docker 映像名稱的 JSON 字串。已定義的值包括:
|
imageTag |
字串 |
True |
代表此映像標籤 / 版本的 JSON 字串。定義的值為:
|
映像
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
imageName |
字串 |
True |
包含 Docker 映像名稱的 JSON 字串。已定義的值包括:
|
imagePath |
字串 |
True |
包含此 Docker 映像路徑的 JSON 字串。它不能包含登錄名稱,只能包含從根目錄到映像的絕對路徑。範例:/globalcicd/acc 已定義的值包括:
|
imageTag |
字串 |
True |
代表此映像標籤 / 版本的 JSON 字串。定義的值為:
|
imageDigest |
字串 |
True |
代表此映像摘要的 JSON 字串。定義的值為:
|
dependsOnImages |
錯誤 |
描述安裝或升級目前映像所需映像的 JSON 物件 JSON 陣列。 |
dependsOnComponents
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
componentName |
字串 |
True |
描述元件名稱的 JSON 字串。定義的值為:
|
版本 |
陣列[string] |
True |
定義安裝目前映像所需元件版本的 JSON 字串 JSON 陣列。 |
成品
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
artifactName |
字串 |
True |
包含檔案名稱的 JSON 字串。定義的值為:
|
artifactIdentifier |
字串 |
True |
包含此檔案識別碼的 JSON 字串。在同一套件類型的不同版本之間,檔案名稱可能會變更,但識別碼通常保持不變。已定義的值包括:
|
artifactPath |
字串 |
True |
JSON 字串,包含從已知 Astra Control Center 資料儲存區/位置的根目錄到此成品的路徑。範例:/vmware/1.0/ 定義的值為:
|
artifactVersion |
字串 |
錯誤 |
JSON 字串,包含該成品的版本(如果有提供)。定義的值為:
|
dependsOnComponents |
錯誤 |
描述安裝 / 升級目前映像所需的已安裝元件的 JSON 物件 JSON 陣列。 |
檔案
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
fileName |
字串 |
True |
包含檔案名稱的 JSON 字串。定義的值為:
|
fileIdentifier |
字串 |
True |
包含此檔案識別碼的 JSON 字串。在同一套件類型的不同版本之間,檔案名稱可能會變更,但識別碼通常保持不變。已定義的值包括:
|
fileMediaType |
字串 |
True |
包含檔案媒體類型的 JSON 字串。定義的值可以是任何已定義的媒體類型 "IANA"。此外,也支援 application/x-yaml 或 application/x-yaml(用於 yaml 檔案)。
|
fileContents |
字串 |
True |
包含檔案內容的 JSON 字串。已定義的值包括:
|
upgradableVersions
JSON 物件,包含可升級至套件版本的最低和最高版本。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
minVersion |
字串 |
錯誤 |
描述可升級到套件版本的最低版本的 JSON 字串。定義的值為:
|
maxVersion |
字串 |
錯誤 |
描述可升級到套件版本的最高版本的 JSON 字串。已定義的值包括:
|
相依性
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
componentName |
字串 |
True |
描述元件名稱的 JSON 字串。定義的值為:
|
componentMinVersion |
字串 |
錯誤 |
描述該元件所需最低版本的 JSON 字串。已定義的值包括:
|
componentMaxVersion |
字串 |
錯誤 |
描述該元件所需最高版本的 JSON 字串。已定義的值包括:
|
type_astra_label
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
|
值 |
字串 |
True |
type_astra_metadata
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
-
符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
標籤 |
True |
||
建立時間戳記 |
字串 |
True |
|
修改時間戳記 |
字串 |
True |
|
建立者 |
字串 |
True |
|
modifiedBy |
字串 |
錯誤 |
package_1.0_get_response_body
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
資源的媒體類型。定義的值為:
|
版本 |
字串 |
True |
資源版本。已定義值包括:
|
ID |
字串 |
True |
資源的全域唯一識別碼。定義的值為:
|
packageName |
字串 |
True |
包含套件名稱的 JSON 字串。已定義的值包括:
|
packageVersion |
字串 |
True |
包含套件 SemVer 的 JSON 字串。已定義的值包括:
|
packageType |
字串 |
True |
包含套件類型的 JSON 字串,指示這是完整安裝套件還是修補程式。已定義的值包括:
|
bundleName |
陣列[string] |
錯誤 |
包含套件所在套裝組合名稱的 JSON 字串 JSON 陣列。 |
severityLevel |
字串 |
True |
描述此修補程式或安裝嚴重性層級的 JSON 字串。定義的值為:
|
packageState |
字串 |
True |
JSON 字串,包含指示套件運作狀態的值。套件驗證並匯入後,狀態將顯示為「complete」。否則,狀態將顯示為「incomplete」。定義的值為:
|
packageStateTransitions |
True |
JSON 物件的 JSON 陣列,每個物件代表從給定已定義狀態允許的狀態轉換集。每個 JSON 物件包含「from」和「to」欄位,其中「from」值是狀態名稱,「to」值是允許的目標狀態陣列。已定義的值為:
|
|
packageStateDetails |
True |
JSON 物件的 JSON 陣列,其中列出有關目前「狀態」的其他詳細資料。如果沒有可用的詳細資料,此陣列將為空白。
|
|
映像 |
陣列["映像"] |
錯誤 |
JSON 陣列,包含 JSON 物件,每個物件都包含一個屬於該套件的 Docker 映像。 |
成品 |
陣列["成品"] |
錯誤 |
描述與此套件相關的其他成品(二進位檔案和其他檔案)的 JSON 物件 JSON 陣列。 |
檔案 |
陣列["檔案"] |
錯誤 |
JSON 陣列,包含 JSON 物件,每個物件代表與此套件相關聯的非映像成品。 |
upgradableVersions |
錯誤 |
JSON 物件,包含可升級至套件版本的最低和最高版本。 |
|
相依性 |
陣列["相依性"] |
錯誤 |
JSON 物件的 JSON 陣列,描述安裝此套件所需的指定相依性最低版本 |
中繼資料 |
True |
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
|
type_astra_metadata_list
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
繼續 |
字串 |
錯誤 |
|
數 |
數字 |
錯誤 |
|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
invalidParams
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效查詢參數的名稱 |
原因 |
字串 |
True |
查詢參數無效的原因 |