功能介绍
该API用于获取任务信息。通过某一任务请求下发后返回的jobID来查询指定任务的进度。

-
集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径
-
该接口通常使用场景为:
-
创建、删除集群时,查询相应任务的进度。
-
创建、删除节点时,查询相应任务的进度。
-
调用方法
请参见如何调用API。
URI
GET /api/v3/projects/{project_id}/jobs/{job_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见如何获取接口URI中参数。 |
job_id |
是 |
String |
任务ID,获取方式请参见如何获取接口URI中参数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式) |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
kind |
String |
API类型,固定值“Job”,该值不可修改。 |
apiVersion |
String |
API版本,固定值“v3”,该值不可修改。 |
metadata |
任务元数据。 |
|
spec |
任务详细参数。 |
|
status |
任务状态信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
任务的类型,例:“CreateCluster”- 创建集群。 |
clusterUID |
String |
任务所在的集群的ID。 |
resourceID |
String |
任务操作的资源ID。 |
resourceName |
String |
任务操作的资源名称。 |
extendParam |
Map<String,String> |
扩展参数。 |
subJobs |
子任务的列表。
|
参数 |
参数类型 |
描述 |
---|---|---|
kind |
String |
API类型,固定值“Job”,该值不可修改。 |
apiVersion |
String |
API版本,固定值“v3”,该值不可修改。 |
metadata |
任务元数据。 |
|
spec |
任务详细参数。 |
|
status |
任务状态信息。 |
请求示例
无
响应示例
状态码: 200
表示获取任务信息成功。
{
"kind" : "Job",
"apiVersion" : "v3",
"metadata" : {
"uid" : "354331b2c-229a-11e8-9c75-0255ac100ceb",
"creationTimestamp" : "2018-08-02 08:12:40.672772389 +0000 UTC",
"updateTimestamp" : "2018-08-02 08:21:50.478108569 +0000 UTC"
},
"spec" : {
"type" : "CreateCluster",
"clusterUID" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
"resourceID" : "6f4dcb2c-229a-11e8-9c75-0255ac100ceb",
"resourceName" : "cluster-name",
"extendParam" : {
"serverID" : "bc467e3a-2338-11e8-825b-0255ac100c13"
},
"subJobs" : [ {
"kind" : "Job",
"apiVersion" : "v3",
"metadata" : {
"uid" : "fd474fab-9606-11e8-baa9-0255ac10215d",
"creationTimestamp" : "2018-08-02 03:52:34.615819618 +0000 UTC",
"updateTimestamp" : "2018-08-02 04:05:29.196243031 +0000 UTC"
},
"spec" : {
"type" : "InstallMaster",
"clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d",
"resourceID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d",
"extendParam" : {
"serverID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d"
}
},
"status" : {
"phase" : "Success"
}
}, {
"kind" : "Job",
"apiVersion" : "v3",
"metadata" : {
"uid" : "fd474f82-9606-11e8-baa8-0255ac10215d",
"creationTimestamp" : "2018-08-02 03:52:33.859150791 +0000 UTC",
"updateTimestamp" : "2018-08-02 03:52:34.615655429 +0000 UTC"
},
"spec" : {
"type" : "CreatePSMCert",
"clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d"
},
"status" : {
"phase" : "Success"
}
} ]
},
"status" : {
"phase" : "Running",
"reason" : ""
}
}
SDK代码示例
SDK代码示例如下。
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;
public class ShowJobSolution {
public static void main(String[] args) {
String ak = "<YOUR AK>";
String sk = "<YOUR SK>";
String projectId = "<project_id>";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
CceClient client = CceClient.newBuilder()
.withCredential(auth)
.withRegion(CceRegion.valueOf("cn-north-4"))
.build();
ShowJobRequest request = new ShowJobRequest();
request.withJobId("<job_id>");
try {
ShowJobResponse response = client.showJob(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
# coding: utf-8
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *
if __name__ == "__main__":
ak = "<YOUR AK>"
sk = "<YOUR SK>"
projectId = "<project_id>"
credentials = BasicCredentials(ak, sk, projectId) \
client = CceClient.new_builder() \
.with_credentials(credentials) \
.with_region(CceRegion.value_of("cn-north-4")) \
.build()
try:
request = ShowJobRequest()
request.job_id = "<job_id>"
response = client.show_job(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)
func main() {
ak := "<YOUR AK>"
sk := "<YOUR SK>"
projectId := "<project_id>"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := cce.NewCceClient(
cce.CceClientBuilder().
WithRegion(region.ValueOf("cn-north-4")).
WithCredential(auth).
Build())
request := &model.ShowJobRequest{}
request.JobId = "<job_id>"
response, err := client.ShowJob(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
表示获取任务信息成功。 |
错误码
请参见错误码。