Show Private Module Metadata

Show Private Module Metadata (ShowPrivateModuleMetadata)

You can use this API to obtain the private module metadata.

Please refer to the ShowPrivateModuleMetadataResponseBody specific returned response. To view all versions of a private module, call ListPrivateModuleVersions.
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.

GET /v1/private-modules/{module_name}/metadata

**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.

**Table 2** Query 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.

**Table 3** 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.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
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_description	String	Description of a private module. It serves as an identifier for you to recognize managed private modules. To update the description of a private module, call the UpdatePrivateModuleMetadata API.
create_time	String	Creation time of a private module. It is represented in UTC format (YYYY-MM-DDTHH:mm:ss.SSSZ), such as 1970-01-01T00:00:00.000Z.
update_time	String	Update time of a private module. It is represented in UTC format (YYYY-MM-DDTHH:mm:ss.SSSZ), such as 1970-01-01T00:00:00.000Z.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
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.

**Table 6** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
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.

**Table 8** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
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.

**Table 10** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
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.

**Table 12** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 429

**Table 13** Response body parameters
Parameter	Type	Description
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.

**Table 14** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
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.

**Table 16** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

None

None

Status Code	Description
200	Private module metadata obtained.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
404	The private module does not exist.
429	Too frequent requests.
500	Internal server error.