ストレージバックエンドを取得する
GET /accounts/{account_id}/topology/v1/storageBackends/{storageBackend_id}
JSONレスポンスボディに格納されたStorage Backend APIリソースを返します。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
storageBackend_id |
string |
path(パス) |
True |
storageBackend コレクションをリストする ID |
応答
Status: 200, Returns the stored Storage Backend API resource in the JSON response body.
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
backendName |
string |
True |
ストレージバックエンドのユーザー指定名を含むJSON文字列。定義された値は次のとおりです:
|
backendType |
string |
True |
表現されているストレージバックエンドのタイプを示す値を含むJSON文字列。定義された値は次のとおりです:
|
backendVersion |
string |
True |
表現対象のストレージバックエンドのバージョンを示す値を含むJSON文字列。定義された値は次のとおりです:
|
backendCredentialsName |
string |
True |
ストレージバックエンドで使用される1つ以上の認証情報リソースの名前を示す値を含むJSON文字列。複数の認証情報オブジェクトが同じ名前を持つ場合に、認証情報のローテーションを可能にします。定義された値は次のとおりです:
|
configVersion |
string |
False |
ストレージバックエンドで使用されるアクティブな構成を示す値を含むJSON文字列。定義された値は次のとおりです:
|
状態 |
string |
True |
ストレージバックエンドの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
stateDesired |
string |
False |
ストレージバックエンドの望ましい動作状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
stateUnready |
array[string] |
True |
JSON文字列のJSON配列。各文字列は、ストレージバックエンドが「実行中」に移行できない理由、「失敗」または「不明」に移行した理由、および/または「失敗」に移行する危険性がある理由を示します。定義された値は次のとおりです:
|
managedState |
string |
True |
ストレージバックエンドの管理状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
managedStateUnready |
array[string] |
True |
JSON文字列のJSON配列。各文字列は、ストレージバックエンドが管理対象外である理由を示しています。定義された値は次のとおりです:
|
healthState |
string |
False |
ストレージバックエンドの健全性状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
healthStateUnready |
array[string] |
False |
JSON文字列のJSON配列。各文字列は、ストレージバックエンドが正常な状態にない理由を示しています。定義された値は次のとおりです:
|
protectionState |
string |
True |
ストレージバックエンドの保護状態を示す値を含むJSON文字列。ONTAPの場合は「unknown」。定義された値は次のとおりです:
|
protectionStateUnready |
array[string] |
True |
JSON文字列のJSON配列。各文字列は、保護ポリシーが規格に適合していない理由を示します。定義された値は次のとおりです:
|
機能 |
True |
このストレージバックエンドの機能を含むJSONオブジェクト。 |
|
ontap |
False |
ONTAPクラスタに関連する特定の情報を含むJSONオブジェクト。
|
|
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
回答例
{
"type": "application/astra-storageBackend",
"version": "1.3",
"id": "04ad4237-3c89-5ca5-8a40-282ab5eb6428",
"backendName": "st1-45",
"backendType": "ontap",
"backendVersion": "9.8",
"backendCredentialsName": "st1-45-cred",
"state": "discovered",
"stateUnready": [],
"managedState": "unmanaged",
"managedStateUnready": [],
"protectionState": "unknown",
"protectionStateUnready": [
"Waiting for storage backend discovery"
],
"capabilities": {
"flexClone": "true",
"snapMirror": "true",
"s3": "true"
},
"ontap": {
"authenticationStyle": "basic",
"backendManagementIP": "10.193.179.105",
"managementIPs": [
"10.193.188.110",
"10.193.179.105",
"10.193.179.106"
]
},
"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"
}
用語の意味
定義を参照
機能
このストレージバックエンドの機能を含むJSONオブジェクト。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
flexClone |
string |
True |
このストレージバックエンドがFlexCloneをサポートしているかどうかを示すJSON文字列。 |
snapMirror |
string |
True |
このストレージバックエンドがSnapMirrorをサポートしているかどうかを示すJSON文字列。 |
s3を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
string |
True |
このストレージバックエンドがs3をサポートしているかどうかを示すJSON文字列。 |
ontap
ONTAPクラスタに関連する特定の情報を含むJSONオブジェクト。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
authenticationStyle |
string |
True |
ONTAP認証がユーザ名とパスワードの組み合わせまたは証明書を使用して実行されるかどうかを示すJSON文字列。定義された値は次のとおりです:
|
backendManagementIP |
string |
False |
このONTAPクラスタへの接続に使用されるIPアドレスを含むJSON文字列。 |
manag理IP |
array[string] |
False |
このONTAPクラスタへの接続に使用される、すべての管理IPのリストを含むJSON文字列のJSON配列。これは、Tridentで検出されたバックエンドとAstraのストレージバックエンドを関連付けるために使用されます。
|
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 |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |