Updated on 2026-07-21 GMT+08:00

Performing a File-Based Upload

If you have any questions during the development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference.

File-based upload uses local files as the data source of objects.

Prerequisites

Ensure that you have made the following preparations before using the SDK:

  1. You have selected a proper SDK version by referring to Before You Start.
  2. You have downloaded and installed the OBS SDK for .NET by referring to SDK Download Links.

Sample Code

This example uploads local file localfile to bucket bucketname as object objectname.

The sample code is as follows:

// Initialize configuration parameters.
ObsConfig config = new ObsConfig();
config.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.
string accessKey= Environment.GetEnvironmentVariable("AccessKeyID", EnvironmentVariableTarget.Machine);
string secretKey= Environment.GetEnvironmentVariable("SecretAccessKey", EnvironmentVariableTarget.Machine);
// Create an ObsClient instance.
ObsClient client = new ObsClient(accessKey, secretKey, config);
// Upload a file.
try
{
    PutObjectRequest request = new PutObjectRequest()
    {
        BucketName = "bucketname",  //Name of the bucket for storing the file to be uploaded
        ObjectKey = "objectname",   //Name of the file to be uploaded (The file name is the complete path of the file in the bucket, for example, folder/test.txt. The path does not contain the bucket name.)
        FilePath = "localfile",//Path of the local file to be uploaded, in which the file name must be specified
    };
    PutObjectResponse response = client.PutObject(request);
    Console.WriteLine("put object response: {0}", response.StatusCode);
}
catch (ObsException ex)
{
    Console.WriteLine("ErrorCode: {0}", ex.ErrorCode);
    Console.WriteLine("ErrorMessage: {0}", ex.ErrorMessage);
}
  • The content to be uploaded cannot exceed 5 GB.