Skip to main content
23.07
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

すべてのアカウントを一覧表示

PDF

GET /accounts

コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。

パラメータ

Name を入力します 入力 必須 説明

含める

string

query

False

コレクションを一覧表示する際に、どのフィールドを返すかを指定します。

URLの例："include=id"、"include=id,name"

OpenAPI の例："id"

制限（ Limit ）

string

query

False

コレクションを一覧表示する際に返されるリソースの最大数を示します。

URLの例："limit=2"

OpenAPI の例："2"

フィルタ

string

query

False

コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。

サポートされているオペレータは次のとおりです：

  • eq - 等号

  • lt/gt - より小さい/より大きい

  • lte/gte - 以下/以上

URLの例："filter=field%20eq%20%27value%27"

OpenAPI の例：「field eq 'value'」

OrderBy

string

query

False

コレクションを一覧表示する際の、リソースの並び順を示します。

URLの例："orderBy=name"、"orderBy=name%20desc"

OpenAPI の例："name desc"

スキップします

string

query

False

コレクションを一覧表示する際にスキップするリソースの数を指定します。

URLの例：「skip=1」

OpenAPI の例："1"

カウント

string

query

False

メタデータオブジェクトで返されるリソースの総数。

URLの例："count=true"

OpenAPI の例："true"

続行

query

False

リストの表示を再開するトークンを示します。

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 を入力します 必須 説明

項目

配列[いずれか："account_1.0_get_response_body"、配列[]]

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 を入力します 必須 説明

を入力します

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

用語の意味

定義を参照

postalAddress

住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれている6つのJSON文字列すべてが存在します。何も指定しない場合、文字列は空になります。

Name を入力します 必須 説明

addressCountry

string

True

ISO 3166 Alpha-2で規定されている、郵便住所に関連付けられた国名または国コードを含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：2

  • 最大長さ：2

addressLocality

string

True

郵便番号に関連付けられた地域（例えば、都市）を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

addressRegion

string

True

郵便番号に関連付けられた地域（例えば、州）を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

postalCode

string

True

郵便番号に関連付けられた郵便番号を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：31

streetAddress1を使用したチャンク アップロード署名要求がサポートされるようになりました。

string

True

郵便番号に関連付けられた番地を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

streetAddress2を使用したチャンク アップロード署名要求がサポートされるようになりました。

string

False

オプションの付加的な住所情報（番地、私書箱など）を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

accountContact

アカウント有効化時にオーナーユーザーを作成するために必要な、ユーザー連絡先情報を含むJSONオブジェクト。

Name を入力します 必須 説明

firstName

string

True

ユーザーが指定したフルネーム（名）を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • この文字列は、XSS攻撃、Unicode攻撃、ディレクトリトラバーサル攻撃、SQLインジェクション攻撃を防ぐために内部的に検証されます。

lastName

string

True

ユーザーが指定した長めの姓を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • この文字列は、XSS攻撃、Unicode攻撃、ディレクトリトラバーサル攻撃、SQLインジェクション攻撃を防ぐために内部的に検証されます。

companyName

string

False

ユーザーに関連付けられた会社名を含むJSON文字列。このキーが存在しない場合、会社名が提供されていないことを示します。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • この文字列は、XSS攻撃、Unicode攻撃、ディレクトリトラバーサル攻撃、SQLインジェクション攻撃を防ぐために内部的に検証されます。

email

string

True

ユーザーが指定したメールアドレスを含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

電話

string

False

ユーザーの電話番号を含むJSON文字列。このキーが存在しない場合、電話番号が提供されていないことを示します。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：31

postalAddress

"postalAddress"

True

住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。このキーが存在しない場合、住所が提供されていないことを示します。このキーが存在する場合、含まれている6つのJSON文字列すべてが存在します。何も指定しない場合、文字列は空になります。

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

account_1.0_get_response_body

Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • "application/astra-account"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

名前

string

True

アカウント名を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • この文字列は、XSS攻撃、Unicode攻撃、ディレクトリトラバーサル攻撃、SQLインジェクション攻撃を防ぐために内部的に検証されます。

状態

string

True

アカウントの運用状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「pending」 - アカウント配下のユーザーおよびロールのリソースのみ変更可能です（デフォルト値）

  • 「アクティブ」 - アカウント内のあらゆるリソースに変更を加えることができます

  • 「deletePending」- ユーザーはログインできず、データ保護操作は停止され、料金は発生しなくなります

isEnabled

string

True

アカウントが有効であることを示すJSON文字列。定義された値は次のとおりです：

  • 「false」 - ユーザーはこのアカウントを使用する権限がありません

  • 「true」 - ユーザーはこのアカウントを使用することが許可されています

enabledTimestamp

string

False

アカウントが最後に有効化された日時を示すタイムスタンプを含むJSON文字列。アカウントが一度も有効化されていない場合、このフィールドは表示されません。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

accountContact

"accountContact"

False

アカウント有効化時にオーナーユーザーを作成するために必要な、ユーザー連絡先情報を含むJSONオブジェクト。

メタデータ

"type_astra_metadata_update"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

type_astra_metadata_list

Name を入力します 必須 説明

続行

string

False

カウント

番号

False

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由