列出所有帳戶

參數

Name	類型	在	必要	說明
包括	字串	查詢	錯誤	指示列出集合時應傳回哪些欄位。 URL 範例：「include=id」、「include=id,name」 OpenAPI 範例："id"
限制	字串	查詢	錯誤	表示列出集合時要傳回的資源數量上限。 URL 範例：「limit=2」 OpenAPI 範例：「2」
篩選器	字串	查詢	錯誤	指示在列出集合時，為了傳回資源而應符合哪些欄位。支援的運算子包括： eq - 等式 lt/gt - 小於/大於 lte/gte - 小於或等於/大於或等於 URL 範例：「filter=field%20eq%20%27value%27」 OpenAPI 範例："field eq 'value'"
訂單者	字串	查詢	錯誤	指示列出集合時資源的排序順序。 URL 範例：「orderBy=name」、「orderBy=name%20desc」 OpenAPI 範例："name desc"
跳過	字串	查詢	錯誤	表示列出集合時要跳過的資源數量。 URL 範例：「skip=1」 OpenAPI 範例：「1」
數	字串	查詢	錯誤	指出中繼資料物件是否應傳回資源總數。 URL 範例：「count=true」 OpenAPI 範例："true"
繼續		查詢	錯誤	指示要從哪個權杖繼續列出。 URL 範例：「continue=」 OpenAPI 範例：""</continue>

Name

類型

在

必要

說明

包括

字串

查詢

錯誤

指示列出集合時應傳回哪些欄位。

URL 範例：「include=id」、「include=id,name」

OpenAPI 範例："id"

限制

字串

查詢

錯誤

表示列出集合時要傳回的資源數量上限。

URL 範例：「limit=2」

OpenAPI 範例：「2」

篩選器

字串

查詢

錯誤

指示在列出集合時，為了傳回資源而應符合哪些欄位。

支援的運算子包括：

eq - 等式
lt/gt - 小於/大於
lte/gte - 小於或等於/大於或等於

URL 範例：「filter=field%20eq%20%27value%27」

OpenAPI 範例："field eq 'value'"

訂單者

字串

查詢

錯誤

指示列出集合時資源的排序順序。

URL 範例：「orderBy=name」、「orderBy=name%20desc」

OpenAPI 範例："name desc"

跳過

字串

查詢

錯誤

表示列出集合時要跳過的資源數量。

URL 範例：「skip=1」

OpenAPI 範例：「1」

數

字串

查詢

錯誤

指出中繼資料物件是否應傳回資源總數。

URL 範例：「count=true」

OpenAPI 範例："true"

繼續

查詢

錯誤

指示要從哪個權杖繼續列出。

URL 範例：「continue=」

OpenAPI 範例：""</continue>

回應

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[任何： "account_1.0_get_response_body"、array[]]	True
中繼資料	"type_astra_metadata_list"	True

Name

類型

必要

說明

項目

array[任何： "account_1.0_get_response_body"、array[]]

True

中繼資料

"type_astra_metadata_list"

True

範例回應

{
  "type": "application/astra-accounts",
  "version": "1.0",
  "items": [
    {
      "type": "application/astra-account",
      "version": "1.0",
      "id": "70796606-79ba-480b-966c-e4c600fbf622",
      "name": "fraught-pines",
      "state": "active",
      "isEnabled": "true",
      "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1723a17e-9fd1-4636-86e1-2ec9e04bce51"
      }
    },
    {
      "type": "application/astra-account",
      "version": "1.0",
      "id": "7976114d-35ec-48a7-ba31-22d8e94a8bb2",
      "name": "sad-dino",
      "state": "active",
      "isEnabled": "true",
      "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1723a17e-9fd1-4636-86e1-2ec9e04bce51"
      }
    }
  ],
  "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	字串	錯誤

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"]	錯誤	無效查詢參數清單

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	字串	錯誤

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	字串	錯誤

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"
}

定義

請參閱定義

postalAddress

包含一組 JSON 字串的 JSON 物件，用於指定位址。如果此金鑰不存在，則表示尚未提供位址。如果此金鑰存在，則包含的所有六個 JSON 字串都將存在。如果未提供任何內容，則字串為空。

Name	類型	必要	說明
addressCountry	字串	True	包含與郵政地址關聯的國家/地區名稱或國家/地區代碼的 JSON 字串，如 ISO 3166 Alpha-2 中所指定。定義的值為：最短長度：2 最大長度：2
addressLocality	字串	True	包含與郵寄地址相關聯的地區（例如城市）的 JSON 字串。定義的值為：最短長度：1 最大長度：63
addressRegion	字串	True	包含與郵寄地址關聯的區域（例如，州/省）的 JSON 字串。已定義的值包括：最短長度：1 最大長度：63
postalCode	字串	True	包含與郵遞地址相關聯之郵遞區號的 JSON 字串。已定義的值包括：最短長度：1 最大長度：31
streetAddress1	字串	True	包含與郵寄地址相關聯之街道地址的 JSON 字串。定義的值為：最短長度：1 最大長度：63
streetAddress2	字串	錯誤	包含選用輔助街道地址資訊、郵政信箱等的 JSON 字串。已定義的值包括：最短長度：1 最大長度：63

Name

類型

必要

說明

addressCountry

字串

True

包含與郵政地址關聯的國家/地區名稱或國家/地區代碼的 JSON 字串，如 ISO 3166 Alpha-2 中所指定。定義的值為：

最短長度：2
最大長度：2

addressLocality

字串

True

包含與郵寄地址相關聯的地區（例如城市）的 JSON 字串。定義的值為：

最短長度：1
最大長度：63

addressRegion

字串

True

包含與郵寄地址關聯的區域（例如，州/省）的 JSON 字串。已定義的值包括：

最短長度：1
最大長度：63

postalCode

字串

True

包含與郵遞地址相關聯之郵遞區號的 JSON 字串。已定義的值包括：

最短長度：1
最大長度：31

streetAddress1

字串

True

包含與郵寄地址相關聯之街道地址的 JSON 字串。定義的值為：

最短長度：1
最大長度：63

streetAddress2

字串

錯誤

包含選用輔助街道地址資訊、郵政信箱等的 JSON 字串。已定義的值包括：

最短長度：1
最大長度：63

accountContact

包含使用者聯絡資訊的 JSON 物件，用於在帳戶啟動時建立擁有者使用者。

Name	類型	必要	說明
firstName	字串	True	包含使用者指定的完整名字的 JSON 字串。已定義的值包括：最短長度：1 最大長度：63 此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。
lastName	字串	True	包含使用者指定的完整姓氏的 JSON 字串。已定義的值為：最短長度：1 最大長度：63 此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。
companyName	字串	錯誤	包含與使用者相關聯之公司名稱的 JSON 字串。如果此金鑰不存在，表示尚未提供公司名稱。定義的值為：最短長度：1 最大長度：63 此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。
電子郵件	字串	True	包含使用者指定電子郵件地址的 JSON 字串。定義的值為：最短長度：1 最大長度：63
電話	字串	錯誤	包含使用者電話號碼的 JSON 字串。如果此金鑰不存在，則表示尚未提供電話號碼。定義的值為：最短長度：1 最大長度：31
postalAddress	"postalAddress"	True	包含一組 JSON 字串的 JSON 物件，用於指定位址。如果此金鑰不存在，則表示尚未提供位址。如果此金鑰存在，則包含的所有六個 JSON 字串都將存在。如果未提供任何內容，則字串為空。

Name

類型

必要

說明

firstName

字串

True

包含使用者指定的完整名字的 JSON 字串。已定義的值包括：

最短長度：1
最大長度：63
此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。

lastName

字串

True

包含使用者指定的完整姓氏的 JSON 字串。已定義的值為：

最短長度：1
最大長度：63
此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。

companyName

字串

錯誤

包含與使用者相關聯之公司名稱的 JSON 字串。如果此金鑰不存在，表示尚未提供公司名稱。定義的值為：

最短長度：1
最大長度：63
此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。

電子郵件

字串

True

包含使用者指定電子郵件地址的 JSON 字串。定義的值為：

最短長度：1
最大長度：63

電話

字串

錯誤

包含使用者電話號碼的 JSON 字串。如果此金鑰不存在，則表示尚未提供電話號碼。定義的值為：

最短長度：1
最大長度：31

postalAddress

"postalAddress"

True

包含一組 JSON 字串的 JSON 物件，用於指定位址。如果此金鑰不存在，則表示尚未提供位址。如果此金鑰存在，則包含的所有六個 JSON 字串都將存在。如果未提供任何內容，則字串為空。

type_astra_label

Name	類型	必要	說明
姓名	字串	True
值	字串	True

Name

類型

必要

說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name	類型	必要
標籤	陣列["type_astra_label"]	錯誤
建立時間戳記	字串	錯誤
修改時間戳記	字串	錯誤
建立者	字串	錯誤
modifiedBy	字串	錯誤

Name

類型

必要

說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

account_1.0_get_response_body

Name	類型	必要	說明
類型	字串	True	資源的媒體類型。定義的值為： "application/astra-account"
版本	字串	True	資源版本。已定義值包括： "1.0"
ID	字串	True	資源的全域唯一識別碼。定義的值為：符合 UUIDv4 架構
姓名	字串	True	包含帳戶名稱的 JSON 字串。已定義的值包括：最短長度：1 最大長度：63 此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。
狀態	字串	True	JSON 字串包含指示帳戶運作狀態的值。定義的值為：「 pending 」 - 只能對帳戶下的使用者和角色資源進行更改（預設值）「active」- 可以對帳戶下的任何資源進行變更 "deletePending" - 使用者無法登入、資料保護作業已暫停、不再產生費用
isEnabled	字串	True	指示帳戶已啟用的 JSON 字串。定義的值為： "false" - 不允許使用者使用此帳戶 "true" - 允許使用者使用此帳戶
enabledTimestamp	字串	錯誤	包含時間戳記的 JSON 字串，指示帳戶上次啟用的時間。如果帳戶從未啟用過，則此欄位不存在。定義的值為：符合 ISO-8601 日期時間架構
accountContact	"accountContact"	錯誤	包含使用者聯絡資訊的 JSON 物件，用於在帳戶啟動時建立擁有者使用者。
中繼資料	"type_astra_metadata_update"	True	與資源相關聯的用戶端和服務指定中繼資料。定義的值為：遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name

類型

必要

說明

類型

字串

True

資源的媒體類型。定義的值為：

"application/astra-account"

版本

字串

True

資源版本。已定義值包括：

"1.0"

ID

字串

True

資源的全域唯一識別碼。定義的值為：

符合 UUIDv4 架構

姓名

字串

True

包含帳戶名稱的 JSON 字串。已定義的值包括：

最短長度：1
最大長度：63
此字串經過內部驗證，可防止 XSS、Unicode、目錄遍歷和 SQL 注入攻擊。

狀態

字串

True

JSON 字串包含指示帳戶運作狀態的值。定義的值為：

「 pending 」 - 只能對帳戶下的使用者和角色資源進行更改（預設值）
「active」- 可以對帳戶下的任何資源進行變更
"deletePending" - 使用者無法登入、資料保護作業已暫停、不再產生費用

isEnabled

字串

True

指示帳戶已啟用的 JSON 字串。定義的值為：

"false" - 不允許使用者使用此帳戶
"true" - 允許使用者使用此帳戶

enabledTimestamp

字串

錯誤

包含時間戳記的 JSON 字串，指示帳戶上次啟用的時間。如果帳戶從未啟用過，則此欄位不存在。定義的值為：

符合 ISO-8601 日期時間架構

accountContact

"accountContact"

錯誤

包含使用者聯絡資訊的 JSON 物件，用於在帳戶啟動時建立擁有者使用者。

中繼資料

"type_astra_metadata_update"

True

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

type_astra_metadata_list

Name	類型	必要
繼續	字串	錯誤
數	數字	錯誤
標籤	陣列["type_astra_label"]	錯誤
建立時間戳記	字串	錯誤
修改時間戳記	字串	錯誤
建立者	字串	錯誤
modifiedBy	字串	錯誤

Name

類型

必要

說明

繼續

字串

錯誤

數

數字

錯誤

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name	類型	必要	說明
姓名	字串	True	無效查詢參數的名稱
原因	字串	True	查詢參數無效的原因

Name

類型

必要

說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因

列出所有帳戶

Creating your file...

參數

回應

回應

回應

回應

錯誤

定義