修改帳戶
PUT /accounts/{account_id}
將整個儲存的資源替換為提供的 JSON 請求主體,同時保留使用者不可修改的鍵值。
副作用
-
將 "isEnabled" 從 "false" 改為 "true" 會將 "enabledTimestamp" 設定為當前時間。
參數
| Name | 類型 | 在 | 必要 | 說明 |
|---|---|---|---|---|
account_id |
字串 |
路徑 |
True |
要列出的帳戶集合 ID
|
請求本文
將整個儲存的資源替換為提供的 JSON 請求主體,同時保留使用者不可修改的鍵值。
副作用
-
將 "isEnabled" 從 "false" 改為 "true" 會將 "enabledTimestamp" 設定為當前時間。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
資源的媒體類型。定義的值為:
|
版本 |
字串 |
True |
資源版本。定義的值為:
|
ID |
字串 |
錯誤 |
資源的全域唯一識別碼。定義的值為:
|
姓名 |
字串 |
錯誤 |
包含帳戶名稱的 JSON 字串。定義的值為:
|
狀態 |
字串 |
錯誤 |
JSON 字串包含指示帳戶運作狀態的值。定義的值為:
|
isEnabled |
字串 |
錯誤 |
指示帳戶已啟用的 JSON 字串。定義的值為:
|
enabledTimestamp |
字串 |
錯誤 |
包含時間戳記的 JSON 字串,指示帳戶上次啟用的時間。如果帳戶從未啟用過,則此欄位不存在。定義的值為:
|
accountContact |
錯誤 |
包含使用者聯絡資訊的 JSON 物件,用於在帳戶啟動時建立擁有者使用者。 |
|
中繼資料 |
錯誤 |
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
|
範例請求
{
"type": "application/astra-account",
"version": "1.0",
"name": "frightened-pine"
}
回應
Status: 204, Indicates if the account resource was updated.
回應
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 |
字串 |
錯誤 |
|
invalidFields |
陣列["invalidFields"] |
錯誤 |
無效請求本文欄位清單 |
範例回應
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
回應
Status: 409, Conflict
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
|
invalidFields |
陣列["invalidFields"] |
錯誤 |
無效請求本文欄位清單 |
範例回應
{
"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 | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
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/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
定義
請參閱定義
postalAddress
包含一組 JSON 字串的 JSON 物件,用於指定位址。如果此金鑰不存在,則表示尚未提供地址。如果此金鑰存在,則包含的所有六個 JSON 字串都將存在。如果未提供任何內容,則字串為空。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
addressCountry |
字串 |
錯誤 |
包含與郵政地址關聯的國家/地區名稱或國家/地區代碼的 JSON 字串,如 ISO 3166 Alpha-2 中所指定。定義的值為:
|
addressLocality |
字串 |
錯誤 |
包含與郵寄地址相關聯的地區(例如城市)的 JSON 字串。定義的值為:
|
addressRegion |
字串 |
錯誤 |
包含與郵寄地址關聯的區域(例如,州/省)的 JSON 字串。定義的值為:
|
postalCode |
字串 |
錯誤 |
包含與郵遞地址相關聯之郵遞區號的 JSON 字串。定義的值為:
|
streetAddress1 |
字串 |
錯誤 |
包含與郵寄地址相關聯之街道地址的 JSON 字串。定義的值為:
|
streetAddress2 |
字串 |
錯誤 |
包含選用輔助街道地址資訊、郵政信箱等的 JSON 字串。定義的值為:
|
accountContact
包含使用者聯絡資訊的 JSON 物件,用於在帳戶啟動時建立擁有者使用者。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
firstName |
字串 |
錯誤 |
包含使用者指定的完整名字的 JSON 字串。定義的值為:
|
lastName |
字串 |
錯誤 |
包含使用者指定的完整姓氏的 JSON 字串。定義的值為:
|
companyName |
字串 |
錯誤 |
包含與使用者相關聯之公司名稱的 JSON 字串。如果此金鑰不存在,表示尚未提供公司名稱。定義的值為:
|
電子郵件 |
字串 |
錯誤 |
包含使用者指定電子郵件地址的 JSON 字串。定義的值為:
|
電話 |
字串 |
錯誤 |
包含使用者電話號碼的 JSON 字串。如果此金鑰不存在,則表示尚未提供電話號碼。定義的值為:
|
postalAddress |
錯誤 |
包含一組 JSON 字串的 JSON 物件,用於指定位址。如果此金鑰不存在,則表示尚未提供地址。如果此金鑰存在,則包含的所有六個 JSON 字串都將存在。如果未提供任何內容,則字串為空。 |
type_astra_label
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
|
值 |
字串 |
True |
type_astra_metadata_update
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
-
符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定,元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
invalidParams
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效查詢參數的名稱 |
原因 |
字串 |
True |
查詢參數無效的原因 |
invalidFields
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效請求內文欄位的名稱 |
原因 |
字串 |
True |
請求本文欄位無效的原因 |