List Private Modules

Function

List Private Modules (ListPrivateModules)

This API lists all your private modules of the current account (domain) at the current region.

You can use sort_key and sort_dir as keywords to sort the returned results by creation time (create_time). The number of sort_key values must be the same as that of sort_dir values. Otherwise, error code 400 is returned. If sort_key and sort_dir are not assigned, results are sorted by creation time in descending order by default.
If there is no private module, an empty list will be returned.
To query all versions of a module, call ListModuleVersions.

ListPrivateModules returns only the summary information. (You can obtain details about the summary information by referring to ListPrivateModulesResponseBody.) For detailed module metadata, call ShowPrivateModuleMetadata.

URI

GET /v1/private-modules

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
sort_key	No	Array of strings	Sorting field. Only create_time is supported.
sort_dir	No	Array of strings	Specify an ascending or descending order. asc: ascending order desc: descending order

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
modules	Array of PrivateModuleSummary objects	A list of private modules. By default, these modules are sorted in ascending order of the creation time.

**Table 4** PrivateModuleSummary
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: 429

**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: 500

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

Example Requests

This API retrieves and sorts all private modules of the user in the current region based on their creation time, with the most recent ones appearing first.
```
GET https://{endpoint}/v1/private-modules
```
This API retrieves and sorts all private modules of the user in the current region based on their creation time, with the most recent ones appearing first.
```
GET https://{endpoint}/v1/private-modules?sort_key=create_time&sort_dir=desc
```
This API retrieves and sorts all private modules of the user in the current region based on their creation time, with the earliest ones appearing first.
```
GET https://{endpoint}/v1/private-modules?sort_key=create_time&sort_dir=asc
```

Example Responses

None

Status Codes

Status Code	Description
200	Private modules are listed.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
429	Too frequent requests.
500	Internal server error.