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

编辑页获取参数类型的接口

功能介绍

编辑页获取参数类型的接口。

调用方法

请参见如何调用API

URI

GET /v1/job/build-params

请求参数

响应参数

状态码:200

表1 响应Body参数

参数

参数类型

描述

status

String

参数解释

接口响应状态。

取值范围

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

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

error

Object

参数解释

错误信息。

取值范围

不涉及。

result

result object

参数解释

调用接口成功后返回的数据。

取值范围

不涉及。

表2 result

参数

参数类型

描述

build_parameters

Array of BuildParams objects

参数解释

构建参数约束列表。

取值范围

不涉及。

表3 BuildParams

参数

参数类型

描述

name

String

参数解释

参数名。

取值范围

不涉及。

title

String

参数解释

名称。

取值范围

不涉及。

params

Array of Params objects

参数解释

简要构建信息列表。

取值范围

不涉及。

表4 Params

参数

参数类型

描述

name

String

参数解释

参数名。

取值范围

不涉及。

title

String

参数解释

名称。

取值范围

不涉及。

type

String

参数解释

类型。

取值范围

不涉及。

required

Boolean

参数解释

必填。

取值范围

● true:必填。

● false:非必填。

constraints

Array of Constraints objects

参数解释

简要构建信息列表。

取值范围

不涉及。

deletion

Boolean

参数解释

删除。

取值范围

● true:删除。

● false:不删除。

defaults

Boolean

参数解释

默认。

取值范围

● true:默认。

● false:非默认。

表5 Constraints

参数

参数类型

描述

errormsg

String

参数解释

错误信息。

取值范围

长度不能超过128个字符。

type

String

参数解释

类型。

取值范围

不涉及。

value

String

参数解释

参考值。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/job/build-params

响应示例

状态码:200

OK

{
  "result" : {
    "build_parameters" : [ {
      "name" : "hudson.model.StringParameterDefinition",
      "title" : "String Parameters",
      "params" : [ {
        "name" : "name",
        "title" : "Parameter",
        "type" : "text",
        "required" : true,
        "constraints" : [ {
          "type" : "maxLen",
          "value" : "128",
          "errormsg" : "Enter a maximum of 128 characters."
        }, {
          "type" : "minLen",
          "value" : "1",
          "errormsg" : "Enter at least 1 character."
        }, {
          "type" : "regex",
          "value" : "^[a-z0-9A-Z\\_]{1,128}$",
          "errormsg" : "Enter 1 to 128 characters. Only letters (not case-sensitive), digits, and underscores (_) are allowed."
        } ],
        "deletion" : false,
        "defaults" : false
      } ]
    } ]
  },
  "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 ShowBuildParamsListSolution {

    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();
        ShowBuildParamsListRequest request = new ShowBuildParamsListRequest();
        try {
            ShowBuildParamsListResponse response = client.showBuildParamsList(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 = ShowBuildParamsListRequest()
        response = client.show_build_params_list(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.ShowBuildParamsListRequest{}
	response, err := client.ShowBuildParamsList(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

错误码

请参见错误码

相关文档