文档

ListDeploymentTargets - 获取部署目标列表

更新时间:

获取作业可部署目标的列表,部署目标是session集群或者perjob集群。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/namespaces/{namespace}/deployment-targets

请求参数

名称类型必填描述示例值
workspacestring

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
pageSizeinteger

分页参数,表示所请求页码元素数量,最大值为 100,最小值为 1,默认值为 10。

10
pageIndexinteger

分页参数,页码索引,表示所请求页码,最小值为 1,默认值为 1。

1

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****
successboolean

表示业务请求是否成功。

true
httpCodeinteger

固定值 200。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
pageSizeinteger

分页参数,表示所请求页码元素数量。

10
pageIndexinteger

分页参数,页码索引,表示所请求页码。

1
totalSizeinteger

满足查询条件的所有元素的数量。

1
dataarray
  • 当 success 为 true,返回满足查询条件的部署目标列表;

  • 当 success 为 false,返回空值。

DeploymentTarget

部署目标信息。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "pageSize": 10,
  "pageIndex": 1,
  "totalSize": 1,
  "data": [
    {
      "name": "deployment target",
      "namespace": "namespace"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)