アカウントを変更する
PUT /accounts/{account_id}
保存されているリソース全体を、指定されたJSONリクエストボディに置き換えますが、ユーザーが変更できないキー値は保持します。
副作用
-
「isEnabled」を「false」から「true」に変更すると、「enabledTimestamp」が現在時刻に設定されます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
一覧表示するアカウントコレクションのID
|
要求の本文
保存されているリソース全体を、指定されたJSONリクエストボディに置き換えますが、ユーザーが変更できないキー値は保持します。
副作用
-
「isEnabled」を「false」から「true」に変更すると、「enabledTimestamp」が現在時刻に設定されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
False |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
名前 |
string |
False |
アカウント名を含むJSON文字列。定義された値は次のとおりです:
|
状態 |
string |
False |
アカウントの運用状態を示す値を含むJSON文字列。定義された値は次のとおりです:
|
isEnabled |
string |
False |
アカウントが有効であることを示すJSON文字列。定義された値は次のとおりです:
|
enabledTimestamp |
string |
False |
アカウントが最後に有効化された日時を示すタイムスタンプを含むJSON文字列。アカウントが一度も有効化されていない場合、このフィールドは表示されません。定義された値は次のとおりです:
|
accountContact |
False |
アカウント有効化時にオーナーユーザーを作成するために必要な、ユーザー連絡先情報を含むJSONオブジェクト。 |
|
メタデータ |
False |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
リクエスト例
{
"type": "application/astra-account",
"version": "1.0",
"name": "frightened-pine"
}
応答
Status: 204, Indicates if the account resource was updated.
応答
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 |
|
invalidFields |
配列["invalidFields"] |
False |
無効なリクエストボディフィールドのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
応答
Status: 409, Conflict
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
|
invalidFields |
配列["invalidFields"] |
False |
無効なリクエストボディフィールドのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
応答
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/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
用語の意味
定義を参照
postalAddress
住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれている6つのJSON文字列すべてが存在します。何も指定しない場合、文字列は空になります。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
addressCountry |
string |
False |
ISO 3166 Alpha-2で規定されている、郵便住所に関連付けられた国名または国コードを含むJSON文字列。定義された値は次のとおりです:
|
addressLocality |
string |
False |
郵便番号に関連付けられた地域(例えば、都市)を含むJSON文字列。定義された値は次のとおりです:
|
addressRegion |
string |
False |
郵便番号に関連付けられた地域(例えば、州)を含むJSON文字列。定義された値は次のとおりです:
|
postalCode |
string |
False |
郵便番号に関連付けられた郵便番号を含むJSON文字列。定義された値は次のとおりです:
|
streetAddress1を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
string |
False |
郵便番号に関連付けられた番地を含むJSON文字列。定義された値は次のとおりです:
|
streetAddress2を使用したチャンク アップロード署名要求がサポートされるようになりました。 |
string |
False |
オプションの付加的な住所情報(番地、私書箱など)を含むJSON文字列。定義された値は次のとおりです:
|
accountContact
アカウント有効化時にオーナーユーザーを作成するために必要な、ユーザー連絡先情報を含むJSONオブジェクト。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
firstName |
string |
False |
ユーザーが指定したフルネーム(名)を含むJSON文字列。定義された値は次のとおりです:
|
lastName |
string |
False |
ユーザーが指定した長めの姓を含むJSON文字列。定義された値は次のとおりです:
|
companyName |
string |
False |
ユーザーに関連付けられた会社名を含むJSON文字列。このキーが存在しない場合、会社名が提供されていないことを示します。定義された値は次のとおりです:
|
string |
False |
ユーザーが指定したメールアドレスを含むJSON文字列。定義された値は次のとおりです:
|
|
電話 |
string |
False |
ユーザーの電話番号を含むJSON文字列。このキーが存在しない場合、電話番号が提供されていないことを示します。定義された値は次のとおりです:
|
postalAddress |
False |
住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれている6つの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 |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |
invalidFields
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なリクエストボディフィールドの名前 |
理由 |
string |
True |
リクエスト本文フィールドが無効な理由 |