Method: folders.locations.list

• HTTP リクエスト
• パスパラメータ
• クエリ パラメータ
• リクエストの本文
• レスポンスの本文
• 認可スコープ
• IAM 権限
• 試してみる

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

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

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

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

HTTP リクエスト

GET https://observability.googleapis.com/v1/{name=folders/*}/locations

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

パスパラメータ

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

クエリ パラメータ

パラメータ
filter	string 結果を絞り込んで、目的のサブセットに限定するフィルタ。フィルタリング言語は "displayName=tokyo" のような文字列を受け入れます。詳細については AIP-160 をご覧ください。
pageSize	integer 返される結果の最大件数です。設定されていない場合、サービスはデフォルトを選択します。
pageToken	string レスポンスの nextPageToken フィールドから受け取ったページトークン。そのページトークンを送信して、後続のページを受け取ります。
extraLocationTypes[]	string 省略可。この項目は使用しないでください。明示的に記載されていない限り、これはサポート対象外であり、無視されます。これは主に内部で使用されます。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には ListLocationsResponse のインスタンスが含まれます。

認可スコープ

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

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

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

IAM 権限

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

• observability.locations.list

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