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

查看系统预定义参数

功能介绍

查看系统预定义参数。

调用方法

请参见如何调用API

URI

GET /v1/job/system-parameters

请求参数

响应参数

状态码:200

表1 响应Body参数

参数

参数类型

描述

status

String

参数解释

接口响应状态。

取值范围

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

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

error

Object

参数解释

错误信息。

取值范围

不涉及。

result

Array of result objects

参数解释

本次任务的构建步骤详情,返回的步骤为页面可见步骤。

取值范围

不涉及。

表2 result

参数

参数类型

描述

id

Integer

参数解释

系统预定义参数的编号。

取值范围

不涉及。

parameter_name

String

参数解释

参数名称。

取值范围

BUILDNUMBER(构建编号。格式为“日期.今日该构建任务执行次数”),TIMESTAMP(构建执行时间戳。例如:20190219191621),INCREASENUM(从1开始自增长,每次自增长1。该任务执行的构建总次数),PROJECT_ID(项目编号),WORKSPACE(工作空间,源代码根目录),GIT_TAG(代码tag名,使用tag构建时才有值),JOB_NAME(构建任务名称),EXECUTOR(构建任务执行人),COMMIT_ID_SHORTER(代码提交号的前8位)。

description

String

参数解释

参数描述。

取值范围

不涉及。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/job/system-parameters

响应示例

状态码:200

OK

{
  "result" : [ {
    "id" : 6,
    "parameter_name" : "BUILDNUMBER",
    "description" : "In the format of Date.Builds run on that day"
  }, {
    "id" : 8,
    "parameter_name" : "TIMESTAMP",
    "description" : "Build running timestamp. Example:20190219191621"
  }, {
    "id" : 9,
    "parameter_name" : "INCREASENUM",
    "description" : "Total number of builds. The value starts from 1 and is incremented by 1 each time"
  }, {
    "id" : 10,
    "parameter_name" : "PROJECT_ID",
    "description" : "Project ID"
  }, {
    "id" : 12,
    "parameter_name" : "WORKSPACE",
    "description" : "Root directory of source code"
  }, {
    "id" : 23,
    "parameter_name" : "GIT_TAG",
    "description" : "Tag.The value only exists when using tag build"
  }, {
    "id" : 51,
    "parameter_name" : "JOB_NAME",
    "description" : "Build task name"
  }, {
    "id" : 53,
    "parameter_name" : "EXECUTOR",
    "description" : "The user who runs the build task"
  }, {
    "id" : 69,
    "parameter_name" : "COMMIT_ID_SHORTER",
    "description" : "The first eight of the Commit ID."
  } ],
  "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
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 ShowJobSystemParametersSolution {

    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();
        ShowJobSystemParametersRequest request = new ShowJobSystemParametersRequest();
        try {
            ShowJobSystemParametersResponse response = client.showJobSystemParameters(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
# 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 = ShowJobSystemParametersRequest()
        response = client.show_job_system_parameters(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
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.ShowJobSystemParametersRequest{}
	response, err := client.ShowJobSystemParameters(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

错误码

请参见错误码

相关文档