Help Center/ Resource Formation Service/ API Reference/ API/ Resource Formation - Module Management/ Create a Private Module Version
Updated on 2026-07-06 GMT+08:00
View PDF

Create a Private Module Version

Function

Create a Private Module Version (CreatePrivateModuleVersion)

Create a private module version.

  • The module_version follows the Semantic Versioning specification and is user-customizable. Each component (Major.Minor.Patch) is an unsigned 64-bit integer (uint64).

  • If both module_name and module_id are provided, RFS checks whether they match. If module name does not match the current private module ID, error code 400 is returned.

  • RFS performs validations on private modules, including file size, decompression capability, and number of files. However, it does not perform detailed verification, such as syntax checking.

URI

POST /v1/private-modules/{module_name}/versions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

module_name

Yes

String

Name of a private module. The name is unique within its domain (domain_id) and region. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name is case-sensitive and must start with a letter.

Minimum: 1

Maximum: 128

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Client-Request-Id

Yes

String

A unique request ID is specified by a user to locate a request. UUID is recommended.

Minimum: 36

Maximum: 128
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

module_id

No

String

Unique ID of a private module.

It is a UUID generated by RFS when a module is created.

Private module names are unique only at a specific time, so you can create a private module named HelloWorld and another private module with the same name after deleting the first one.

For parallel development, team members may want to ensure that they are operating the private module they created, not the one with the same name created by other members after deleting the previous one.

To avoid this mismatch, check the ID, since RFS ensures each private module has a unique ID that does not change with updates. If the module_id differs from the current module ID, error code 400 is returned.

Minimum: 36

Maximum: 36

module_version

Yes

String

Module version number. The module_version follows the Semantic Versioning specification and is user-customizable. Each component (Major.Minor.Patch) is an unsigned 64-bit integer (uint64).

Minimum: 5

Maximum: 128

version_description

No

String

Description of a module version. It serves as an identifier for you to recognize and manage module versions. Note: A module version is immutable and cannot have its description updated. You can only delete the current version and create another one with the desired description.

Minimum: 0

Maximum: 1024

module_uri

Yes

String

Address for accessing the module package in OBS. Modules allow you to bundle reusable code together.

The OBS address can be accessed across regions of the same type. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.

The module package must be ZIP-formatted. To ensure the validity of the module package, the module package:

  • Cannot contain files whose names end with ".tfvars" .

  • Cannot exceed 1 MB in size before and after decompression.

  • Cannot contain more than 100 files.

  • Cannot contain file paths starting with a forward slash (/).

  • Disallow spaces (" "), single periods ("."), or double periods ("..") between separators in file paths.

  • Allow each file path to be up to 2048 characters long.

  • Allow each file name to be up to 255 characters long.

  • Must include at least one template file (whose name ends with ".tf" or ".tf.json").

Notes:

  • Modules do not support encryption for sensitive data. The module package associated with the module_uri is used, logged, displayed, and stored in plaintext by RFS.

Minimum: 0

Maximum: 2048

Response Parameters

Status code: 201

The private module version created successfully. No content returned.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 5 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 7 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 9 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 11 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Status code: 409

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 13 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Status code: 429

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 15 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Status code: 500

Table 16 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 11

Maximum: 11

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error information. It is returned by the service when the "permission denied" error occurs.
Table 17 Detail

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

Example Requests

Create a private module version of the user in the current region

POST https://{endpoint}/v1/private-modules/{module_name}/versions

{
  "module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b",
  "module_version" : "1.0.1",
  "module_uri" : "https://integration-test.obs.{region}.huawei.com/mock_zip_template_for_module_service.zip"
}

Example Responses

None

Status Codes

Status Code

Description

201

The private module version created successfully. No content returned.

400

Invalid request.

401

Authentication failed.

403

  1. The user does not have the permission to call this API.

  2. The maximum number of private module versions has been reached.

404

The private module does not exist.

409

Creation request conflict. The specified private module version already exists.

429

Too frequent requests.

500

Internal server error.