Obtaining a Bucket Inventory Rule (SDK for C)

Function

The bucket inventory function periodically generates lists of metadata information of objects in a bucket. Inventories help you better understand object statuses in the bucket. You can call this API to obtain a specific inventory rule of a bucket.

Restrictions

• To obtain a bucket inventory rule, you must be the bucket owner or have the required permission (obs:bucket:GetBucketInventoryConfiguration granted using IAM or GetBucketInventoryConfiguration 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

void get_bucket_inventory(const obs_options *options, const char *inventory_id,
    obs_get_bucket_inventory_handler *handler, void *callback_data);

Request Parameters

Sample Code

This example obtains an inventory rule of a bucket.

#include "eSDKOBS.h"
#include <stdio.h>
#include <string.h>
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data);
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
obs_status get_inventory_callback(obs_inventory_configuration *inventory_config, void *callback_data);
typedef struct InventoryInfo {
    obs_status ret_status;
} InventoryInfo;
int main()
{
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    init_obs_options(&options);
    // Enter the endpoint corresponding to the bucket for host_name. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    options.bucket_options.host_name = "obs.ap-southeast-1.myhuaweicloud.com";
    // 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 local environment variables ACCESS_KEY_ID and SECRET_ACCESS_KEY.
    options.bucket_options.access_key = getenv("ACCESS_KEY_ID");
    options.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY");
    options.bucket_options.bucket_name = "example-source-bucket";
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_get_bucket_inventory_handler get_inventory_handler = {
        response_handler,
        &get_inventory_callback
    };
    InventoryInfo inventory_info = {0};
    inventory_info.ret_status = OBS_STATUS_BUTT;
    get_bucket_inventory(&options, "inventory1", &get_inventory_handler, &inventory_info);
    if (OBS_STATUS_OK == inventory_info.ret_status) {
        printf("get bucket inventory successfully.\n");
    } else {
        printf("get bucket inventory failed(%s).\n", obs_get_status_name(inventory_info.ret_status));
    }
    obs_deinitialize();
}
obs_status get_inventory_callback(obs_inventory_configuration *inventory_config, void *callback_data)
{
    if (inventory_config) {
        printf("id: %s\n", inventory_config->id ? inventory_config->id : "");
        printf("schedule: %s\n", inventory_config->schedule ? inventory_config->schedule : "");
        printf("format: %s\n", inventory_config->format ? inventory_config->format : "");
        printf("is_enabled: %s\n", inventory_config->is_enabled ? "true" : "false");
        if (inventory_config->destination && inventory_config->destination->bucket) {
            printf("destination bucket: %s\n", inventory_config->destination->bucket);
        }
    }
    return OBS_STATUS_OK;
}
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    (void)properties; (void)callback_data;
    return OBS_STATUS_OK;
}
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) { ((InventoryInfo*)callback_data)->ret_status = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

Helpful Links

• The API for obtaining a bucket inventory rule
• OBS Error Codes