TeraCLOUD REST API V2(Muramasa)

Top / Developers / TeraCLOUD REST API V2(Muramasa)

This page is automatically translated.

REST API overview

There are mainly two servers that accept REST API. For details, refer to the server type. See also reference manual.

In addition, the application developer generally accesses the API in the following procedure.

Here, "FEF5078EA41D182EEF89A21E034BD680" is used for testing the API key.

The key for this test may be freely used by the developer for testing, but if you want to publish your product in some form, I would like you to apply a special key separately.

Also, when using this API-KEY for the first time, bonus capacity of 50 GB / year is arrived at the user who used it automatically. Although increased capacity can be freely used, it is for developers only, so please do not use any service software that increases capacity to users with this API-KEY.

Good API when accessing for initial registration

  1. Access the user resource of the API server (GET). Acquire a different node server (WebDAV URL) for each user.
  2. From the acquired return value, obtain the WebDAV URL to be connected.
  3. If access to the data set is necessary, request to the node server.

When the user first creates an account of TeraCLOUD, the user's node server automatically determines the accommodation destination and thereafter will not change as a rule after that. Therefore, it is possible for the application to cache the acquired node server once and continue using it.

Also, the node system server operates independently including the BASIC authentication credentials. Therefore, even if the API system or web server is down, even if the node server is running, it is designed to be able to continue WebDAV service.

Example request by Curl:

curl -X GET - user Your ID-H "X-TeraCLOUD-API-KEY: FEF5078EA41D182EEF89A21E034BD680" https://api.teracloud.jp/v2/api/user
Enter host password for user 'Your ID': Enter password

Return example

{"result": 0, "node": "ise.teracloud.jp", "webdav_url": "https://ise.teracloud.jp/dav/", "api_key": {"note": "jpc api "introduction_code_bonus_for_inviter": 2, "introduce_code_bonus_for_invitee": 5 "test", "vendor": "justplayer", "activated_time": "2018-12-06 12: 29: 41.0", "name": "jpc api test"} , "user": "your user name", "introduce_code": "your referral code", "capacity": your contracted capacity, "revision": 2015041301}%

In this way, with JSON, you can refer to node and webdav_url and get it. In the above example, the server called ise is the accommodating server.

node

Node server. Sending a REST API to this server. / backup To access the following, create a URL from this host name.

webdav_url

In general, the URL of WebDAV users are using. If you want to use general access area, use here. For very early users this URL may be "not present".

For details, refer to the reference getUser.

A good API when accessing at the time of starting use (every time the application is started)

Capacity system etc.

There is no need to do anything in the implementation of the application, especially if it is not necessary.

In this example, since the node server was ise.teracloud.jp in the above, I am accessing ise.teracloud.jp.

curl -X GET --user Your ID-H "X-TeraCLOUD-API-KEY: FEF5078EA41D182EEF89A21E034BD680" https://ise.teracloud.jp/v2/api/dataset
Enter host password for user 'Your ID': Enter password

Return value

{"result":0,"data":[["","","1.67T","200G","200G","395M","Sat May 10 17:58 2014","yes","on","1.06x","filesystem","200G",""]],"meta":["name","mountpoint","quota","used","usedbydataset","usedbysnapshots","creation","mounted","canmount","compressratio","type","referenced","description"]}%         

In this case the data may be rounded, so it may be less useful for the program.

If / (property) is attached to / SUFFIX, the data structure is changed and detailed data can be acquired.

curl -X GET --user Your ID - H "X - TeraCLOUD - API - KEY: FEF5078EA41D182EEF89A21E034BD680" "https://ise.teracloud.jp/v2/api/dataset/(property)"

Enter host password for user 'Your ID':

Return value

{"result":0,"dataset":{"__ROOT__":{"canmount":"on","usedbydataset":214671544832,"referenced":214671544832,"quota":1830729809920,"name":"","usedbysnapshots":414506496,"used":215086129152,"compressratio":"1.06x","type":"filesystem","mounted":"yes","creation":1399712327,"mountpoint":""}}}%

In this way, data actually used can be acquired. Actual users' capacity capacity,

__ROOT__.used

You can get from.

Good API when accessing by WebDAV access

Since the response is deteriorated in the REST API, it is not highly recommended to access it every time.

※ TeraCLOUD has various ideas to increase the response speed of WebDAV access.

An API that can be accessed at any time

File related API

Main REST API

ResourceRoleREST target server
userManipulate information related to users.Account API server api.teracloud.jp
datasetPerform operations related to the data set.Each node server (*) * .teracloud.jp
snapshotCreates and deletes a snapshot of the data set.Each node server (*) * .teracloud.jp
filepropertiesGet property of fileproperties file. Includes media information.Each node server (*) * .teracloud.jp

Reference Manual

See here for reference.