Method: projects.locations.list

このサービスでサポートされているロケーションに関する情報をリストします。

このメソッドは、ListLocationsRequest.name フィールドで指定されたリソース スコープに基づいてロケーションを一覧表示します。

  • グローバル ロケーション: name が空の場合、このメソッドはすべてのプロジェクトで使用できる公開ロケーションを一覧表示します。
  • プロジェクト固有のロケーション: name が projects/{project} の形式の場合、このメソッドは特定のプロジェクトに表示されるロケーションを一覧表示します。これには、プロジェクトで有効になっている公開、非公開、その他のプロジェクト固有のロケーションが含まれます。

gRPC とクライアント ライブラリの実装では、リソース名は name フィールドとして渡されます。直接サービス呼び出しの場合、リソース名は特定のサービス実装とバージョンに基づいてリクエストパスに組み込まれます。

HTTP リクエスト

GET https://gdchardwaremanagement.googleapis.com/v1alpha/{name=projects/*}/locations

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

ロケーションのコレクションを所有するリソース（該当する場合）。

クエリ パラメータ

パラメータ
filter

string

結果を絞り込んで、目的のサブセットに限定するフィルタ。フィルタリング言語は "displayName=tokyo" のような文字列を受け入れます。詳細については AIP-160 をご覧ください。
pageSize

integer

返される結果の最大件数です。設定されていない場合、サービスはデフォルトを選択します。
pageToken

string

レスポンスの nextPageToken フィールドから受け取ったページトークン。そのページトークンを送信して、後続のページを受け取ります。
extraLocationTypes[]

string

省略可。特に明記されていない限り、このフィールドは使用しないでください。これは主に内部で使用されます。

リクエストの本文

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

レスポンスの本文

Locations.ListLocations に対するレスポンス メッセージ。

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

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

object (Location)

リクエストで指定したフィルタに一致するロケーションのリスト。
nextPageToken

string

標準的なリストの次ページのトークン。

認可スコープ

次の OAuth スコープが必要です。

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

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

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • gdchardwaremanagement.locations.list

詳細については、IAM のドキュメントをご覧ください。