Method: projects.configs.variables.list

任意の設定内で、設定されたすべてのフィルタにマッチする変数を一覧表示します。returnValues が true の場合を除き、値ではなく変数名のみがリストされます。この場合、ユーザーが variables.get に対する IAM 権限を持っている変数のみが返されます。

HTTP リクエスト

GET https://runtimeconfig.googleapis.com/v1beta1/{parent=projects/*/configs/*}/variables

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

パスパラメータ

パラメータ
parent

string

変数を一覧表示したい RuntimeConfig リソースへのパス。構成は事前に存在している必要があります。パスは次の形式にする必要があります。

projects/[PROJECT_ID]/configs/[CONFIG_NAME]

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

  • runtimeconfig.variables.list

クエリ パラメータ

パラメータ
filter

string

指定したフィルタを照合することによって、変数をフィルタリングします。次に例を示します。

projects/example-project/config/[CONFIG_NAME]/variables/example-variable。
pageSize

number

ページごとに返す結果の数を指定します。要素数が指定された数より少ない場合は、すべての要素が返されます。
pageToken

string

使用するページトークンを指定します。pageToken を、前のリスト リクエストから返された nextPageToken に設定して、結果の次のページを取得します。
returnValues

boolean

このフラグは、ユーザーが変数の値を返すかどうかを示します。true の場合、ユーザーに IAM variables.get 権限がある変数のみが値とともに返されます。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

variables.list() メソッドに対するレスポンス。

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

object(Variable)

変数とその値のリスト。返される変数オブジェクトの順序は任意です。
nextPageToken

string

このトークンを使用すると、リスト リクエストの結果の次のページを取得できます。結果数が pageSize より大きい場合は、次のリスト リクエストのクエリ パラメータ pageToken の値として nextPageToken を使用します。その後のリスト リクエストには、結果のページングを続行するための独自の nextPageToken が付与されます。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。

試してみる