indexCloudBuckets
Lists all cloud buckets.
**API Key Scope**: cloud_buckets / index
/cloud_buckets
Usage and SDK Samples
curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" -H "Authorization: [[apiKey]]" "http://localhost/api/v2/cloud_buckets?limit=&offset=&sort_by=&id=&cloud_connector_id=&pool_id=&name=&location=&price="
import io.nodeum.sdk.*;
import io.nodeum.sdk.auth.*;
import io.nodeum.sdk.model.*;
import io.nodeum.sdk.api.CloudBucketsApi;
import java.io.File;
import java.util.*;
public class CloudBucketsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: BearerAuth
ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
BearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.setApiKeyPrefix("Token");
CloudBucketsApi apiInstance = new CloudBucketsApi();
Integer limit = 56; // Integer | The number of items to display for pagination.
Integer offset = 56; // Integer | The number of items to skip for pagination.
array[String] sortBy = ; // array[String] | Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
String id = id_example; // String | Filter on id
String cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
String poolId = poolId_example; // String | Filter on a pool id
String name = name_example; // String | Filter on name
String location = location_example; // String | Filter on location
String price = price_example; // String | Filter on price
try {
cloud_bucket_collection result = apiInstance.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CloudBucketsApi#indexCloudBuckets");
e.printStackTrace();
}
}
}
import io.nodeum.sdk.api.CloudBucketsApi;
public class CloudBucketsApiExample {
public static void main(String[] args) {
CloudBucketsApi apiInstance = new CloudBucketsApi();
Integer limit = 56; // Integer | The number of items to display for pagination.
Integer offset = 56; // Integer | The number of items to skip for pagination.
array[String] sortBy = ; // array[String] | Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
String id = id_example; // String | Filter on id
String cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
String poolId = poolId_example; // String | Filter on a pool id
String name = name_example; // String | Filter on name
String location = location_example; // String | Filter on location
String price = price_example; // String | Filter on price
try {
cloud_bucket_collection result = apiInstance.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CloudBucketsApi#indexCloudBuckets");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: BearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *limit = 56; // The number of items to display for pagination. (optional) (default to null)
Integer *offset = 56; // The number of items to skip for pagination. (optional) (default to null)
array[String] *sortBy = ; // Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
String *id = id_example; // Filter on id (optional) (default to null)
String *cloudConnectorId = cloudConnectorId_example; // Filter on cloud connector id (optional) (default to null)
String *poolId = poolId_example; // Filter on a pool id (optional) (default to null)
String *name = name_example; // Filter on name (optional) (default to null)
String *location = location_example; // Filter on location (optional) (default to null)
String *price = price_example; // Filter on price (optional) (default to null)
CloudBucketsApi *apiInstance = [[CloudBucketsApi alloc] init];
// Lists all cloud buckets.
[apiInstance indexCloudBucketsWith:limit
offset:offset
sortBy:sortBy
id:id
cloudConnectorId:cloudConnectorId
poolId:poolId
name:name
location:location
price:price
completionHandler: ^(cloud_bucket_collection output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var NodeumApi = require('nodeum_api');
var defaultClient = NodeumApi.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'
// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"
var api = new NodeumApi.CloudBucketsApi()
var opts = {
'limit': 56, // {Integer} The number of items to display for pagination.
'offset': 56, // {Integer} The number of items to skip for pagination.
'sortBy': , // {array[String]} Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
'id': id_example, // {String} Filter on id
'cloudConnectorId': cloudConnectorId_example, // {String} Filter on cloud connector id
'poolId': poolId_example, // {String} Filter on a pool id
'name': name_example, // {String} Filter on name
'location': location_example, // {String} Filter on location
'price': price_example // {String} Filter on price
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.indexCloudBuckets(opts, callback);
using System;
using System.Diagnostics;
using Io.Nodeum.Sdk.Api;
using Io.Nodeum.Sdk.Client;
using Io.Nodeum.Sdk.Model;
namespace Example
{
public class indexCloudBucketsExample
{
public void main()
{
// Configure HTTP basic authorization: BasicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
// Configure API key authorization: BearerAuth
Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
var apiInstance = new CloudBucketsApi();
var limit = 56; // Integer | The number of items to display for pagination. (optional) (default to null)
var offset = 56; // Integer | The number of items to skip for pagination. (optional) (default to null)
var sortBy = new array[String](); // array[String] | Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
var id = id_example; // String | Filter on id (optional) (default to null)
var cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id (optional) (default to null)
var poolId = poolId_example; // String | Filter on a pool id (optional) (default to null)
var name = name_example; // String | Filter on name (optional) (default to null)
var location = location_example; // String | Filter on location (optional) (default to null)
var price = price_example; // String | Filter on price (optional) (default to null)
try
{
// Lists all cloud buckets.
cloud_bucket_collection result = apiInstance.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling CloudBucketsApi.indexCloudBuckets: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: BearerAuth
NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// NodeumSDK\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$api_instance = new OpenAPITools\Client\Api\CloudBucketsApi();
$limit = 56; // Integer | The number of items to display for pagination.
$offset = 56; // Integer | The number of items to skip for pagination.
$sortBy = ; // array[String] | Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
$id = id_example; // String | Filter on id
$cloudConnectorId = cloudConnectorId_example; // String | Filter on cloud connector id
$poolId = poolId_example; // String | Filter on a pool id
$name = name_example; // String | Filter on name
$location = location_example; // String | Filter on location
$price = price_example; // String | Filter on price
try {
$result = $api_instance->indexCloudBuckets($limit, $offset, $sortBy, $id, $cloudConnectorId, $poolId, $name, $location, $price);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CloudBucketsApi->indexCloudBuckets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Nodeum::SDK::Configuration;
use Nodeum::SDK::CloudBucketsApi;
# Configure HTTP basic authorization: BasicAuth
$Nodeum::SDK::Configuration::username = 'YOUR_USERNAME';
$Nodeum::SDK::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: BearerAuth
$Nodeum::SDK::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Nodeum::SDK::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
my $api_instance = Nodeum::SDK::CloudBucketsApi->new();
my $limit = 56; # Integer | The number of items to display for pagination.
my $offset = 56; # Integer | The number of items to skip for pagination.
my $sortBy = []; # array[String] | Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
my $id = id_example; # String | Filter on id
my $cloudConnectorId = cloudConnectorId_example; # String | Filter on cloud connector id
my $poolId = poolId_example; # String | Filter on a pool id
my $name = name_example; # String | Filter on name
my $location = location_example; # String | Filter on location
my $price = price_example; # String | Filter on price
eval {
my $result = $api_instance->indexCloudBuckets(limit => $limit, offset => $offset, sortBy => $sortBy, id => $id, cloudConnectorId => $cloudConnectorId, poolId => $poolId, name => $name, location => $location, price => $price);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CloudBucketsApi->indexCloudBuckets: $@\n";
}
from __future__ import print_statement
import time
import nodeum-sdk
from nodeum-sdk.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
nodeum-sdk.configuration.username = 'YOUR_USERNAME'
nodeum-sdk.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: BearerAuth
nodeum-sdk.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nodeum-sdk.configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = nodeum-sdk.CloudBucketsApi()
limit = 56 # Integer | The number of items to display for pagination. (optional) (default to null)
offset = 56 # Integer | The number of items to skip for pagination. (optional) (default to null)
sortBy = # array[String] | Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. (optional) (default to null)
id = id_example # String | Filter on id (optional) (default to null)
cloudConnectorId = cloudConnectorId_example # String | Filter on cloud connector id (optional) (default to null)
poolId = poolId_example # String | Filter on a pool id (optional) (default to null)
name = name_example # String | Filter on name (optional) (default to null)
location = location_example # String | Filter on location (optional) (default to null)
price = price_example # String | Filter on price (optional) (default to null)
try:
# Lists all cloud buckets.
api_response = api_instance.index_cloud_buckets(limit=limit, offset=offset, sortBy=sortBy, id=id, cloudConnectorId=cloudConnectorId, poolId=poolId, name=name, location=location, price=price)
pprint(api_response)
except ApiException as e:
print("Exception when calling CloudBucketsApi->indexCloudBuckets: %s\n" % e)
extern crate CloudBucketsApi;
pub fn main() {
let limit = 56; // Integer
let offset = 56; // Integer
let sortBy = ; // array[String]
let id = id_example; // String
let cloudConnectorId = cloudConnectorId_example; // String
let poolId = poolId_example; // String
let name = name_example; // String
let location = location_example; // String
let price = price_example; // String
let mut context = CloudBucketsApi::Context::default();
let result = client.indexCloudBuckets(limit, offset, sortBy, id, cloudConnectorId, poolId, name, location, price, &context).wait();
println!("{:?}", result);
}
Scopes
Parameters
Name | Description |
---|---|
limit |
Integer
The number of items to display for pagination.
|
offset |
Integer
The number of items to skip for pagination.
|
sort_by |
array[String]
Sort results by attribute.
Can sort on multiple attributes, separated by `|`.
Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
id |
String
Filter on id
|
cloud_connector_id |
String
Filter on cloud connector id
|
pool_id |
String
Filter on a pool id
|
name |
String
Filter on name
|
location |
String
Filter on location
|
price |
String
Filter on price
|