Method: projects.profiles.list

列出到目前为止已收集且调用方有权查看的配置文件。

HTTP 请求

GET https://cloudprofiler.googleapis.com/v2/{parent=projects/*}/profiles

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级,拥有此配置文件集合。格式:projects/{user_project_id}。其格式为 projects/{project}

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • cloudprofiler.profiles.list

查询参数

参数
pageSize

integer

可选。需要返回的最大项数。 默认 pageSize 为 1000。上限为 1,000。

pageToken

string

可选。用于继续分页并获取特定网页中的个人资料的令牌。进行分页时,提供给 profiles.list 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

ListProfileResponse 包含用户有权查看的项目中部署的收集配置文件列表。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "profiles": [
    {
      object (Profile)
    }
  ],
  "nextPageToken": string,
  "skippedProfiles": integer
}
字段
profiles[]

object (Profile)

提取的配置文件列表。

nextPageToken

string

用于接收下一页结果的令牌。如果没有更多要提取的个人资料,则此字段可能为空。

skippedProfiles

integer

当前页面中因无法成功提取而跳过的配置文件数。此值通常应为零。非零值可能表示暂时性失败,在这种情况下,如果数字对于您的用例来说过高,可能会重新尝试调用。

授权范围

需要以下 OAuth 范围之一:

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

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