API docs by Redocly

docomo business SIGN コンピュート(MEC IaaS) APIリファレンス (1.0.0)

Download OpenAPI specification:

URL: https://sdpf.ntt.com License: NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

docomo business SIGN コンピュート(MEC IaaS) APIリファレンス

IaaS

サーバ作成

テナント内にサーバを作成するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Request Body schema: application/json
required

作成するサーバの情報

serverName
required
string^SIGN-.*$
flavorRef
required
string
imageRef
required
string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
simGroupId
required
string

Responses

Request samples

Content type
application/json
{
  • "serverName": "SIGN-string",
  • "flavorRef": "1",
  • "imageRef": "70a599e0-31e7-49b7-b260-868f441e862b",
  • "simGroupId": "dummy_id"
}

Response samples

Content type
{}

サーバ一覧取得

テナント内に存在するサーバの一覧を取得するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "servers": [
    ]
}

サーバ削除

テナント内に存在するサーバを削除するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

serverId
required
string = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: 550e8400-e29b-41d4-a716-446655440000

サーバID

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "errorCode": "E40001",
  • "errorMessages": [
    ]
}

ボリューム作成

テナント内に利用可能なボリュームを作成するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Request Body schema: application/json
required
displayName
required
string

ボリューム名

size
required
integer
Enum: 15 40 80 100 300 500 1024 2048 3072 4096

ボリュームサイズ（GiB）

displayDescription
string

ボリュームの説明

Responses

Request samples

Content type
application/json
{
  • "displayName": "SIGN-sample-volume",
  • "size": 100,
  • "displayDescription": "test volume"
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "availabilityZone": "dublin",
  • "createdAt": "2013-02-18T14:51:17.970024",
  • "displayDescription": "Volume Description",
  • "displayName": "Volume Name",
  • "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
  • "metadata": { },
  • "size": 100,
  • "snapshotId": "sampleid",
  • "status": "in-use",
  • "volumeType": "vol_type_name"
}

ボリューム一覧取得

テナント内に存在する利用可能なボリュームの一覧を取得するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "volumes": [
    ]
}

ボリュームをサーバにアタッチ

テナント内に存在するボリュームをサーバにアタッチするAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

serverId
required
string = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: 550e8400-e29b-41d4-a716-446655440000

サーバID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Request Body schema: application/json
required

アタッチするボリュームの情報

volumeId
string = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Request samples

Content type
application/json
{
  • "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "serverId": "string",
  • "volumeId": "string",
  • "device": "string"
}

ボリュームをデタッチ

テナント内に存在するサーバにアタッチされているボリュームを対象のサーバからデタッチするAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

volumeId
required
string = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: a26887c6-c47b-4654-abb5-dfadf7d3f803

ボリュームID

serverId
required
string = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: 550e8400-e29b-41d4-a716-446655440000

サーバID

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "errorCode": "E40000",
  • "errorMessages": [
    ]
}

ボリューム削除

テナント内に存在する特定のボリュームを削除するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

volumeId
required
string = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
Example: a26887c6-c47b-4654-abb5-dfadf7d3f803

ボリュームID

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "errorCode": "E40001",
  • "errorMessages": [
    ]
}

イメージ一覧取得

テナントにて利用可能なイメージの一覧を取得するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "images": [
    ]
}

フレーバー一覧取得

テナントにて利用可能なフレーバーの一覧を取得するAPI

path Parameters
tenantId
required
string = 32 characters ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

テナントID

region
required
string^[a-z0-9]{3,}$
Example: jp9

リージョン

header Parameters
X-Auth-Token
required
string = 32 characters ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e454206287556

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "flavors": [
    ]
}