Method: projects.algorithms.list

获取可在表达式中使用的所有算法的列表。

HTTP 请求

GET https://earthengine.googleapis.com/v1beta/{parent=projects/*}/algorithms

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。应被视为此请求的服务使用方的 Google Cloud Platform 项目的项目 ID 或项目编号。格式为 projects/{project-id}。

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

  • earthengine.computations.create

请求正文

请求正文必须为空。

响应正文

可在表达式中使用的所有算法。

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

JSON 表示法 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
字段
algorithms[]

object (Algorithm)

可用算法的列表。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/earthengine
  • https://www.googleapis.com/auth/earthengine.readonly
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

如需了解详情，请参阅 OAuth 2.0 Overview。

算法

适用于表达式的算法的说明。

JSON 表示法 
{
  "name": string,
  "description": string,
  "returnType": string,
  "arguments": [
    {
      object (AlgorithmArgument)
    }
  ],
  "deprecated": boolean,
  "deprecationReason": string,
  "hidden": boolean,
  "preview": boolean,
  "sourceCodeUri": string
}
字段
name

string

算法的名称，格式为“algorithms/…”。
description

string

直观易懂的算法说明。
returnType

string

算法返回的类型的名称。
arguments[]

object (AlgorithmArgument)

算法接受的参数的说明。
deprecated

boolean

算法是否已废弃。
deprecationReason

string

如果此算法已废弃，则废弃原因。
hidden

boolean

此算法是否应在客户端应用中隐藏，并默认不显示。
preview

boolean

此算法是否为预览版功能，尚未面向普通用户广泛提供。
sourceCodeUri

string

包含算法源代码的资源的 URI。如果用户无权访问或无法确定特定 URI，则为空。

AlgorithmArgument

算法参数的说明。

JSON 表示法 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
字段
argumentName

string

参数的名称。
type

string

参数类型的名称。
description

string

参数的直观易懂说明。
optional

boolean

参数是否为可选参数。
defaultValue

value (Value format)

如果未提供值，参数将采用的默认值。