Performing a File-based Upload

Prerequisites

Ensure that you have selected a proper SDK version by referring to SDK Download Links and have downloaded and installed the SDK.

Sample Code

File-based upload uses local files as the data source of objects. Sample code is as follows:

static OBSClient *client;
NSString *endPoint = @"https://your-endpoint";

// Hard-coded or plaintext AK and SK are risky. For security purposes, encrypt your AK and SK before storing them in the configuration file or environment variables. In this example, the AK and SK are stored in environment variables. Before running the code in this example, configure environment variables AccessKeyID and SecretAccessKey.
// Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
char* ak_env = getenv("AccessKeyID");
char* sk_env = getenv("SecretAccessKey");
if (ak_env == NULL || sk_env == NULL) {
    NSLog(@"Error: AccessKeyID or SecretAccessKey environment variable not set");
    return;
}
NSString *AK = [NSString stringWithUTF8String:ak_env];
NSString *SK = [NSString stringWithUTF8String:sk_env];

// Initialize identity authentication.
OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK];
    
// Initialize service configuration.
OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider];
    
// Initialize the client.
client = [[OBSClient alloc] initWithConfiguration:conf];
// Specify the name and type of the file to be uploaded.
NSString *filePath = [[NSBundle mainBundle]pathForResource:@"fileName" ofType:@"Type"];
// Upload a file.
OBSPutObjectWithFileRequest *request = [[OBSPutObjectWithFileRequest alloc]initWithBucketName:@"bucket-ios-test02" objectKey:@"imageWithFile" uploadFilePath:filePath];
// Enable background upload. When an application is switched to the background, the ongoing upload continues.
request.background = YES; 
    
// Query the upload progress.
request.uploadProgressBlock = ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) {
    NSLog(@"%0.1f%%",(float)floor((totalBytesExpectedToSend > 0) ? (totalBytesSent*10000/totalBytesExpectedToSend) : 0)/100);
};
    
[client putObject:request completionHandler:^(OBSPutObjectResponse *response, NSError *error){
    // Determine the error status.
    if(error){
        // Print error information.
        NSLog(@"File upload failed.");
        NSLog(@"%@",error);
    }
    // If the file is successfully uploaded, the status code 200 is returned and the response value is printed.
    if([response.statusCode isEqualToString:@"200"]){
        NSLog(@"The file is successfully uploaded.");
        NSLog(@"%@",response);
        if(response.etag){NSLog(@"%@",response.etag);}
    } 
}];

In the current SDK, the uploadFilePath parameter of the file upload APIs (OBSPutObjectWithFileRequest and OBSUploadFileRequest) only accepts file paths of the NSString type. Directly passing an NSURL object created with [NSURL fileURLWithPath:@"xxx"] is not supported. To use NSURL, obtain the file path string through [fileURL path] and then pass it to the uploadFilePath parameter.

The content to be uploaded cannot exceed 5 GB.

When background is set to YES, background upload is enabled.