列出所有授權
GET /accounts/{account_id}/core/v1/licenses
傳回集合中所有符合資源的 JSON 陣列。如果在請求中指定了個別欄位,則項目 JSON 陣列將按指定順序包含每個相符資源所請求的欄位。
參數
| Name | 類型 | 在 | 必要 | 說明 |
|---|---|---|---|---|
account_id |
字串 |
路徑 |
True |
包含帳戶資源的 ID
|
包括 |
字串 |
查詢 |
錯誤 |
指示列出集合時應傳回哪些欄位。 URL 範例:「include=id」、「include=id,name」 OpenAPI 範例:"id"
|
限制 |
字串 |
查詢 |
錯誤 |
表示列出集合時要傳回的資源數量上限。 URL 範例:「limit=2」 OpenAPI 範例:「2」 |
篩選器 |
字串 |
查詢 |
錯誤 |
指示在列出集合時,為了傳回資源而應符合哪些欄位。 支援的運算子包括:
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 | 類型 | 必要 | 說明 |
|---|---|---|---|
項目 |
array[任何: "license_1.0_get_response_body"、array[]] |
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 | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
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"
}
定義
請參閱定義
附加元件
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
startDate |
字串 |
錯誤 |
包含時間戳記的 JSON 字串,指示此附加元件何時生效。定義的值為:
|
endDate |
字串 |
錯誤 |
包含時間戳記的 JSON 字串,指示此附加元件何時失效。定義的值為:
|
功能 |
字串 |
錯誤 |
包含與此附加元件相關聯的功能清單的 JSON 字串。定義的值為:
|
容量 |
字串 |
錯誤 |
包含從附加元件中擷取的容量資訊的 JSON 字串。定義的值為:
|
licenseProtocol |
字串 |
錯誤 |
包含與此附加元件相關聯的授權通訊協定的 JSON 字串。定義的值為:
|
type_astra_label
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
|
值 |
字串 |
True |
type_astra_metadata_update
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
-
符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定,元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
license_1.0_get_response_body
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
資源的媒體類型。定義的值為:
|
版本 |
字串 |
True |
資源版本。定義的值為:
|
ID |
字串 |
True |
資源的全域唯一識別碼。定義的值為:
|
分配 |
字串 |
錯誤 |
包含 ID 的 JSON 字串,指示授權分配給哪個對象。僅在分配授權時存在。對於 Astra Control Center 授權,此欄位必須填入帳戶 ID,並且必須與 POST URI 中指定的帳戶 ID 相符。定義的值為:
|
hostID |
字串 |
錯誤 |
包含授權綁定的主機識別碼的 JSON 字串。僅當授權鎖定到主機時才存在。定義的值為:
|
deviceCredentialID |
字串 |
錯誤 |
包含與 Credential API 關聯的 deviceCredential 識別碼的 JSON 字串。僅適用於 Astra Data Store 授權。定義的值為:
|
isEvaluation |
字串 |
True |
JSON 字串,用於指示授權是否為評估授權。定義的值為:
|
licenseProtocol |
字串 |
True |
包含從授權中擷取的授權通訊協定的 JSON 字串。定義的值為:
|
licenseText |
字串 |
True |
JSON 字串,包含從 NetApp 授權系統取得的授權 JSON 的 base64 編碼表示。必須以原始位元組層級順序提供,以便進行簽章驗證。定義的值為:
|
validFromTimestamp |
字串 |
True |
包含時間戳記的 JSON 字串,指示授權何時生效。定義的值為:
|
validUntilTimestamp |
字串 |
True |
包含時間戳記的 JSON 字串,指示授權何時不再有效。定義的值為:
|
產品 |
字串 |
True |
包含從授權中擷取的產品字串的 JSON 字串。定義的值為:
|
productVersion |
字串 |
True |
包含從授權中擷取的版本字串的 JSON 字串。定義的值為:
|
產品 SN |
字串 |
True |
包含從授權中擷取的序號字串的 JSON 字串。定義的值為:
|
功能 |
字串 |
True |
包含從授權中擷取的套件值的 JSON 字串。定義的值為:
|
容量 |
字串 |
True |
包含從授權中擷取之容量的 JSON 字串。 |
capacity2 |
字串 |
True |
包含從授權中擷取之次要容量的 JSON 字串。 |
附加元件 |
陣列["附加元件"] |
錯誤 |
包含授權附加元件清單的 JSON 物件 JSON 陣列。附加元件是指授權在未來某個潛在日期發生的變更。 |
中繼資料 |
True |
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
|
type_astra_metadata_list
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
繼續 |
字串 |
錯誤 |
|
數 |
數字 |
錯誤 |
|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
invalidParams
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效查詢參數的名稱 |
原因 |
字串 |
True |
查詢參數無效的原因 |