List Private Module Versions

Function

List Private Module Versions (ListPrivateModuleVersions)

List all versions of the selected private module.

You can use sort_key and sort_dir as keywords to sort the returned results by creation time (create_time). The number of sort_keys must be the same as that of sort_dirs. 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 both module_name and module_id exist, RFS checks whether they match. If they do not match, error code 400 is returned.
If the module does not exist, 404 is returned.
Support pagination. If there is next_marker in the response, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to get the next part of the outputs. You should repeat this until the next_marker response is set to null.

ListPrivateModuleVersions returns only the summary information. (You can obtain details about the summary information by referring to ListPrivateModuleVersionsResponseBody.) For detailed module version metadata, call ShowPrivateModuleVersionMetadata.

URI

GET /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.

**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.
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
marker	No	String	Pagination marker. When a single page cannot return all results, the previous request will return a next_marker to indicate there are more pages. Users can place the value of next_marker here to query information from the next page. This marker can only be used for requests with the same parameters as the previous request. If not specified, the query will start from the first page by default.
limit	No	Integer	The maximum number of results to return per page

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
versions	Array of PrivateModuleVersionSummary objects	A list of private module versions. By default, these module versions are sorted in ascending order of the creation time.
page_info	PageInfo object	Pagination information

**Table 5** PrivateModuleVersionSummary
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_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.

**Table 6** PageInfo
Parameter	Type	Description
next_marker	String	Forward pagination identifier. Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to get the next part of the outputs. You should repeat this until the next_marker response is set to null.
previous_marker	String	Backward pagination identifier.
current_count	Integer	The number of items returned on current page.

Status code: 400

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

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

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

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

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

Status code: 500

**Table 17** 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 18** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Example Requests

Retrieve and sort all versions of the private module named my_module based on their creation time, with the most recent ones appearing first.
```
GET https://{endpoint}/v1/private-modules/my_module/versions
```
Retrieve and sort all versions of the private module named my_module based on their creation time, with the most recent ones appearing first.
```
GET https://{endpoint}/v1/private-modules/my_module/versions?sort_key=create_time&sort_dir=desc
```
Retrieve and sort all versions of the private module named my_module based on their creation time, with the earliest ones appearing first.
```
GET https://{endpoint}/v1/private-modules/my_module/versions?sort_key=create_time&sort_dir=asc
```

Example Responses

Status code: 200

Private module versions metadata obtained.

{
  "versions" : [ {
    "module_name" : "test-limit_vpc_resource-module20241211160209172862",
    "module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b",
    "module_version" : "1.0.1",
    "create_time" : "2024-12-11T08:03:57.747Z"
  }, {
    "module_name" : "test-limit_vpc_resource-module20241211160209172862",
    "module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b",
    "module_version" : "1.0.0",
    "version_description" : "My First Hello World Module Version Description",
    "create_time" : "2024-12-11T08:03:37.417Z"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null,
    "previous_marker" : "zxc1oHc08HcCmypYGTsOoRcvoHUvHRUAW5NOSnc1oHc08HcCPZrwP5NOeTlRiukJgtGxeujJeuGwGIihaIUCmypYGTsOtqvKPr2xmH8fPqpGWyQ0axGwGZp9aqvx8pQ7m5FvGTsJiKk7gtNFiuaxetdRCks="
  }
}

Status Codes

Status Code	Description
200	Private module versions 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.