Method: projects.locations.instances.list

指定されたプロジェクトとロケーションのインスタンスを一覧表示します。

HTTP リクエスト

GET https://notebooks.googleapis.com/v2/{parent}/instances

パスパラメータ

パラメータ
parent

string

必須。インスタンスの親。形式: - projects/{projectId}/locations/{location}: 特定のゾーンのインスタンスを一覧表示します。- projects/{projectId}/locations/-: すべてのロケーションのインスタンスを一覧表示します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • notebooks.instances.list

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リスト呼び出しの最大戻りサイズ。
pageToken

string

省略可。最後の結果からリストを続行するために使用できる、以前に返されたページトークン。
orderBy

string

省略可。結果の並べ替え。サポートされている値は「name」、「name desc」、または「」（並べ替えなし）です。
filter

string

省略可。リストフィルタ。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ノートブック インスタンスを一覧表示するためのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
instances[]

object (Instance)

返されたインスタンスのリスト。
nextPageToken

string

次のリスト呼び出しで最後の結果から一覧表示を続行するために使用できるページトークン。
unreachable[]

string

順序なしリスト。到達できなかったロケーション。例: ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']。ListInstancesResponse には、インスタンスまたは到達不能のいずれかのみが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

詳細については、Authentication Overview をご覧ください。