すべてのライセンスを一覧表示
GET /accounts/{account_id}/core/v1/licenses
コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
含める |
string |
query |
False |
コレクションを一覧表示する際に、どのフィールドを返すかを指定します。 URLの例:"include=id"、"include=id,name" OpenAPI の例:"id"
|
制限( Limit ) |
string |
query |
False |
コレクションを一覧表示する際に返されるリソースの最大数を示します。 URLの例:"limit=2" OpenAPI の例:"2" |
フィルタ |
string |
query |
False |
コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。 サポートされているオペレータは次のとおりです:
URLの例:"filter=field%20eq%20%27value%27" OpenAPI の例:「field eq 'value'」 |
応答
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
項目 |
配列[いずれか:"license_1.0_get_response_body"、配列[]] |
True |
|
メタデータ |
True |
回答例
{
"type": "application/astra-licenses",
"version": "1.0",
"items": [
[
"c8aa757a-5318-489f-8134-a2a1a6956a3e",
"Astra SDS"
],
[
"0f7cc03d-9afc-4192-af7f-b29ab24f8f2a",
"Astra Enterprise"
]
],
"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"
}
用語の意味
定義を参照
アドオン
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
startDate |
string |
False |
このアドオンが有効になる日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
endDate |
string |
False |
このアドオンが無効になった日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
機能 |
string |
False |
このアドオンに関連付けられた機能のリストを含むJSON文字列。定義された値は次のとおりです:
|
capacity |
string |
False |
アドオンから抽出された容量を含むJSON文字列。定義された値は次のとおりです:
|
licenseProtocol |
string |
False |
このアドオンに関連付けられたライセンスプロトコルを含むJSON文字列。定義された値は次のとおりです:
|
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata_update
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
license_1.0_get_response_body
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
割り当て |
string |
False |
ライセンスが何に割り当てられているかを示すIDを含むJSON文字列。ライセンスが割り当てられている場合にのみ存在します。Astra Control Centerライセンスの場合、このフィールドにはアカウントIDを入力する必要があり、POST URIで指定されたアカウントIDと一致している必要があります。定義された値は次のとおりです:
|
hostID |
string |
False |
ライセンスが紐付けられているホスト識別子を含むJSON文字列。ライセンスがホストロックされている場合にのみ表示されます。定義された値は次のとおりです:
|
deviceCredentialID |
string |
False |
Credential APIに関連付けられたdeviceCredentialの識別子を含むJSON文字列。Astra Data Storeライセンスにのみ存在します。定義された値は次のとおりです:
|
isEvaluation |
string |
True |
ライセンスが評価版ライセンスであるかどうかを示すJSON文字列。定義された値は次のとおりです:
|
licenseProtocol |
string |
True |
ライセンスから抽出されたライセンスプロトコルを含むJSON文字列。定義された値は次のとおりです:
|
licenseText |
string |
True |
NetAppライセンスシステムから取得したライセンスJSONのbase64エンコード表現を含むJSON文字列。署名検証を可能にするため、これは元のバイトレベルの順序で提供されなければなりません。定義された値は次のとおりです:
|
validFromTimestamp |
string |
True |
ライセンスが有効になる日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
validUntilTimestamp |
string |
True |
ライセンスが無効になった日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
製品 |
string |
True |
ライセンスから抽出された製品文字列を含むJSON文字列。定義された値は次のとおりです:
|
productVersion |
string |
True |
ライセンスから抽出されたバージョン文字列を含むJSON文字列。定義された値は次のとおりです:
|
productSN |
string |
True |
ライセンスから抽出されたシリアル番号文字列を含むJSON文字列。定義された値は次のとおりです:
|
機能 |
string |
True |
ライセンスから抽出されたパッケージ値を含むJSON文字列。定義された値は次のとおりです:
|
capacity |
string |
True |
ライセンスから抽出された容量を含むJSON文字列。 |
capacity2を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
string |
True |
ライセンスから抽出されたセカンダリ容量を含む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 |
クエリパラメータが無効な理由 |