user

This page is automatically translated.

2015-03-20

Overview

Acquire user information

URL Syntax

https://api.teracloud.jp/ {major version} / api / {resource} / {; MatrixParameter} {/ PathParameter}

{Major version}

v2

{resource}

user

{MatrixParameter}

The MatrixParameter of each method. PathParameter is out of order.

{PathParameter}

The PathParameter of each method. MatrixParameter is out of order.

Method table

Method

PathParamIn caseMatrixParam Return value (xml / json) Description

GET status code, URL BASE (note server name), introducer code, contractApproximate capacity, Extended parameters according to other APIKEY Acquire user information

No PUT

DELETE None

No POST

Common parameters

API KEY

Make the following as the URL as Matrix Parameter

; api_key = EA703E7AA1EFDA0064EAA507D9E8AB7E

Example:

GET / v2 / api / user; api_key = EA 703 E 7 AA 1 EFDA 006 AEA 50 D 9 E 8 AB 7 E

Alternatively, write the following in the HTTP Header

X-TeraCLOUD-API-KEY: EA 703 E 7 A A 1 EFDA 006 AEA 50 D 9 E 8 AB 7 E

user

GET user

GET / v2 / api / user [; MatrixParameter]

Get various information of the user.

Unique MatrixParameter

None

An example

GET / v2 / api / user

Return value

HTTP response code

200 OK

success. XML / JSON data is returned.

202 Accepted

Authentication is successful. However, because there is a temporary defect in the data, we expect to make a request in a few minutes.

Although it can log in to TeraCLOUD account type server, it can not propagate to all servers and this error code is returned when information is missing. Specifically, it means a state in which accommodation is not finished in the node server immediately after creation of the account, and the like.

Format of Entity (Body) part

JSON format example

{

  "user": "userid",

  "introduce_code": "XA 76 A",

  "node": "ise.teracloud.jp",

  "webdav_url": "https://ise.teracloud.jp/dav/",

  "capacity": 1101,

  "api_key": {

    "name": "application name",

    "note": "Description of application",

    "vendor": "Application developer name",

    "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 format example

<TeraCLOUDObject>

 <result> 0 </ result>

 <revision> 0 </ revision>

 <node> ise.teracloud.jp </ node>

 <webdav_url> https://ise.teracloud.jp/dav/ </ webdav_url>

 <api_key>

  <note> Application description </ note>

  <vendor> Application Developer Name </ 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> application name </ name>

 </ api_key>

 <user> userid </ user>

 <introduce_code> XA 76 A </ introduce_code>

 <capacity> 1101 </ capacity>

</ TeraCLOUDObject>

result

0 if successful. Otherwise internal error code is returned. Process as system error (number).

revision

The revision number of the API. Since backward compatibility by version is basically kept, it can usually be ignored.

user

User ID

introduce_code

Introducer code of the user (half size alphanumeric characters). It is not completely unique for each user. Introducing this introducer code to a friend and entering it into my page gives bonus to both.

node

The FQDN of the node server where the user is located.

webdav_url

The user's WebDAV URL.

capacity

Contract capacity. Capacity available for that user (unit: GB).

api_key

Extended parameter according to API KEY

Extended parameters according to API KEY are as follows.

activated_time

Date and time this API KEY was used for the first time. (Yyyy - MM - dd HH: mm: ss.s)

vendor

Application vendor name

name

Application name

note

Application description

bonus

Bonus related to API KEY. bonus is granted to special API KEY. For developers who wish to give Bonus when granting API KEY, see here.

※ The link destination is currently under preparation.

The bonus related to API KEY is as follows.

since

If there is a benefit in the API KEY, there may be a future date (yyyy - MM - dd HH: mm: ss.s) when applied.

until

When there is a benefit in API KEY, the date and time (yyyy - MM - dd HH: mm: ss.s) for which the deadline expires, the bonus will be ineffective when this deadline expires, but this value always returns.

increase_capacity

Capacity (unit: GB) to be increased by privileges of API KEY.

※ Output parameters may increase due to future expansion and benefit contents.