Help Center/ ModelArts/ SDK Reference/ OBS Management/ Downloading a File from OBS

Updated on 2024-03-21 GMT+08:00

View PDF

Downloading a File from OBS

Sample Code

In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

    
         from modelarts.session import Session
session = Session()
session.obs.download_file(src_obs_file="obs://bucket-name/dir1/file1.txt", dst_local_dir="/home/ma-user/")

After the sample code is executed, source file file1.txt is downloaded from OBS to /home/ma-user/file1.txt.

Parameters

**Table 1** Request parameters
Parameter	Mandatory	Type	Description
session	Yes	Object	Session object
src_obs_file	Yes	String	Path to the source file to be downloaded from OBS. The path must start with obs://.
dst_local_dir	Yes	String	Path to the target local folder. The path must end with a slash (/).

**Table 2** Failed response parameters
Parameter	Type	Description
error_code	String	Error code when the API call fails. This parameter is not included when the API call succeeds.
error_msg	String	Error message when the API call fails. This parameter is not included when the API call succeeds.