Obtaining Information About Each Task Stage
Function
This API is used to obtain information about each stage of a task.
Calling Method
For details, see Calling APIs.
URI
GET /v1/record/{record_id}/full-stages
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
record_id |
Yes |
String |
Definition Build record ID. Constraints N/A. Range Use a 36-character string that includes digits, lowercase letters, and hyphens (-). Default Value N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cascade |
No |
Boolean |
Definition Whether to obtain steps using cascade query. Constraints N/A. Range N/A. Default Value N/A. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Definition API response status. Range ● success: The API call is successful. ● fail: The API call failed. |
error |
Object |
Definition Error message. Range N/A. |
result |
result object |
Definition Data returned after the API is successfully called. Range N/A. |
Parameter |
Type |
Description |
---|---|---|
build_stages |
Map<String,BuildStageRecord> |
Definition Build actions. Range N/A. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Action ID. Range N/A. |
status |
String |
Definition Action status. Range N/A. |
status_code |
Integer |
Definition Status code. Range N/A. |
log_status |
String |
Definition Log status. Range N/A. |
create_time |
String |
Definition Creation time. Range N/A. |
schedule_time |
String |
Definition Build assignment time. Range N/A. |
queued_time |
String |
Definition Build queuing duration. Range N/A. |
start_time |
String |
Definition Start time. Range N/A. |
finish_time |
String |
Definition End time. Range N/A. |
duration |
Integer |
Definition Build duration. Range N/A. |
build_duration |
Integer |
Definition Build duration of a subtask. Range N/A. |
pending_duration |
Integer |
Definition Wait time. Range N/A. |
build_record_id |
String |
Definition Build record ID. Range N/A. |
execution_id |
String |
Definition CloudOctopus task ID. Range N/A. |
execution_stage_name |
String |
Definition Action name. Range N/A. |
display_name |
String |
Definition Action name. Range N/A. |
node_id |
Integer |
Definition Node ID. Range N/A. |
sequence |
Integer |
Definition Sequence number. Range N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
GET https://{endpoint}/v1/record/901878212b1a49be9c1a1054c272762a/full-stages
Example Responses
Status code: 200
OK
{ "result" : { "build_stages" : { "initial" : { "id" : "a2866f49-76f6-4aa1-b26b-f91b2f95e2e7", "status" : "ABORTED", "status_code" : 8, "log_status" : null, "create_time" : "2024-09-24T03:18:49.000+00:00", "schedule_time" : "2024-09-24T03:18:49.000+00:00", "queued_time" : "2024-09-24T03:18:50.000+00:00", "start_time" : "2024-09-24T03:18:51.000+00:00", "finish_time" : "2024-09-24T03:18:59.000+00:00", "duration" : 10000, "build_duration" : 9000, "pending_duration" : 1000, "build_record_id" : "94baa8ec-fd3f-4cae-81af-b24385a7220f", "execution_id" : "j_fDyt05ip", "execution_stage_name" : "initial", "display_name" : "initial", "node_id" : 9, "sequence" : 0 }, "stage1" : { "id" : "c42a2957-df7e-4304-a759-3e4d02c456ed", "status" : "ABORTED", "status_code" : 8, "log_status" : null, "create_time" : "2024-09-24T03:18:49.000+00:00", "schedule_time" : "2024-09-24T03:18:49.000+00:00", "queued_time" : "2024-09-24T03:18:49.000+00:00", "start_time" : "2024-09-24T03:18:49.000+00:00", "finish_time" : "2024-09-24T03:18:59.000+00:00", "duration" : 0, "build_duration" : 0, "pending_duration" : 0, "build_record_id" : "94baa8ec-fd3f-4cae-81af-b24385a7220f", "execution_id" : "j_fDyt05ip", "execution_stage_name" : "stage1", "display_name" : "Cache Check", "node_id" : null, "sequence" : 1 }, "stage2" : { "id" : "03cb8420-29c0-42d5-91bf-ff65e101f165", "status" : "ABORTED", "status_code" : 8, "log_status" : null, "create_time" : "2024-09-24T03:18:49.000+00:00", "schedule_time" : "2024-09-24T03:18:49.000+00:00", "queued_time" : "2024-09-24T03:18:49.000+00:00", "start_time" : "2024-09-24T03:18:49.000+00:00", "finish_time" : "2024-09-24T03:18:59.000+00:00", "duration" : 0, "build_duration" : 0, "pending_duration" : 0, "build_record_id" : "94baa8ec-fd3f-4cae-81af-b24385a7220f", "execution_id" : "j_fDyt05ip", "execution_stage_name" : "stage2", "display_name" : "Code CheckOut", "node_id" : null, "sequence" : 2 }, "stage3" : { "id" : "d8e3269e-ba5b-46eb-bd57-32e99dcacdf2", "status" : "ABORTED", "status_code" : 8, "log_status" : null, "create_time" : "2024-09-24T03:18:49.000+00:00", "schedule_time" : "2024-09-24T03:18:49.000+00:00", "queued_time" : "2024-09-24T03:18:49.000+00:00", "start_time" : "2024-09-24T03:18:49.000+00:00", "finish_time" : "2024-09-24T03:18:59.000+00:00", "duration" : 0, "build_duration" : 0, "pending_duration" : 0, "build_record_id" : "94baa8ec-fd3f-4cae-81af-b24385a7220f", "execution_id" : "j_fDyt05ip", "execution_stage_name" : "stage3", "display_name" : "Maven", "node_id" : null, "sequence" : 3 }, "final" : { "id" : "ad40acdf-4ec9-4998-a425-5b32778d6e06", "status" : "ABORTED", "status_code" : 8, "log_status" : null, "create_time" : "2024-09-24T03:18:49.000+00:00", "schedule_time" : "2024-09-24T03:18:49.000+00:00", "queued_time" : "2024-09-24T03:18:49.000+00:00", "start_time" : "2024-09-24T03:18:49.000+00:00", "finish_time" : "2024-09-24T03:18:59.000+00:00", "duration" : 0, "build_duration" : 0, "pending_duration" : 0, "build_record_id" : "94baa8ec-fd3f-4cae-81af-b24385a7220f", "execution_id" : "j_fDyt05ip", "execution_stage_name" : "final", "display_name" : "final", "node_id" : null, "sequence" : 4 } } }, "error" : null, "status" : "success" }
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 |
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.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ShowBuildRecordFullStagesSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ShowBuildRecordFullStagesRequest request = new ShowBuildRecordFullStagesRequest(); request.withRecordId("{record_id}"); try { ShowBuildRecordFullStagesResponse response = client.showBuildRecordFullStages(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.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"] credentials = BasicCredentials(ak, sk) client = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowBuildRecordFullStagesRequest() request.record_id = "{record_id}" response = client.show_build_record_full_stages(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowBuildRecordFullStagesRequest{} request.RecordId = "{record_id}" response, err := client.ShowBuildRecordFullStages(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 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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