API Reference

Muramasa : Teracloud web engine v2.0

Dataset

deleteDataset

データセットの削除

DELETE /v2/api/dataset/[データセット名][;MatrixParameter] データセットを削除する。削除したデータセットは二度と戻らないため、要注意。 # URL例 DELETE /v2/api/dataset/backup # 戻り値 ## JSONフォーマット { "result": 0, } - result リザルトコード。成功したら0。それ以外は内部エラーコード。


/v2/api/dataset/{datasetname}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/dataset/{datasetname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetApi;

import java.io.File;
import java.util.*;

public class DatasetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String recursive = recursive_example; // String | データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.deleteDataset(datasetname, recursive);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#deleteDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetApi;

public class DatasetApiExample {

    public static void main(String[] args) {
        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String recursive = recursive_example; // String | データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.deleteDataset(datasetname, recursive);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#deleteDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // **必須:** データセット名 (default to null)
String *recursive = recursive_example; // データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

DatasetApi *apiInstance = [[DatasetApi alloc] init];

// データセットの削除
[apiInstance deleteDatasetWith:datasetname
    recursive:recursive
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.DatasetApi()
var datasetname = datasetname_example; // {String} **必須:** データセット名
var recursive = recursive_example; // {String} データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataset(datasetname, recursive, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDatasetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new DatasetApi();
            var datasetname = datasetname_example;  // String | **必須:** データセット名 (default to null)
            var recursive = recursive_example;  // String | データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

            try
            {
                // データセットの削除
                apiInstance.deleteDataset(datasetname, recursive);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasetApi.deleteDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\DatasetApi();
$datasetname = datasetname_example; // String | **必須:** データセット名
$recursive = recursive_example; // String | データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。

try {
    $api_instance->deleteDataset($datasetname, $recursive);
} catch (Exception $e) {
    echo 'Exception when calling DatasetApi->deleteDataset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DatasetApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::DatasetApi->new();
my $datasetname = datasetname_example; # String | **必須:** データセット名
my $recursive = recursive_example; # String | データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。

eval { 
    $api_instance->deleteDataset(datasetname => $datasetname, recursive => $recursive);
};
if ($@) {
    warn "Exception when calling DatasetApi->deleteDataset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.DatasetApi()
datasetname = datasetname_example # String | **必須:** データセット名 (default to null)
recursive = recursive_example # String | データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

try: 
    # データセットの削除
    api_instance.delete_dataset(datasetname, recursive)
except ApiException as e:
    print("Exception when calling DatasetApi->deleteDataset: %s\n" % e)
extern crate DatasetApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let recursive = recursive_example; // String

    let mut context = DatasetApi::Context::default();
    let result = client.deleteDataset(datasetname, recursive, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
**必須:** データセット名
recursive
String
データセットの子要素(スナップショットや下位の層)を同時に消去する。リカーシブで削除したデータセットは、二度と戻らないので要注意、デフォルト無効。true、TRUE、1で有効にする。

Responses


getDataset

データセットのリスト取得(表示用途向け)

GET /v2/api/dataset/[データセット名][;MatrixParameter] データセットの一覧を出力する。リカーシブ指定で下位のものも処理できる。 # URL例 GET /v2/api/dataset/backup;type=all;recursive=true # 特徴 - リスト型で返される # 留意点 - 若干遅い - 数字系は丸められている - XML型の要求ができない # 戻り値 ## JSONフォーマット { "result": 0, "data": [ [ "backup/15", "backup/15", "none", "162K", "33.5K", "0", "Tue Nov 13 16:54 2018", "yes", "on", "1.02x", "filesystem", "33.5K", "guest@MacBook Pro (Retina, 15-inch, Mid 2015)(2018年11月15日開始のバックアップ)" ], [ "backup/15@2018-11-27T103752_775Z", "-", "-", "0", "-", "-", "Tue Nov 27 19:37 2018", "-", "-", "1.00x", "snapshot", "31K", "" ], ], "meta": [ "name", "mountpoint", "quota", "used", "usedbydataset", "usedbysnapshots", "creation", "mounted", "canmount", "compressratio", "type", "referenced", "description" ] } - meta メタ情報を記述する。現在は固定でArrayListにならんだパラメタが帰ってくる。将来、ある程度、任意のパラメタを取得できるようになるかもしれない。 - data データの実体がArrayListの二元で返す。複数存在する場合を加味している。 - result リザルトコード。まだコマンドラインの出力結果をそのままバケツリレーしてるだけ。


/v2/api/dataset/{datasetname}

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/dataset/{datasetname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetApi;

import java.io.File;
import java.util.*;

public class DatasetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String type = type_example; // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
        String recursive = recursive_example; // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
        String depth = depth_example; // String | 親データセットから何階層潜るかを数値で指定
        String properties = properties_example; // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]
        try {
            apiInstance.getDataset(datasetname, type, recursive, depth, properties);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#getDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetApi;

public class DatasetApiExample {

    public static void main(String[] args) {
        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String type = type_example; // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
        String recursive = recursive_example; // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
        String depth = depth_example; // String | 親データセットから何階層潜るかを数値で指定
        String properties = properties_example; // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]
        try {
            apiInstance.getDataset(datasetname, type, recursive, depth, properties);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#getDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // **必須:** データセット名 (default to null)
String *type = type_example; // 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。 (default to null)
String *recursive = recursive_example; // 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)
String *depth = depth_example; // 親データセットから何階層潜るかを数値で指定 (default to null)
String *properties = properties_example; // 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced] (default to null)

DatasetApi *apiInstance = [[DatasetApi alloc] init];

// データセットのリスト取得(表示用途向け)
[apiInstance getDatasetWith:datasetname
    type:type
    recursive:recursive
    depth:depth
    properties:properties
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.DatasetApi()
var datasetname = datasetname_example; // {String} **必須:** データセット名
var type = type_example; // {String} 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
var recursive = recursive_example; // {String} 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
var depth = depth_example; // {String} 親データセットから何階層潜るかを数値で指定
var properties = properties_example; // {String} 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDataset(datasetname, type, recursive, depth, properties, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDatasetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new DatasetApi();
            var datasetname = datasetname_example;  // String | **必須:** データセット名 (default to null)
            var type = type_example;  // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。 (default to null)
            var recursive = recursive_example;  // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)
            var depth = depth_example;  // String | 親データセットから何階層潜るかを数値で指定 (default to null)
            var properties = properties_example;  // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced] (default to null)

            try
            {
                // データセットのリスト取得(表示用途向け)
                apiInstance.getDataset(datasetname, type, recursive, depth, properties);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasetApi.getDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\DatasetApi();
$datasetname = datasetname_example; // String | **必須:** データセット名
$type = type_example; // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
$recursive = recursive_example; // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
$depth = depth_example; // String | 親データセットから何階層潜るかを数値で指定
$properties = properties_example; // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

try {
    $api_instance->getDataset($datasetname, $type, $recursive, $depth, $properties);
} catch (Exception $e) {
    echo 'Exception when calling DatasetApi->getDataset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DatasetApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::DatasetApi->new();
my $datasetname = datasetname_example; # String | **必須:** データセット名
my $type = type_example; # String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
my $recursive = recursive_example; # String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
my $depth = depth_example; # String | 親データセットから何階層潜るかを数値で指定
my $properties = properties_example; # String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

eval { 
    $api_instance->getDataset(datasetname => $datasetname, type => $type, recursive => $recursive, depth => $depth, properties => $properties);
};
if ($@) {
    warn "Exception when calling DatasetApi->getDataset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.DatasetApi()
datasetname = datasetname_example # String | **必須:** データセット名 (default to null)
type = type_example # String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。 (default to null)
recursive = recursive_example # String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)
depth = depth_example # String | 親データセットから何階層潜るかを数値で指定 (default to null)
properties = properties_example # String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced] (default to null)

try: 
    # データセットのリスト取得(表示用途向け)
    api_instance.get_dataset(datasetname, type, recursive, depth, properties)
except ApiException as e:
    print("Exception when calling DatasetApi->getDataset: %s\n" % e)
extern crate DatasetApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let type = type_example; // String
    let recursive = recursive_example; // String
    let depth = depth_example; // String
    let properties = properties_example; // String

    let mut context = DatasetApi::Context::default();
    let result = client.getDataset(datasetname, type, recursive, depth, properties, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
**必須:** データセット名
type
String
出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
recursive
String
子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
depth
String
親データセットから何階層潜るかを数値で指定
properties
String
取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

Responses


getDatasetProperty

データセットのプロパティの取得(詳細取得向け)

GET /v2/api/dataset/[データセット名][;MatrixParameter]/(property) # 特徴 - 値が細かい - 数値が丸められていない - XML型の要求ができる # 留意点 - まとめて取ることができない # 戻り値 ## JSONフォーマット ```json { "result": 0, "dataset": { "backup/15": { "canmount": "on", "usedbydataset": 34304, "referenced": 34304, "quota": 0, "name": "backup/15", "usedbysnapshots": 0, "used": 165376, "compressratio": "1.02x", "type": "filesystem", "mounted": "yes", "creation": 1542095666, "mountpoint": "backup/15" } } } ``` ## XMLフォーマット ```xml <TeraCLOUDObject> <result>0</result> <dataset> <backup/15> <canmount>on</canmount> <usedbydataset>34304</usedbydataset> <referenced>34304</referenced> <quota>0</quota> <name>backup/15</name> <usedbysnapshots>0</usedbysnapshots> <used>165376</used> <compressratio>1.02x</compressratio> <type>filesystem</type> <mounted>yes</mounted> <creation>1542095666</creation> <mountpoint>backup/15</mountpoint> </backup/15> </dataset> </TeraCLOUDObject> ```


/v2/api/dataset/{datasetname}/(property)

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/dataset/{datasetname}/(property)"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetApi;

import java.io.File;
import java.util.*;

public class DatasetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String type = type_example; // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
        String recursive = recursive_example; // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
        String depth = depth_example; // String | 親データセットから何階層潜るかを数値で指定
        String properties = properties_example; // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]
        try {
            apiInstance.getDatasetProperty(datasetname, type, recursive, depth, properties);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#getDatasetProperty");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetApi;

public class DatasetApiExample {

    public static void main(String[] args) {
        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String type = type_example; // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
        String recursive = recursive_example; // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
        String depth = depth_example; // String | 親データセットから何階層潜るかを数値で指定
        String properties = properties_example; // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]
        try {
            apiInstance.getDatasetProperty(datasetname, type, recursive, depth, properties);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#getDatasetProperty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // **必須:** データセット名 (default to null)
String *type = type_example; // 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。 (default to null)
String *recursive = recursive_example; // 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)
String *depth = depth_example; // 親データセットから何階層潜るかを数値で指定 (default to null)
String *properties = properties_example; // 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced] (default to null)

DatasetApi *apiInstance = [[DatasetApi alloc] init];

// データセットのプロパティの取得(詳細取得向け)
[apiInstance getDatasetPropertyWith:datasetname
    type:type
    recursive:recursive
    depth:depth
    properties:properties
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.DatasetApi()
var datasetname = datasetname_example; // {String} **必須:** データセット名
var type = type_example; // {String} 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
var recursive = recursive_example; // {String} 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
var depth = depth_example; // {String} 親データセットから何階層潜るかを数値で指定
var properties = properties_example; // {String} 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDatasetProperty(datasetname, type, recursive, depth, properties, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDatasetPropertyExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new DatasetApi();
            var datasetname = datasetname_example;  // String | **必須:** データセット名 (default to null)
            var type = type_example;  // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。 (default to null)
            var recursive = recursive_example;  // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)
            var depth = depth_example;  // String | 親データセットから何階層潜るかを数値で指定 (default to null)
            var properties = properties_example;  // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced] (default to null)

            try
            {
                // データセットのプロパティの取得(詳細取得向け)
                apiInstance.getDatasetProperty(datasetname, type, recursive, depth, properties);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasetApi.getDatasetProperty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\DatasetApi();
$datasetname = datasetname_example; // String | **必須:** データセット名
$type = type_example; // String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
$recursive = recursive_example; // String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
$depth = depth_example; // String | 親データセットから何階層潜るかを数値で指定
$properties = properties_example; // String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

try {
    $api_instance->getDatasetProperty($datasetname, $type, $recursive, $depth, $properties);
} catch (Exception $e) {
    echo 'Exception when calling DatasetApi->getDatasetProperty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DatasetApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::DatasetApi->new();
my $datasetname = datasetname_example; # String | **必須:** データセット名
my $type = type_example; # String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
my $recursive = recursive_example; # String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
my $depth = depth_example; # String | 親データセットから何階層潜るかを数値で指定
my $properties = properties_example; # String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

eval { 
    $api_instance->getDatasetProperty(datasetname => $datasetname, type => $type, recursive => $recursive, depth => $depth, properties => $properties);
};
if ($@) {
    warn "Exception when calling DatasetApi->getDatasetProperty: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.DatasetApi()
datasetname = datasetname_example # String | **必須:** データセット名 (default to null)
type = type_example # String | 出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。 (default to null)
recursive = recursive_example # String | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)
depth = depth_example # String | 親データセットから何階層潜るかを数値で指定 (default to null)
properties = properties_example # String | 取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced] (default to null)

try: 
    # データセットのプロパティの取得(詳細取得向け)
    api_instance.get_dataset_property(datasetname, type, recursive, depth, properties)
except ApiException as e:
    print("Exception when calling DatasetApi->getDatasetProperty: %s\n" % e)
extern crate DatasetApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let type = type_example; // String
    let recursive = recursive_example; // String
    let depth = depth_example; // String
    let properties = properties_example; // String

    let mut context = DatasetApi::Context::default();
    let result = client.getDatasetProperty(datasetname, type, recursive, depth, properties, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
**必須:** データセット名
type
String
出力するタイプ。all、filesystem、snapshotのいずれか。デフォルトはfilesystem。
recursive
String
子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
depth
String
親データセットから何階層潜るかを数値で指定
properties
String
取得するプロパティをカンマ区切りで明示指定。未指定の場合は[name,mountpoint,quota,used,usedbydataset,usedbysnapshots,creation,mounted,canmount,compressratio,type,referenced]

Responses


putDataset

データセットの作成

PUT /v2/api/dataset/[データセット名][;MatrixParameter]


/v2/api/dataset/{datasetname}

Usage and SDK Samples

curl -X PUT -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/dataset/{datasetname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetApi;

import java.io.File;
import java.util.*;

public class DatasetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String parent = parent_example; // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.putDataset(datasetname, parent);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#putDataset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetApi;

public class DatasetApiExample {

    public static void main(String[] args) {
        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String parent = parent_example; // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.putDataset(datasetname, parent);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#putDataset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // **必須:** データセット名 (default to null)
String *parent = parent_example; // 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

DatasetApi *apiInstance = [[DatasetApi alloc] init];

// データセットの作成
[apiInstance putDatasetWith:datasetname
    parent:parent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.DatasetApi()
var datasetname = datasetname_example; // {String} **必須:** データセット名
var parent = parent_example; // {String} 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putDataset(datasetname, parent, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putDatasetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new DatasetApi();
            var datasetname = datasetname_example;  // String | **必須:** データセット名 (default to null)
            var parent = parent_example;  // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

            try
            {
                // データセットの作成
                apiInstance.putDataset(datasetname, parent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasetApi.putDataset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\DatasetApi();
$datasetname = datasetname_example; // String | **必須:** データセット名
$parent = parent_example; // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

try {
    $api_instance->putDataset($datasetname, $parent);
} catch (Exception $e) {
    echo 'Exception when calling DatasetApi->putDataset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DatasetApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::DatasetApi->new();
my $datasetname = datasetname_example; # String | **必須:** データセット名
my $parent = parent_example; # String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

eval { 
    $api_instance->putDataset(datasetname => $datasetname, parent => $parent);
};
if ($@) {
    warn "Exception when calling DatasetApi->putDataset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.DatasetApi()
datasetname = datasetname_example # String | **必須:** データセット名 (default to null)
parent = parent_example # String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

try: 
    # データセットの作成
    api_instance.put_dataset(datasetname, parent)
except ApiException as e:
    print("Exception when calling DatasetApi->putDataset: %s\n" % e)
extern crate DatasetApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let parent = parent_example; // String

    let mut context = DatasetApi::Context::default();
    let result = client.putDataset(datasetname, parent, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
**必須:** データセット名
parent
String
子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

Responses


putDatasetUnique

データセットの作成(ユニーク版)

PUT /v2/api/dataset/[データセット名][;MatrixParameter]/(unique) ユニークなデータセットを作成する。 データセット名にランダムなメタキャラクタ、%を入れることで、そこにランダムの文字列が入る。%の数はいくつ設置しても構わない。ただし、%はURLエンコードして送る必要がある。 PUT dataset/(unique)はデータセット名に%を入れることでユニークなDatasetの作成を試みる。もしも、たまたま、すでに存在する名前のdataset名に出会った場合、%のキャラクタを入れ替えてチャレンジを行い、ユニーク性を確保しようとする。 規定の回数、ランダム文字列が重なってしまった場合は、HTTP応答の409 CONFLICTEDを返す。 # 戻り値 ## JSONフォーマット { "result": 0, "dataset": backup } - result リザルトコード。成功したら0。それ以外は内部エラーコード。 - dataset データセット名。


/v2/api/dataset/{datasetname}/(unique)

Usage and SDK Samples

curl -X PUT -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/dataset/{datasetname}/(unique)"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatasetApi;

import java.io.File;
import java.util.*;

public class DatasetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String parent = parent_example; // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.putDatasetUnique(datasetname, parent);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#putDatasetUnique");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DatasetApi;

public class DatasetApiExample {

    public static void main(String[] args) {
        DatasetApi apiInstance = new DatasetApi();
        String datasetname = datasetname_example; // String | **必須:** データセット名
        String parent = parent_example; // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.putDatasetUnique(datasetname, parent);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasetApi#putDatasetUnique");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // **必須:** データセット名 (default to null)
String *parent = parent_example; // 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

DatasetApi *apiInstance = [[DatasetApi alloc] init];

// データセットの作成(ユニーク版)
[apiInstance putDatasetUniqueWith:datasetname
    parent:parent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.DatasetApi()
var datasetname = datasetname_example; // {String} **必須:** データセット名
var parent = parent_example; // {String} 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putDatasetUnique(datasetname, parent, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putDatasetUniqueExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new DatasetApi();
            var datasetname = datasetname_example;  // String | **必須:** データセット名 (default to null)
            var parent = parent_example;  // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

            try
            {
                // データセットの作成(ユニーク版)
                apiInstance.putDatasetUnique(datasetname, parent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasetApi.putDatasetUnique: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\DatasetApi();
$datasetname = datasetname_example; // String | **必須:** データセット名
$parent = parent_example; // String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

try {
    $api_instance->putDatasetUnique($datasetname, $parent);
} catch (Exception $e) {
    echo 'Exception when calling DatasetApi->putDatasetUnique: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DatasetApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::DatasetApi->new();
my $datasetname = datasetname_example; # String | **必須:** データセット名
my $parent = parent_example; # String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

eval { 
    $api_instance->putDatasetUnique(datasetname => $datasetname, parent => $parent);
};
if ($@) {
    warn "Exception when calling DatasetApi->putDatasetUnique: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.DatasetApi()
datasetname = datasetname_example # String | **必須:** データセット名 (default to null)
parent = parent_example # String | 子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

try: 
    # データセットの作成(ユニーク版)
    api_instance.put_dataset_unique(datasetname, parent)
except ApiException as e:
    print("Exception when calling DatasetApi->putDatasetUnique: %s\n" % e)
extern crate DatasetApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let parent = parent_example; // String

    let mut context = DatasetApi::Context::default();
    let result = client.putDatasetUnique(datasetname, parent, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
**必須:** データセット名
parent
String
子のデータセットも含め作成する、デフォルト無効。true、TRUE、1で有効にする。

Responses


Fileproperties

getFileProperties

ファイルプロパティの取得

GET /v2/api/fileproperties/ファイルパス名[;MatrixParameter] ファイルプロパティの取得する。Length、LastModifiedだけでなく、引数を指定することでExifなどで作られたメディア情報を取得することもできる。 # 戻り値(EXIFを含む) ## JSONフォーマット ```json { "result": 0, "images/exif/Canon_DIGITAL_IXUS_400.jpg": { "LastModified": 1543840012000, "ExifIFD0": { "Date/Time": 1217524501000, "Model": "Canon DIGITAL IXUS 400", "Make": "Canon" }, "ExifSubIFD": { "FocalLength": "247/16", "ExposureTime": "1/200", "F-Number": "10", "ExposureBias": "0" }, "IMAGE": { "Height": 75, "Width": 100 }, "Length": 9198, "FileName": "images/exif/Canon_DIGITAL_IXUS_400.jpg" } } ``` ## XMLフォーマット ```xml <TeraCLOUDObject> <result>0</result> <images/exif/Canon_DIGITAL_IXUS_400.jpg> <LastModified>1543840012000</LastModified> <ExifIFD0> <Date/Time>1217524501000</Date/Time> <Model>Canon DIGITAL IXUS 400</Model> <Make>Canon</Make> </ExifIFD0> <ExifSubIFD> <FocalLength>247/16</FocalLength> <ExposureTime>1/200</ExposureTime> <F-Number>10</F-Number> <ExposureBias>0</ExposureBias> </ExifSubIFD> <IMAGE> <Height>75</Height> <Width>100</Width> </IMAGE> <Length>9198</Length> <FileName>images/exif/Canon_DIGITAL_IXUS_400.jpg</FileName> </images/exif/Canon_DIGITAL_IXUS_400.jpg> </TeraCLOUDObject> ```


/v2/api/fileproperties/{pathname}

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/fileproperties/{pathname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilepropertiesApi;

import java.io.File;
import java.util.*;

public class FilepropertiesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        FilepropertiesApi apiInstance = new FilepropertiesApi();
        String pathname = pathname_example; // String | **必須:** ファイルパス名
        Integer depth = 56; // Integer | 親データセットから何階層潜るかを数値で指定
        Boolean exif = true; // Boolean | exifの取得。
        Boolean recursive = true; // Boolean | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.getFileProperties(pathname, depth, exif, recursive);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilepropertiesApi#getFileProperties");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FilepropertiesApi;

public class FilepropertiesApiExample {

    public static void main(String[] args) {
        FilepropertiesApi apiInstance = new FilepropertiesApi();
        String pathname = pathname_example; // String | **必須:** ファイルパス名
        Integer depth = 56; // Integer | 親データセットから何階層潜るかを数値で指定
        Boolean exif = true; // Boolean | exifの取得。
        Boolean recursive = true; // Boolean | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。
        try {
            apiInstance.getFileProperties(pathname, depth, exif, recursive);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilepropertiesApi#getFileProperties");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *pathname = pathname_example; // **必須:** ファイルパス名 (default to null)
Integer *depth = 56; // 親データセットから何階層潜るかを数値で指定 (default to null)
Boolean *exif = true; // exifの取得。 (default to null)
Boolean *recursive = true; // 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

FilepropertiesApi *apiInstance = [[FilepropertiesApi alloc] init];

// ファイルプロパティの取得
[apiInstance getFilePropertiesWith:pathname
    depth:depth
    exif:exif
    recursive:recursive
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.FilepropertiesApi()
var pathname = pathname_example; // {String} **必須:** ファイルパス名
var depth = 56; // {Integer} 親データセットから何階層潜るかを数値で指定
var exif = true; // {Boolean} exifの取得。
var recursive = true; // {Boolean} 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getFileProperties(pathname, depth, exif, recursive, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFilePropertiesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new FilepropertiesApi();
            var pathname = pathname_example;  // String | **必須:** ファイルパス名 (default to null)
            var depth = 56;  // Integer | 親データセットから何階層潜るかを数値で指定 (default to null)
            var exif = true;  // Boolean | exifの取得。 (default to null)
            var recursive = true;  // Boolean | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

            try
            {
                // ファイルプロパティの取得
                apiInstance.getFileProperties(pathname, depth, exif, recursive);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilepropertiesApi.getFileProperties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\FilepropertiesApi();
$pathname = pathname_example; // String | **必須:** ファイルパス名
$depth = 56; // Integer | 親データセットから何階層潜るかを数値で指定
$exif = true; // Boolean | exifの取得。
$recursive = true; // Boolean | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。

try {
    $api_instance->getFileProperties($pathname, $depth, $exif, $recursive);
} catch (Exception $e) {
    echo 'Exception when calling FilepropertiesApi->getFileProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilepropertiesApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::FilepropertiesApi->new();
my $pathname = pathname_example; # String | **必須:** ファイルパス名
my $depth = 56; # Integer | 親データセットから何階層潜るかを数値で指定
my $exif = true; # Boolean | exifの取得。
my $recursive = true; # Boolean | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。

eval { 
    $api_instance->getFileProperties(pathname => $pathname, depth => $depth, exif => $exif, recursive => $recursive);
};
if ($@) {
    warn "Exception when calling FilepropertiesApi->getFileProperties: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.FilepropertiesApi()
pathname = pathname_example # String | **必須:** ファイルパス名 (default to null)
depth = 56 # Integer | 親データセットから何階層潜るかを数値で指定 (default to null)
exif = true # Boolean | exifの取得。 (default to null)
recursive = true # Boolean | 子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。 (default to null)

try: 
    # ファイルプロパティの取得
    api_instance.get_file_properties(pathname, depth, exif, recursive)
except ApiException as e:
    print("Exception when calling FilepropertiesApi->getFileProperties: %s\n" % e)
extern crate FilepropertiesApi;

pub fn main() {
    let pathname = pathname_example; // String
    let depth = 56; // Integer
    let exif = true; // Boolean
    let recursive = true; // Boolean

    let mut context = FilepropertiesApi::Context::default();
    let result = client.getFileProperties(pathname, depth, exif, recursive, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
pathname
String
**必須:** ファイルパス名
depth
Integer (int32)
親データセットから何階層潜るかを数値で指定
exif
Boolean
exifの取得。
recursive
Boolean
子の項目に対しても再帰的に処理、デフォルト無効。true、TRUE、1で有効にする。

Responses


Snapshots

deleteSnapshot

スナップショットの削除

PUT /v2/api/dataset/[データセット名]@スナップショット名[;MatrixParameter]


/v2/api/snapshot/{datasetname}@{snapshotname}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/snapshot/{datasetname}@{snapshotname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SnapshotsApi;

import java.io.File;
import java.util.*;

public class SnapshotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        SnapshotsApi apiInstance = new SnapshotsApi();
        String datasetname = datasetname_example; // String | データセット名
        String snapshotname = snapshotname_example; // String | **必須:** スナップショット名
        try {
            apiInstance.deleteSnapshot(datasetname, snapshotname);
        } catch (ApiException e) {
            System.err.println("Exception when calling SnapshotsApi#deleteSnapshot");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SnapshotsApi;

public class SnapshotsApiExample {

    public static void main(String[] args) {
        SnapshotsApi apiInstance = new SnapshotsApi();
        String datasetname = datasetname_example; // String | データセット名
        String snapshotname = snapshotname_example; // String | **必須:** スナップショット名
        try {
            apiInstance.deleteSnapshot(datasetname, snapshotname);
        } catch (ApiException e) {
            System.err.println("Exception when calling SnapshotsApi#deleteSnapshot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // データセット名 (default to null)
String *snapshotname = snapshotname_example; // **必須:** スナップショット名 (default to null)

SnapshotsApi *apiInstance = [[SnapshotsApi alloc] init];

// スナップショットの削除
[apiInstance deleteSnapshotWith:datasetname
    snapshotname:snapshotname
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.SnapshotsApi()
var datasetname = datasetname_example; // {String} データセット名
var snapshotname = snapshotname_example; // {String} **必須:** スナップショット名

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSnapshot(datasetname, snapshotname, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSnapshotExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new SnapshotsApi();
            var datasetname = datasetname_example;  // String | データセット名 (default to null)
            var snapshotname = snapshotname_example;  // String | **必須:** スナップショット名 (default to null)

            try
            {
                // スナップショットの削除
                apiInstance.deleteSnapshot(datasetname, snapshotname);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SnapshotsApi.deleteSnapshot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\SnapshotsApi();
$datasetname = datasetname_example; // String | データセット名
$snapshotname = snapshotname_example; // String | **必須:** スナップショット名

try {
    $api_instance->deleteSnapshot($datasetname, $snapshotname);
} catch (Exception $e) {
    echo 'Exception when calling SnapshotsApi->deleteSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SnapshotsApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::SnapshotsApi->new();
my $datasetname = datasetname_example; # String | データセット名
my $snapshotname = snapshotname_example; # String | **必須:** スナップショット名

eval { 
    $api_instance->deleteSnapshot(datasetname => $datasetname, snapshotname => $snapshotname);
};
if ($@) {
    warn "Exception when calling SnapshotsApi->deleteSnapshot: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SnapshotsApi()
datasetname = datasetname_example # String | データセット名 (default to null)
snapshotname = snapshotname_example # String | **必須:** スナップショット名 (default to null)

try: 
    # スナップショットの削除
    api_instance.delete_snapshot(datasetname, snapshotname)
except ApiException as e:
    print("Exception when calling SnapshotsApi->deleteSnapshot: %s\n" % e)
extern crate SnapshotsApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let snapshotname = snapshotname_example; // String

    let mut context = SnapshotsApi::Context::default();
    let result = client.deleteSnapshot(datasetname, snapshotname, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
データセット名
snapshotname
String
**必須:** スナップショット名

Responses


putSnapshot

スナップショットの作成

PUT /v2/api/dataset/[データセット名]@スナップショット名[;MatrixParameter]


/v2/api/snapshot/{datasetname}@{snapshotname}

Usage and SDK Samples

curl -X PUT -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/snapshot/{datasetname}@{snapshotname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SnapshotsApi;

import java.io.File;
import java.util.*;

public class SnapshotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        SnapshotsApi apiInstance = new SnapshotsApi();
        String datasetname = datasetname_example; // String | データセット名
        String snapshotname = snapshotname_example; // String | **必須:** スナップショット名
        try {
            apiInstance.putSnapshot(datasetname, snapshotname);
        } catch (ApiException e) {
            System.err.println("Exception when calling SnapshotsApi#putSnapshot");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SnapshotsApi;

public class SnapshotsApiExample {

    public static void main(String[] args) {
        SnapshotsApi apiInstance = new SnapshotsApi();
        String datasetname = datasetname_example; // String | データセット名
        String snapshotname = snapshotname_example; // String | **必須:** スナップショット名
        try {
            apiInstance.putSnapshot(datasetname, snapshotname);
        } catch (ApiException e) {
            System.err.println("Exception when calling SnapshotsApi#putSnapshot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *datasetname = datasetname_example; // データセット名 (default to null)
String *snapshotname = snapshotname_example; // **必須:** スナップショット名 (default to null)

SnapshotsApi *apiInstance = [[SnapshotsApi alloc] init];

// スナップショットの作成
[apiInstance putSnapshotWith:datasetname
    snapshotname:snapshotname
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.SnapshotsApi()
var datasetname = datasetname_example; // {String} データセット名
var snapshotname = snapshotname_example; // {String} **必須:** スナップショット名

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putSnapshot(datasetname, snapshotname, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putSnapshotExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new SnapshotsApi();
            var datasetname = datasetname_example;  // String | データセット名 (default to null)
            var snapshotname = snapshotname_example;  // String | **必須:** スナップショット名 (default to null)

            try
            {
                // スナップショットの作成
                apiInstance.putSnapshot(datasetname, snapshotname);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SnapshotsApi.putSnapshot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\SnapshotsApi();
$datasetname = datasetname_example; // String | データセット名
$snapshotname = snapshotname_example; // String | **必須:** スナップショット名

try {
    $api_instance->putSnapshot($datasetname, $snapshotname);
} catch (Exception $e) {
    echo 'Exception when calling SnapshotsApi->putSnapshot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SnapshotsApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::SnapshotsApi->new();
my $datasetname = datasetname_example; # String | データセット名
my $snapshotname = snapshotname_example; # String | **必須:** スナップショット名

eval { 
    $api_instance->putSnapshot(datasetname => $datasetname, snapshotname => $snapshotname);
};
if ($@) {
    warn "Exception when calling SnapshotsApi->putSnapshot: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.SnapshotsApi()
datasetname = datasetname_example # String | データセット名 (default to null)
snapshotname = snapshotname_example # String | **必須:** スナップショット名 (default to null)

try: 
    # スナップショットの作成
    api_instance.put_snapshot(datasetname, snapshotname)
except ApiException as e:
    print("Exception when calling SnapshotsApi->putSnapshot: %s\n" % e)
extern crate SnapshotsApi;

pub fn main() {
    let datasetname = datasetname_example; // String
    let snapshotname = snapshotname_example; // String

    let mut context = SnapshotsApi::Context::default();
    let result = client.putSnapshot(datasetname, snapshotname, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
datasetname
String
データセット名
snapshotname
String
**必須:** スナップショット名

Responses


User

getUser

ユーザの諸情報を取得

GET /v2/api/user[;MatrixParameter] # 戻り値 ## JSONフォーマット ```json { "user" : "userid", "introduce_code" : "XA76A", "node" : "ise.teracloud.jp", "webdav_url" : "https://ise.teracloud.jp/dav/", "capacity" : 1101, "api_key" : { "name" : "アプリケーション名", "note" : "アプリケーションの説明", "vendor" : "アプリケーションデベロッパー名", "activated_time" : 2015-02-15 09:05:42.0, "bonus" : { "since" : 2015-02-15 09:05:56.0, "until" : 2016-02-14 23:59:59.0, "increase_capacity" : 100 } }, "result" : 0, "revision" : 2015031601 } ``` ## XMLフォーマット ```xml <TeraCLOUDObject> <result>0</result> <revision>0</revision> <node>ise.teracloud.jp</node> <webdav_url>https://ise.teracloud.jp/dav/</webdav_url> <api_key> <note>アプリケーションの説明</note> <vendor>アプリケーションデベロッパー名</vendor> <bonus> <until>2016-02-14 23:59:59.0</until> <since>2015-02-15 09:05:56.0</since> <increase_capacity>100</increase_capacity> </bonus> <activated_time>2015-02-15 09:05:42.0</activated_time> <name>アプリケーション名</name> </api_key> <user>userid</user> <introduce_code>XA76A</introduce_code> <capacity>1101</capacity> </TeraCLOUDObject> ``` - result 成功したら0。それ以外は内部エラーコードが返る。システムエラー(数字)として処理する。 - revision APIのリビジョン番号。バージョンによる後方互換性は基本的には保たれるため、通常は無視しても良い。 - user ユーザID。 - introduce_code そのユーザーの紹介者コード(半角英数字)。ユーザ毎に完全にユニークではない。この紹介者コードを友人に紹介し、マイページに入力することで、双方にボーナスが付与される。 - node そのユーザーが収容されているノードサーバのFQDN。ノード系APIはこちらのサーバに向けて実行してください。 - webdav_url そのユーザのWebDAV URL。 - capacity 契約容量。そのユーザーが利用できる容量(単位: GB)。 - api_key API KEYに準ずる拡張パラメタ。 API KEYに準ずる拡張パラメタは下記の通り。 - activated_time このAPI KEYを初めて使った日時。(yyyy-MM-dd HH:mm:ss.s)。 - vendor アプリケーションのベンダー名。 - name アプリケーション名。 - note アプリケーションの説明文。 - bonus API KEYに関連するボーナス。bonusは特殊なAPI KEYに付与されます。API KEYの付与の時にBonusを与えたいデベロッパーは、こちらを参照。※リンク先は現在準備中です。 - API KEYに関連するボーナスは下記の通り。 - since API KEYに特典がある場合、適用された日時(yyyy-MM-dd HH:mm:ss.s)未来の日付もあり得る。 - capacity 契約容量。そのユーザーが利用できる容量(単位: GB)。 - until API KEYに特典がある場合、その期限となる日時(yyyy-MM-dd HH:mm:ss.s)この期限が過ぎるとボーナスの効果がなくなるが、この値は常に戻る。 - increase_capacity API KEYの特典によって増加する容量(単位: GB)。 ※出力パラメーターは、今後の拡張や特典の内容により増える可能性があります。


/v2/api/user

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" -H "X-TeraCLOUD-API-KEY: [[apiKey]]" "https://api.teracloud.jp/v2/api/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BASIC_AUTH
        HttpBasicAuth BASIC_AUTH = (HttpBasicAuth) defaultClient.getAuthentication("BASIC_AUTH");
        BASIC_AUTH.setUsername("YOUR USERNAME");
        BASIC_AUTH.setPassword("YOUR PASSWORD");

        // Configure API key authorization: HEADER_APIKEY
        ApiKeyAuth HEADER_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("HEADER_APIKEY");
        HEADER_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //HEADER_APIKEY.setApiKeyPrefix("Token");

        // Configure API key authorization: MATRIX_APIKEY
        ApiKeyAuth MATRIX_APIKEY = (ApiKeyAuth) defaultClient.getAuthentication("MATRIX_APIKEY");
        MATRIX_APIKEY.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //MATRIX_APIKEY.setApiKeyPrefix("Token");

        UserApi apiInstance = new UserApi();
        String apiKey = apiKey_example; // String | 
        try {
            apiInstance.getUser(apiKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String apiKey = apiKey_example; // String | 
        try {
            apiInstance.getUser(apiKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BASIC_AUTH)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

// Configure API key authorization: (authentication scheme: HEADER_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-TeraCLOUD-API-KEY"];

// Configure API key authorization: (authentication scheme: MATRIX_APIKEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];

String *apiKey = apiKey_example; //  (default to null)

UserApi *apiInstance = [[UserApi alloc] init];

// ユーザの諸情報を取得
[apiInstance getUserWith:apiKey
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MuramasaTeracloudWebEngineV20 = require('muramasa__teracloud_web_engine_v20');
var defaultClient = MuramasaTeracloudWebEngineV20.ApiClient.instance;

// Configure HTTP basic authorization: BASIC_AUTH
var BASIC_AUTH = defaultClient.authentications['BASIC_AUTH'];
BASIC_AUTH.username = 'YOUR USERNAME'
BASIC_AUTH.password = 'YOUR PASSWORD'

// Configure API key authorization: HEADER_APIKEY
var HEADER_APIKEY = defaultClient.authentications['HEADER_APIKEY'];
HEADER_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HEADER_APIKEY.apiKeyPrefix['X-TeraCLOUD-API-KEY'] = "Token"

// Configure API key authorization: MATRIX_APIKEY
var MATRIX_APIKEY = defaultClient.authentications['MATRIX_APIKEY'];
MATRIX_APIKEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//MATRIX_APIKEY.apiKeyPrefix['api_key'] = "Token"

var api = new MuramasaTeracloudWebEngineV20.UserApi()
var apiKey = apiKey_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUser(apiKey, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: BASIC_AUTH
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: HEADER_APIKEY
            Configuration.Default.ApiKey.Add("X-TeraCLOUD-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-TeraCLOUD-API-KEY", "Bearer");
            // Configure API key authorization: MATRIX_APIKEY
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new UserApi();
            var apiKey = apiKey_example;  // String |  (default to null)

            try
            {
                // ユーザの諸情報を取得
                apiInstance.getUser(apiKey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BASIC_AUTH
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
// Configure API key authorization: HEADER_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-TeraCLOUD-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TeraCLOUD-API-KEY', 'Bearer');
// Configure API key authorization: MATRIX_APIKEY
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new OpenAPITools\Client\Api\UserApi();
$apiKey = apiKey_example; // String | 

try {
    $api_instance->getUser($apiKey);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure HTTP basic authorization: BASIC_AUTH
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure API key authorization: HEADER_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'X-TeraCLOUD-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-TeraCLOUD-API-KEY'} = "Bearer";
# Configure API key authorization: MATRIX_APIKEY
$WWW::OPenAPIClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'api_key'} = "Bearer";

my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $apiKey = apiKey_example; # String | 

eval { 
    $api_instance->getUser(apiKey => $apiKey);
};
if ($@) {
    warn "Exception when calling UserApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BASIC_AUTH
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: HEADER_APIKEY
openapi_client.configuration.api_key['X-TeraCLOUD-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-TeraCLOUD-API-KEY'] = 'Bearer'
# Configure API key authorization: MATRIX_APIKEY
openapi_client.configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = openapi_client.UserApi()
apiKey = apiKey_example # String |  (default to null)

try: 
    # ユーザの諸情報を取得
    api_instance.get_user(apiKey)
except ApiException as e:
    print("Exception when calling UserApi->getUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let apiKey = apiKey_example; // String

    let mut context = UserApi::Context::default();
    let result = client.getUser(apiKey, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
api_key
String

Responses