Show Private Module Version Metadata

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.

module_version

Yes

String

Module version number. Each version number can be defined by following the semantic versioning format.

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.

Client-Request-Id

Yes

String

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

module_name

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. It is case-sensitive and must start with a letter.

module_id

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.

module_version

String

Module version number. Each version number can be defined by following the semantic versioning format.

version_description

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.

create_time

String

Creation time of a private module version. It is represented in UTC format (YYYY-MM-DDTHH:mm:ss.SSSZ), such as 1970-01-01T00:00:00.000Z.

module_source

String

To make a module available in a template, define its source as follows:

module "my_hello_word_module" {

source = {module_source}

}

{module_source} indicates the source argument.

error_code

String

Response code.

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.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

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.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

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.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

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.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

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.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

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.

error_code

String

Response code.

error_msg

String

Response message.

200

Private module metadata is obtained.

400

Invalid request.

401

Authentication failed.

403

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

404

The module or module version does not exist.

429

Too frequent requests.

500

Internal server error.