更新时间:2025-08-26 GMT+08:00
分享

获取构建记录的构建脚本

功能介绍

获取构建记录的构建脚本。

调用方法

请参见如何调用API

URI

GET /v1/record/{record_id}/build-script

表1 路径参数

参数

是否必选

参数类型

描述

record_id

String

参数解释

构建记录ID。

约束限制

不涉及。

取值范围

36位数字、小写字母、'-'组合。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token

约束限制

不支持租户全局token,请使用scope为project的region级token。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

String

参数解释

构建脚本。

取值范围

不涉及。

error

String

参数解释

返回错误信息。

取值范围

不涉及。

status

String

参数解释

返回状态信息。

取值范围

● success:表示接口调用成功。

● fail:表示接口调用失败。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/record/d7292509-18a9-4d7e-b503-25d327bc09cf/build-script

响应示例

状态码:200

OK

{
  "result" : "---\nversion: \"2.0\"\ntimeout:\n  limit: 240\n  unit: \"minute\"\ndevcloud_metadata:\n  label: \"docker\"\n  imageRegex:\n  - \".*/codeci/((?!dotnetframework|msbuild|dotnetcore|shell).)*$\"\n  buildType: \"linux\"\n  jobName: \"testJobName\"\n  jobId: \"6d8522e0799b4d678d08ac22210b0aff\"\n  serviceType: \"codeci\"\n  projectId: \"b4d3971c3988463b865f6f920846149e\"\nstages:\n  stage2:\n    meta:\n      uuid: \"20040\"\n      displayName: \"Code CheckOut\"\n    env:\n      dockerImage: \"swr.{region}.myhuaweicloud.com/codeci/shell:shell4.2.46-git2.23-zip-1.1.0\"\n      dockerArgs: \"-v /etc/localtime:/etc/localtime:ro -v /devcloud/cache/config_backup.json:/home/slave/.config/config_backup.json:ro\\\n        \\ -e LC_ALL=en_US.utf8 -e LANGUAGE=en_US.utf8  --memory=6144M --cpus=2 \"\n      dockerImageBackup: \"swr.{region}.myhuaweicloud.com/codeci/shell:shell4.2.46-git2.23-zip-1.1.0\"\n      extraDockerImage: \"swr.{region}.myhuaweicloud.com/codeci/shell:shell4.2.46-git2.23-zip-1.1.0\"\n      extraDockerArgs: \"-v /etc/localtime:/etc/localtime:ro -v /devcloud/cache/config_backup.json:/home/slave/.config/config_backup.json:ro\\\n        \\ -e LC_ALL=en_US.utf8 -e LANGUAGE=en_US.utf8  --memory=6144M --cpus=2 \"\n      extraDockerImageBackup: \"swr.{region}.myhuaweicloud.com/codeci/shell:shell4.2.46-git2.23-zip-1.1.0\"\n      language: \"zh-cn\"\n    tasks:\n    - external_pre_checkout:\n        openPlatFormUrl: \"https://devcloud-backend.{region}.myhuaweicloud.com:7632/wukong\"\n        openPlatformProxy: \"\"\n        domainName: \"testUser\"\n        codehubAdapterAddress: \"https://devcloud-backend.cn-north-208.myhuaweicloud.com:7503\"\n        userName: \"testUser\"\n        scm:\n          url: \"git@codehub.devcloud.{region}.huawei.com:b4d3971c3988463b865f6f920846149e/aaa/Unit.git\"\n          branch: \"master\"\n          branchRegex: \"\"\n          branchRegexMessage: \"\"\n          isAutoBuild: false\n          repoID: \"2111898074\"\n          repoExist: true\n          disableSubmodules: true\n          scmType: \"codehub\"\n          buildType: \"branch\"\n          checkoutName: \"master\"\n          depth: \"1\"\n          groupName: \"b4d3971c3988463b865f6f920846149e/aaa\"\n          repoName: \"Unit\"\n          webUrl: \"https://devcloud.{region}.huawei.com/codehub/2111898074/home\"\n        userId: \"ae22fd035f354cfa8d82a3f1c8940446\"\n        domainId: \"60021bab32fd450aa2cb89226f425e06\"\n        opensourceUrl: \"https://opensource.{region}.myhuaweicloud.com:8447\"\n    preCondition: \"SUCCESS\"",
  "error" : null,
  "status" : "success"
}

SDK代码示例

SDK代码示例如下。

 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 ShowBuildRecordBuildScriptSolution {

    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();
        ShowBuildRecordBuildScriptRequest request = new ShowBuildRecordBuildScriptRequest();
        request.withRecordId("{record_id}");
        try {
            ShowBuildRecordBuildScriptResponse response = client.showBuildRecordBuildScript(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 = ShowBuildRecordBuildScriptRequest()
        request.record_id = "{record_id}"
        response = client.show_build_record_build_script(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.ShowBuildRecordBuildScriptRequest{}
	request.RecordId = "{record_id}"
	response, err := client.ShowBuildRecordBuildScript(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档