Updated on 2026-10-27 GMT+08:00

Updating a Project Module

Function

This API is used to update a project module.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsreq:configuration:update

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

PUT /v4/projects/{project_id}/modules/{module_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID.

Constraints

A string of 32 characters consisting of letters and digits.

Range

N/A

Default Value

N/A

module_id

Yes

Integer

Definition

Module ID, which is the value of id in the response body returned by calling the Querying the Project Module List API.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

The value contains 10 to 32,768 characters.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Definition

Module description.

Constraints

0 to 255 characters.

Range

N/A

Default Value

N/A

module_name

Yes

String

Definition

Module name.

Constraints

0 to 30 characters, excluding the following characters: /\:*?

Range

N/A

Default Value

N/A

owner

Yes

UserRequest object

Definition:

Module owner.

Constraints:

JSON object.

Value range:

N/A

Default value:

N/A

Table 4 UserRequest

Parameter

Mandatory

Type

Description

user_id

Yes

String

Definition

32-character UUID of a user. Obtain the value using the API for obtaining the current user information. The value of user_id in the response body is the 32-character UUID of the user.

Constraints

A string of 32 characters consisting of lowercase letters and digits.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

description

String

Definition:

Module description.

Options:

N/A

module_id

Integer

Definition

Module ID.

Range

N/A

module_name

String

Definition:

Module name.

Options:

N/A

owner

ModuleOwner object

Definition:

Module owner information.

Table 6 ModuleOwner

Parameter

Type

Description

nick_name

String

Definition:

User alias.

Options:

N/A

user_id

String

Definition

User ID, which is a string of 32 characters.

Range

N/A

user_name

String

Definition:

Username.

Options:

N/A

user_num_id

Integer

Definition

Digital ID of a user.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

request_id

String

Definition

Request ID, which is automatically generated by the system.

Range

N/A

Example Requests

PUT https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/modules/662086

{
  "description" : "module demo",
  "module_name" : "demo",
  "owner" : {
    "user_id" : "09d75cde5180d4481f91c018e89cb8e2"
  }
}

Example Responses

Status code: 200

{
  "description" : "module name",
  "module_name" : "demo",
  "module_id" : 46691,
  "owner" : {
    "user_id" : "09d75cde5180d4481f91c018e89cb8e2",
    "user_num_id" : 4091,
    "user_name" : "demo_user_name_06",
    "nick_name" : "demo"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

 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
51
52
53
54
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.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class UpdateProjectModuleSolution {

    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);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateProjectModuleRequest request = new UpdateProjectModuleRequest();
        request.withProjectId("{project_id}");
        request.withModuleId({module_id});
        UpdateProjectModuleRequestBody body = new UpdateProjectModuleRequestBody();
        UserRequest ownerbody = new UserRequest();
        ownerbody.withUserId("09d75cde5180d4481f91c018e89cb8e2");
        body.withOwner(ownerbody);
        body.withModuleName("demo");
        body.withDescription("module demo");
        request.withBody(body);
        try {
            UpdateProjectModuleResponse response = client.updateProjectModule(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 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 = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateProjectModuleRequest()
        request.project_id = "{project_id}"
        request.module_id = {module_id}
        ownerbody = UserRequest(
            user_id="09d75cde5180d4481f91c018e89cb8e2"
        )
        request.body = UpdateProjectModuleRequestBody(
            owner=ownerbody,
            module_name="demo",
            description="module demo"
        )
        response = client.update_project_module(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
51
52
53
54
55
56
57
58
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := projectman.ProjectManClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := projectman.NewProjectManClient(hcClient)

    request := &model.UpdateProjectModuleRequest{}
	request.ProjectId = "{project_id}"
	request.ModuleId = int32({module_id})
	ownerbody := &model.UserRequest{
		UserId: "09d75cde5180d4481f91c018e89cb8e2",
	}
	descriptionUpdateProjectModuleRequestBody:= "module demo"
	request.Body = &model.UpdateProjectModuleRequestBody{
		Owner: ownerbody,
		ModuleName: "demo",
		Description: &descriptionUpdateProjectModuleRequestBody,
	}
	response, err := client.UpdateProjectModule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

Error Codes

See Error Codes.