Updated on 2024-12-12 GMT+08:00

Show Private Module Version Content

Function

Show the Content of a Private Module Version (ShowPrivateModuleVersionContent)

This API shows the content of a specified private module version.

If the module version content is successfully obtained, a temporary redirection mode is used to return the module download link (OBS presigned address, valid for 5 minutes). Most clients will automatically redirect you to the link for downloading the module.

  • If automatic redirection is not performed, you can obtain the module download link by referring to the HTTP redirection rule and manually download the module.

URI

GET /v1/private-modules/{module_name}/versions/{module_version}

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.

module_version

Yes

String

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

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.

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: 307

Table 4 Response header parameters

Parameter

Type

Description

Location

String

HTTP redirect header. The client can use this header to redirect to a module download link (OBS presigned address, valid for 5 minutes).

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.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

307

The content is obtained. Temporary redirection is successful.

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.