Modifying an Object
Function
This API modifies the content of an object from the specified position.
Restrictions
- To modify an object, you must be the PFS owner or have the required permission (obs:bucket:PutObject granted using IAM or PutObject granted using a policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Configuring an Object Policy.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
- This API is currently available only for PFSs. For details about how to create a PFS, see Creating a Parallel File System.
Method
obsClient.modifyObject(ModifyObjectRequest request)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| request | Yes | Explanation: Request parameters for modifying an object. For details, see Table 2. |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| bucketName | String | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
| objectKey | String | Yes | Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
| position | long | Yes | Explanation: Position from which the object is modified. Value range: A long integer greater than or equal to 0, in bytes. Default value: None |
| input | InputStream | No | Explanation: Data stream of the object to be uploaded. Default value: None |
| file | File | No | Explanation: Local file to be uploaded. Default value: None |
| encodeHeaders | boolean | No | Explanation: Whether to enable OBS to automatically encode request headers. Due to HTTP coding restrictions, only ASCII characters can be sent. If your request headers contain full-width characters, the SDK will URL encode these characters before sending the request. When you use a browser to access the object metadata, the browser automatically decodes the data. Value range: true: Encoding with SDK is enabled. false: Encoding with SDK is disabled. Default value: true |
Responses
| Parameter | Type | Description |
|---|---|---|
| statusCode | int | Explanation: HTTP status code. Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None |
| responseHeaders | Map<String, Object> | Explanation: Response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None |
Sample Code
This example modifies the content of object objectname at a specified position in PFS examplebucket.
import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.ModifyObjectRequest;
import com.obs.services.model.ModifyObjectResult;
import java.io.ByteArrayInputStream;
public class ModifyObjectDemo {
private static final String TAG = "ModifyObjectDemo";
public void modifyObject() {
// Hard-coded or plaintext AK and SK are risky. For security purposes, encrypt your AK and SK and store them in the configuration file or environment variables. In this example, the AK and SK are stored in environment variables for identity authentication. Before running the code in this example, configure environment variables ACCESS_KEY_ID and SECRET_ACCESS_KEY_ID.
// Obtain an AK/SK pair on the management console.
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY_ID");
// Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use.
String endPoint = "https://your-endpoint";
// Create an ObsClient instance.
ObsClient obsClient = new ObsClient(ak, sk, endPoint);
try {
// The first upload
ModifyObjectRequest request = new ModifyObjectRequest();
request.setBucketName("examplebucket");
request.setObjectKey("objectname");
request.setPosition(0);
request.setInput(new ByteArrayInputStream("HELLO OBS FIRST".getBytes()));
ModifyObjectResult result = obsClient.modifyObject(request);
// The second upload for modification
request.setPosition(0);
request.setInput(new ByteArrayInputStream("hello obs second".getBytes()));
result = obsClient.modifyObject(request);
Log.i(TAG, "modifyObject successfully");
Log.i(TAG, "HTTP Code: " + result.getStatusCode());
} catch (ObsException e) {
Log.e(TAG, "modifyObject failed");
// Request failed. Print the HTTP status code.
Log.e(TAG, "HTTP Code:" + e.getResponseCode());
// Request failed. Print the server-side error code.
Log.e(TAG, "Error Code:" + e.getErrorCode());
// Request failed. Print the error details.
Log.e(TAG, "Error Message:" + e.getErrorMessage());
// Request failed. Print the request ID.
Log.e(TAG, "Request ID:" + e.getErrorRequestId());
Log.e(TAG, "Host ID:" + e.getErrorHostId());
} catch (Exception e) {
Log.e(TAG, "modifyObject failed");
// Print other error information.
Log.e(TAG, e.getMessage());
}
}
} What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot