Method: projects.configs.variables.list

列出给定配置中的变量,这些变量与任何提供的过滤条件匹配。这只会列出变量名称,而不会列出值,除非 returnValues 为 true,在这种情况下,系统只会返回用户对 variables.get 具有 IAM 权限的变量。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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,请在下一个列表请求中将 nextPageToken 用作查询参数 pageToken 的值。后续列表请求将具有自己的 nextPageToken,以便继续翻页浏览结果

授权范围

需要以下 OAuth 范围之一:

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

如需了解详情,请参阅身份验证概览

试试看!