调用ListDeploymentTargets可以获取作业可部署目标的列表,部署目标是session集群或者perjob集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
workspace | String | 是 | a14bd5d90a**** |
工作空间ID。 |
请求语法
GET /api/v2/namespaces/{namespace}/deployment-targets HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
namespace | String | Path | 是 | default-namespace |
项目空间名称。 |
pageSize | Integer | Query | 否 | 10 |
分页参数,表示所请求页码元素数量,最大值为100,最小值为1,默认值为10。 |
pageIndex | Integer | Query | 否 | 1 |
分页参数,页码索引,表示所请求页码,最小值为1,默认值为1。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
requestId | String | CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
请求ID。 |
success | Boolean | true |
表示业务请求是否成功。 |
httpCode | Integer | 200 |
固定值200。 |
errorCode | String | "" |
|
errorMessage | String | "" |
|
pageSize | Integer | 10 |
分页参数,表示所请求页码元素数量。 |
pageIndex | Integer | 1 |
分页参数,页码索引,表示所请求页码。 |
totalSize | Integer | 1 |
满足查询条件的所有元素的数量。 |
data | Array of DeploymentTarget |
|
示例
请求示例
GET /api/v2/namespaces/default-namespace/deployment-targets?pageSize=10&pageIndex=1 HTTP/1.1
Host:ververica.aliyuncs.com
workspace:a14bd5d90a****
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListDeploymentTargetsResponse>
<requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>
<success>true</success>
<httpCode>200</httpCode>
<errorCode>""</errorCode>
<errorMessage>""</errorMessage>
<pageSize>10</pageSize>
<pageIndex>1</pageIndex>
<totalSize>1</totalSize>
<data>
<name>deployment target</name>
<namespace>namespace</namespace>
</data>
</ListDeploymentTargetsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
} ]
}