Obtaining Job Information
Function
This API is used to obtain information about a job via the job ID returned after a query request is delivered.
-
The URL for cluster management is in the format of https://Endpoint/uri, where uri specifies the resource path for API access.
-
You can call this API when:
-
Creating or deleting a cluster
-
Creating or deleting a node
-
Calling Method
For details, see Calling APIs.
URI
GET /autopilot/v3/projects/{project_id}/jobs/{job_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A |
job_id |
Yes |
String |
Job ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Details: Request body type or format Constraints: The GET method is not verified. Options:
Default value: N/A |
X-Auth-Token |
Yes |
String |
Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
kind |
String |
API type. The value is fixed at Job and cannot be changed. |
apiVersion |
String |
API version. The value is fixed at v3 and cannot be changed. |
metadata |
JobMetadata object |
Job metadata |
spec |
JobSpec object |
Detailed job parameters |
status |
JobStatus object |
Job status |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Job type. An example value is CreateCluster. |
clusterUID |
String |
ID of the cluster where the job runs. |
resourceID |
String |
ID of the resource on which the job is executed. |
resourceName |
String |
Name of the resource on which the job is executed. |
extendParam |
Map<String,String> |
Extended parameters |
subJobs |
Array of Job objects |
Subjob list.
|
Parameter |
Type |
Description |
---|---|---|
kind |
String |
API type. The value is fixed at Job and cannot be changed. |
apiVersion |
String |
API version. The value is fixed at v3 and cannot be changed. |
metadata |
JobMetadata object |
Job metadata |
spec |
JobSpec object |
Detailed job parameters |
status |
JobStatus object |
Job status |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Job ID |
creationTimestamp |
String |
Time when the job was created |
updateTimestamp |
String |
Time when the job was updated |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Job status. Possible values:
|
reason |
String |
Reason why the job is in the current state. |
Example Requests
None
Example Responses
Status code: 200
The job information is obtained.
{ "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 Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
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 ShowAutopilotJobSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); ShowAutopilotJobRequest request = new ShowAutopilotJobRequest(); request.withJobId("{job_id}"); try { ShowAutopilotJobResponse response = client.showAutopilotJob(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()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os 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__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowAutopilotJobRequest() request.job_id = "{job_id}" response = client.show_autopilot_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) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
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() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowAutopilotJobRequest{} request.JobId = "{job_id}" response, err := client.ShowAutopilotJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The job information is obtained. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot