Deleting Back-to-Source by Mirroring Rules (SDK for Node.js)
Function
This API is used to delete back-to-source by mirroring rules of a bucket.
Restrictions
- To delete the back-to-source by mirroring rules of a bucket, you must be the bucket owner or have the required permission (obs:bucket:DeleteMirrorBackToSource granted using IAM or DeleteMirrorBackToSource granted using a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
Method
ObsClient.deleteBucketMirrorBackToSource(params)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| Bucket | string | Yes | Explanation: Bucket name. Restrictions:
Value range: The value can contain 3 to 63 characters. Default value: None |
Responses
| Type | Description |
|---|---|
| NOTE: This API returns a Promise response, which requires the Promise or async/await syntax. | Explanation: Returned results. For details, see Table 3. |
| Parameter | Type | Description |
|---|---|---|
| CommonMsg | Explanation: Common information generated after an API call is complete, including the HTTP status code and error code. For details, see Table 4. | |
| InterfaceResult | Explanation: Results returned for a successful call. For details, see Table 5. Restrictions: This parameter is left blank if the value of Status is greater than 300. |
| Parameter | Type | Description |
| Status | number | Explanation: HTTP status code returned by the OBS server. Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For details, see Status Codes. |
| Code | string | Explanation: Error code returned by the OBS server. |
| Message | string | Explanation: Error description returned by the OBS server. |
| HostId | string | Explanation: Request server ID returned by the OBS server. |
| RequestId | string | Explanation: Request ID returned by the OBS server. |
| Id2 | string | Explanation: Request ID2 returned by the OBS server. |
| Indicator | string | Explanation: Error code details returned by the OBS server. |
Sample Code
You can call ObsClient.deleteBucketMirrorBackToSource to delete back-to-source by mirroring rules. The sample code is as follows:
// Import the OBS library.
// Use npm for installation.
const ObsClient = require("esdk-obs-nodejs");
// Use the source code for installation.
// var ObsClient = require('./lib/obs');
// Create an ObsClient instance.
const obsClient = new ObsClient({
// Obtain an AK and SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
// 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.
access_key_id: process.env.ACCESS_KEY_ID,
secret_access_key: process.env.SECRET_ACCESS_KEY,
// (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
// security_token: process.env.SECURITY_TOKEN,
// Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});
async function deleteBucketMirrorBackToSource() {
try {
const params = {
// Specify a bucket name.
Bucket: "examplebucket",
};
// Delete back-to-source by mirroring rules.
const result = await obsClient.deleteBucketMirrorBackToSource(params);
if (result.CommonMsg.Status <= 300) {
console.log("Delete bucket mirror back to source successful!\n");
console.log("RequestId: %s", result.CommonMsg.RequestId);
return;
};
console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
console.log("Status: %d", result.CommonMsg.Status);
console.log("Code: %s", result.CommonMsg.Code);
console.log("Message: %s", result.CommonMsg.Message);
console.log("RequestId: %s", result.CommonMsg.RequestId);
} catch (error) {
console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
console.log(error);
};
};
deleteBucketMirrorBackToSource(); 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