更新时间:2026-05-06 GMT+08:00
分享

修改分组信息 - UpdateJobGroup

功能介绍

修改分组信息

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

PUT /v1/job/{project_id}/group/update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

CodeArts项目ID。获取方式请参考获取CodeArts项目ID

约束限制

不涉及。

取值范围

32位数字、字母组合的字符串。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

id

String

参数解释

分组ID。

约束限制

不涉及。

取值范围

只能是英文字母和数字,长度为32个字符。

默认取值

不涉及。

name

String

参数解释

分组名称。

约束限制

不涉及。

取值范围

仅支持输入中文、大小写英文字母、数字、'-'、'_',最多128个字符。

默认取值

不涉及。

project_id

String

参数解释

CodeArts项目ID。获取方式请参考获取CodeArts项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

parent_id

String

参数解释

父分组ID。

约束限制

不涉及。

取值范围

只能是英文字母和数字,长度为32个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

Array of result objects

参数解释

返回结果。

取值范围

不涉及。

error

Object

参数解释

返回错误信息。

取值范围

不涉及。

status

String

参数解释

返回状态信息。

取值范围

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

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

表4 result

参数

参数类型

描述

id

String

参数解释

分组ID。

取值范围

只能是英文字母和数字,长度为32个字符。

name

String

参数解释

分组名称。

取值范围

仅支持输入中文、大小写英文字母、数字、'-'、'_',最多128个字符。

project_id

String

参数解释

CodeArts项目ID。获取方式请参考获取CodeArts项目ID

取值范围

不涉及。

parent_id

String

参数解释

父分组ID。

取值范围

只能是英文字母和数字,长度为32个字符。

domain_id

String

参数解释

租户ID。

取值范围

只能是英文字母和数字,长度为32个字符。

ordinal

String

参数解释

分组偏移量。

取值范围

只能是数字。

create_user

String

参数解释

创建分组用户名。

取值范围

不涉及。

update_user

String

参数解释

更新分组用户名。

取值范围

不涉及。

create_time

String

参数解释

分组创建时间。

取值范围

不涉及。

update_time

String

参数解释

分组修改时间。

取值范围

不涉及。

path_id

String

参数解释

分组坐标。

取值范围

不涉及。

job_count

String

参数解释

分组任务数。

取值范围

不涉及。

children

Array of JobGroupResponseBody objects

参数解释

子分组。

取值范围

不涉及。

表5 JobGroupResponseBody

参数

参数类型

描述

result

Array of result objects

参数解释

返回结果。

取值范围

不涉及。

error

Object

参数解释

返回错误信息。

取值范围

不涉及。

status

String

参数解释

返回状态信息。

取值范围

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

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

表6 result

参数

参数类型

描述

id

String

参数解释

分组ID。

取值范围

只能是英文字母和数字,长度为32个字符。

name

String

参数解释

分组名称。

取值范围

仅支持输入中文、大小写英文字母、数字、'-'、'_',最多128个字符。

project_id

String

参数解释

CodeArts项目ID。获取方式请参考获取CodeArts项目ID

取值范围

不涉及。

parent_id

String

参数解释

父分组ID。

取值范围

只能是英文字母和数字,长度为32个字符。

domain_id

String

参数解释

租户ID。

取值范围

只能是英文字母和数字,长度为32个字符。

ordinal

String

参数解释

分组偏移量。

取值范围

只能是数字。

create_user

String

参数解释

创建分组用户名。

取值范围

不涉及。

update_user

String

参数解释

更新分组用户名。

取值范围

不涉及。

create_time

String

参数解释

分组创建时间。

取值范围

不涉及。

update_time

String

参数解释

分组修改时间。

取值范围

不涉及。

path_id

String

参数解释

分组坐标。

取值范围

不涉及。

job_count

String

参数解释

分组任务数。

取值范围

不涉及。

children

Array of JobGroupResponseBody objects

参数解释

子分组。

取值范围

不涉及。

请求示例

PUT https://{endpoint}/v1/job/{project_id}/group/update

{
  "id" : "f907a2e345134c61bf0fb2b7f868131e",
  "name" : "1234"
}

响应示例

状态码:200

OK

{
  "result" : [ {
    "id" : "70e158b6054e442893d7f5a79d34ce61",
    "domain_id" : "60021bab32fd450aa2cb89226f425e06",
    "project_id" : "923785f9674548259144259077bc6a98",
    "name" : "分组测试777",
    "parent_id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
    "path_id" : "b13c933bbc6f4d09a98ef09e4cc07e17.66936fb8ea74472dbe7b05a46a50e62c",
    "ordinal" : 2,
    "create_user" : "test1",
    "update_user" : "test1",
    "create_time" : "2025-06-05T07:31:13+0800",
    "update_time" : "2025-06-09T09:40:58+0800"
  } ],
  "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
47
48
49
50
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 UpdateJobGroupSolution {

    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();
        UpdateJobGroupRequest request = new UpdateJobGroupRequest();
        request.withProjectId("{project_id}");
        JobGroupRequestBody body = new JobGroupRequestBody();
        body.withName("1234");
        body.withId("f907a2e345134c61bf0fb2b7f868131e");
        request.withBody(body);
        try {
            UpdateJobGroupResponse response = client.updateJobGroup(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
33
34
35
# 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 = UpdateJobGroupRequest()
        request.project_id = "{project_id}"
        request.body = JobGroupRequestBody(
            name="1234",
            id="f907a2e345134c61bf0fb2b7f868131e"
        )
        response = client.update_job_group(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
39
40
41
42
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.UpdateJobGroupRequest{}
	request.ProjectId = "{project_id}"
	nameJobGroupRequestBody:= "1234"
	idJobGroupRequestBody:= "f907a2e345134c61bf0fb2b7f868131e"
	request.Body = &model.JobGroupRequestBody{
		Name: &nameJobGroupRequestBody,
		Id: &idJobGroupRequestBody,
	}
	response, err := client.UpdateJobGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档