すべてのパッケージを一覧表示
GET /accounts/{account_id}/core/v1/packages
コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
フィルタ |
string |
query |
False |
コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。 サポートされているオペレータは次のとおりです:
URLの例:"filter=field%20eq%20%27value%27" OpenAPI の例:「field eq 'value'」 |
OrderBy |
string |
query |
False |
コレクションを一覧表示する際の、リソースの並び順を示します。 URLの例:"orderBy=name"、"orderBy=name%20desc" OpenAPI の例:"name desc" |
含める |
string |
query |
False |
コレクションを一覧表示する際に、どのフィールドを返すかを指定します。 URLの例:"include=id"、"include=id,name" OpenAPI の例:"id"
|
制限( Limit ) |
string |
query |
False |
コレクションを一覧表示する際に返されるリソースの最大数を示します。 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 | を入力します | 必須 | 説明 |
|---|---|---|---|
項目 |
配列[いずれか:"package_1.0_get_response_body"、配列[]] |
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"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 | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
|
invalidParams |
配列["invalidParams"] |
False |
無効なクエリパラメータのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
応答
Status: 403, Forbidden
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"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 | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
エラー応答の例
{
"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 | を入力します | 必須 | 説明 |
|---|---|---|---|
- |
string |
True |
|
- |
array[string] |
True |
additionalDetails
type_astra_stateDetail
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
additionalDetails |
False |
dependsOnImages
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
imagePath |
string |
True |
このDockerイメージへのパスを含むJSON文字列。レジストリ名を含めてはならず、ルートからイメージへの絶対パスのみを含める必要があります。例:/globalcicd/acc 定義値:
|
imageName |
string |
True |
Docker イメージ名を含む JSON 文字列。定義値は次のとおりです:
|
imageTag |
string |
True |
この画像のタグ/バージョンを表すJSON文字列。定義値は次のとおりです:
|
画像
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
imageName |
string |
True |
Docker イメージ名を含む JSON 文字列。定義値は次のとおりです:
|
imagePath |
string |
True |
このDockerイメージへのパスを含むJSON文字列。レジストリ名を含めてはならず、ルートからイメージへの絶対パスのみを含める必要があります。例:/globalcicd/acc 定義値:
|
imageTag |
string |
True |
この画像のタグ/バージョンを表すJSON文字列。定義値は次のとおりです:
|
imageDigest |
string |
True |
この画像のダイジェストを表すJSON文字列。定義値は次のとおりです:
|
dependsOnImages |
False |
現在のイメージをインストールまたはアップグレードするために必要なイメージを記述するJSONオブジェクトのJSON配列。 |
dependsOnComponents
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
componentName |
string |
True |
コンポーネント名を表すJSON文字列。定義値は次のとおりです:
|
バージョン |
array[string] |
True |
現在のイメージをインストールするために必要なコンポーネントのバージョンを定義するJSON文字列のJSON配列。 |
アーティファクト
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
artifactName |
string |
True |
ファイル名を含むJSON文字列。定義されている値は次のとおりです:
|
artifactIdentifier |
string |
True |
このファイルの識別子を含むJSON文字列。同じパッケージタイプのバージョン間では、ファイル名は変更される可能性がありますが、識別子は通常同じままです。定義値は次のとおりです:
|
artifactPath |
string |
True |
既知の Astra Control Center データストア / ロケーションのルートからこのアーティファクトへのパスを含む JSON 文字列。例:/vmware/1.0/ 定義されている値は次のとおりです:
|
artifactVersion |
string |
False |
提供されている場合、その成果物のバージョンを含むJSON文字列。定義されている値は次のとおりです:
|
dependsOnComponents |
False |
現在のイメージをインストール/アップグレードするために必要なインストール済みコンポーネントを記述するJSONオブジェクトのJSON配列。 |
files
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
fileName |
string |
True |
ファイル名を含むJSON文字列。定義されている値は次のとおりです:
|
fileIdentifier |
string |
True |
このファイルの識別子を含むJSON文字列。同じパッケージタイプのバージョン間では、ファイル名は変更される可能性がありますが、識別子は通常同じままです。定義値は次のとおりです:
|
fileMediaType |
string |
True |
ファイルのメディアタイプを含むJSON文字列。定義済み値は、 "IANA"で定義されているメディアタイプです。さらに、yamlファイル用のapplication/x-yamlまたはapplication/x-yamlもサポートされています。
|
fileContents |
string |
True |
ファイルの内容を含むJSON文字列。定義された値は次のとおりです:
|
upgradableVersions
パッケージバージョンにアップグレード可能な最小バージョンと最大バージョンを含むJSONオブジェクト。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
minVersion |
string |
False |
パッケージバージョンにアップグレード可能な最小バージョンを記述したJSON文字列。定義された値は次のとおりです:
|
maxVersion |
string |
False |
パッケージバージョンにアップグレード可能な最大バージョンを記述したJSON文字列。定義された値は次のとおりです:
|
依存関係
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
componentName |
string |
True |
コンポーネント名を表すJSON文字列。定義値は次のとおりです:
|
componentMinVersion |
string |
False |
そのコンポーネントに必要な最小バージョンを記述したJSON文字列。定義された値は次のとおりです:
|
componentMaxVersion |
string |
False |
そのコンポーネントに必要な最大バージョンを記述したJSON文字列。定義された値は次のとおりです:
|
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
True |
||
作成タイムスタンプ |
string |
True |
|
modificationTimestamp |
string |
True |
|
作成者 |
string |
True |
|
modifiedBy |
string |
False |
package_1.0_get_response_body
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
packageName |
string |
True |
パッケージ名を含むJSON文字列。定義されている値は次のとおりです:
|
packageVersion |
string |
True |
パッケージのSemVerを含むJSON文字列。定義された値は次のとおりです:
|
packageType |
string |
True |
パッケージの種類を示すJSON文字列。これは、完全インストールパッケージかパッチかを示します。定義された値は次のとおりです:
|
bundleName |
array[string] |
False |
パッケージが含まれているバンドルの名前を含むJSON文字列のJSON配列。 |
severityLevel |
string |
True |
このパッチまたはインストールの重大度レベルを示すJSON文字列。定義された値は次のとおりです:
|
packageState |
string |
True |
パッケージの動作状態を示す値を含むJSON文字列。パッケージの確認とインポートが完了すると、ステータスは「complete」と表示されます。そうでない場合は、状態は「incomplete」と表示されます。定義値は次のとおりです:
|
packageStateTransitions |
True |
JSONオブジェクトのJSON配列。各オブジェクトは、特定の定義済み状態からの許可された状態遷移のセットを表します。各JSONオブジェクトには「from」と「to」というフィールドが含まれており、「from」の値は状態の名前、「to」の値は許可された宛先状態の配列です。定義値は次のとおりです:
|
|
packageStateDetails |
True |
現在の「状態」に関する詳細情報を一覧表示する JSON オブジェクトの JSON 配列。詳細情報が利用できない場合、この配列は空になります。
|
|
画像 |
配列["画像"] |
False |
パッケージの一部である各 Docker イメージを含む JSON オブジェクトの JSON 配列。 |
アーティファクト |
配列["アーティファクト"] |
False |
このパッケージに関連付けられている追加の成果物(バイナリファイルなど)を記述するJSONオブジェクトのJSON配列。 |
files |
配列["files"] |
False |
JSONオブジェクトのJSON配列。各オブジェクトは、このパッケージに関連付けられた画像以外の成果物を表します。 |
upgradableVersions |
False |
パッケージバージョンにアップグレード可能な最小バージョンと最大バージョンを含むJSONオブジェクト。 |
|
依存関係 |
配列["依存関係"] |
False |
このパッケージをインストールするために必要な、特定の依存関係の最小バージョンを記述するJSONオブジェクトのJSON配列 |
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
type_astra_metadata_list
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
続行 |
string |
False |
|
カウント |
番号 |
False |
|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |