IPV SDP User APIリスト (0.1.0)

Download OpenAPI specification:Download

概要

本APIはIaaS Powered by VMware SDPユーザーAPIとなります。

APIを初めてご利用になる際には、{vcd_id}が必要となります。

事前にvCD一覧取得を実施し{vcd_id}の取得を行って下さい。

APIリクエストパス

各リージョンのリクエストパスは以下となります。

■APIリクエストパス

・mvp-[Region Name]-ecl.api.ntt.com

vcds

VMware Cloud Director参照APIエンドポイント

vCD一覧取得

API利用時に必要となるvCD情報の一覧を取得できます

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds
/v1/{tenant_id}/vcds

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vcds":
    [
    ]
}

指定IDのvCD情報取得

指定されたIDを持つvCD情報を取得します

path Parameters
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}
/v1/{tenant_id}/vcds/{vcd_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vcd":
    {
    }
}

organizations

Organizations設定APIエンドポイント

organizationの一覧取得

利用ワークスペース内のテナントで作成されているorganization情報一覧を取得します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations
/v1/{tenant_id}/vcds/{vcd_id}/organizations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizations":
    [
    ]
}

新規organizationの作成

指定vCD_IDに新規organizationを作成します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some organization(s) are under processing(have status pending_(creat|delet)ing. Please wait until all process is done.

409

The name given is already used in other organziation(s).

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations
/v1/{tenant_id}/vcds/{vcd_id}/organizations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organization":
    {
    }
}

指定IDのorganization情報取得

指定されたIDを持つorganization情報を取得します

path Parameters
org_id
required
string <uuid> (Org Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organization":
    {
    }
}

指定organizationの削除

指定されたorganizationの削除を行います

path Parameters
org_id
required
string <uuid> (Org Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some organization(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}

org_admins

Organization admin設定APIエンドポイント

Org Admin情報の一覧取得

指定されたorganization内に作成されているOrg Admin情報の一覧を取得します

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "org_admins":
    [
    ]
}

Org Adminの作成

指定されたorganization内にOrg Adminを作成します

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
org_admin
required
object (OrgAdminRequestCreate)

OrgAdmin schama for User API create request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

409

The name given is already used in the organziation.

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Org Admin情報の取得

指定されたorganization内のOrg Admin情報を取得します

path Parameters
org_admin_id
required
string <uuid> (Org Admin Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Specified org_admin_id not found.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Org Adminパスワード更新

指定されたorganization内のOrg Adminパスワードの更新を行います

path Parameters
org_admin_id
required
string <uuid> (Org Admin Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
org_admin
required
object (OrgAdminRequestUpdate)

OrgAdmin schama for User API create request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Specified org_admin_id not found.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Org Adminの削除

指定されたorganization内のOrg Adminの削除を行います

path Parameters
org_admin_id
required
string <uuid> (Org Admin Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Specified org_admin_id not found.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}

backup

Organizaitonの利用量に関するAPIエンドポイント

指定organizationの使用容量取得

指定されたorganizationの合計使用量(byte)の取得

path Parameters
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/backup
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/backup

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "backup":
    {
    }
}

vdcs

Organization virtual data centers(OvDC)設定APIエンドポイント

OvDC一覧の取得

指定されたorganization内のOvDC一覧情報を取得します

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vdcs":
    [
    ]
}

新規OvDCの作成

指定されたorganization内に新規OvDCを作成します

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
vdc
required
object (VdcRequestCreate)

Vdc schama for User API create request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some vdc(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The name given is already used in other vdc(s) in the organziation.

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vdc":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vdc":
    {
    }
}

指定OvDC情報の取得

指定されたIDを持つOvDC情報を取得します

path Parameters
vdc_id
required
string <uuid> (Vdc Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vdc":
    {
    }
}

指定OvDC名の更新

指定されたIDを持つOvDCの名称変更を行います

path Parameters
vdc_id
required
string <uuid> (Vdc Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
vdc
required
object (VdcRequestUpdate)

Vdc schema for User API update request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some vdc(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The name given is already used in other vdc(s) in the organziation.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vdc":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "vdc":
    {
    }
}

指定OvDCの削除

指定されたIDを持つOvDCの削除を行います

path Parameters
vdc_id
required
string <uuid> (Vdc Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some vdc(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}

disk_types

Organization virtual data centers(OvDC)のDisk types参照APIエンドポイント

disk_typeの一覧取得

OvDC作成時に利用可能なdisk_typeの一覧を取得

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/disk_types
/v1/{tenant_id}/vcds/{vcd_id}/disk_types

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "disk_types":
    [
    ]
}

指定IDのdisk_type情報取得

指定されたIDを持つdisk_type情報を取得します

path Parameters
disk_type_id
required
string <uuid> (Disk Type Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/disk_types/{disk_type_id}
/v1/{tenant_id}/vcds/{vcd_id}/disk_types/{disk_type_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "disk_type":
    {
    }
}

flavors

Organization virtual data centers(OvDC)のFlavors参照APIエンドポイント

flavorの一覧取得

OvDC作成時に利用可能なflavorの一覧を取得

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/flavors
/v1/{tenant_id}/vcds/{vcd_id}/flavors

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "flavors":
    [
    ]
}

指定IDのflavor情報取得

指定されたIDを持つflavor情報を取得します

path Parameters
flavor_id
required
string <uuid> (Flavor Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/flavors/{flavor_id}
/v1/{tenant_id}/vcds/{vcd_id}/flavors/{flavor_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "flavor":
    {
    }
}

nsx_t_external_networks

External networkおよび関連リソース設定APIエンドポイント

external_network情報の取得

指定されたorganization内に作成されたexternal_network情報の取得

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
status
string (UserResourceStatusEnum)
Enum: "pending_create" "active" "pending_update" "pending_delete" "deleted" "error_creating" "error_updating" "error_deleting" "inactive"

User resource status enum.

header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "nsx_t_external_networks":
    [
    ]
}

external_networkの作成

指定されたorganization内にexternal_networkを作成します

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
nsx_t_external_network
required
object (NSXTExternalNetworkRequest)

.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some nsx_t_external_network(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

指定external_network情報の取得

指定されたIDを持つexternal_network情報を取得します

path Parameters
nsx_t_external_network_id
required
string <uuid> (Nsx T External Network Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

指定external_networkの更新

指定されたIDを持つexternal_network情報を取得します

path Parameters
nsx_t_external_network_id
required
string <uuid> (Nsx T External Network Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
nsx_t_external_network
required
object (NSXTExternalNetworkRequest)

.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some nsx_t_external_network(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

external_networkの削除

指定されたIDを持つexternal_networkの削除を行います

path Parameters
nsx_t_external_network_id
required
string <uuid> (Nsx T External Network Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some nsx_t_external_network(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}

internet_gateways

Internet gateway設定APIエンドポイント

internet_gatewayの一覧取得

指定されたorganization内のinternet_gateway情報の一覧を取得します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_gateways":
    [
    ]
}

internet_gatewayの作成

指定されたorganization内にinternet_gatewayを作成します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
internet_gateway
required
object (InternetGatewayRequestCreate)

Internet gateway schema for User API POST request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some internet gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

指定internet_gateway情報の取得

指定されたIDを持つinternet_gateway情報を取得します

path Parameters
internet_gateway_id
required
string <uuid> (Internet Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

internet_gateway情報の更新

指定されたorganization内に作成されているinternet_gateway情報の更新をします

path Parameters
internet_gateway_id
required
string <uuid> (Internet Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
internet_gateway
required
object (InternetGatewayRequestUpdate)

Internet gateway schema for User API PUT request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some internet gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

internet_gatewayの削除

指定されたIDを持つinternet_gatewayの削除を行います

path Parameters
internet_gateway_id
required
string <uuid> (Internet Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some internet gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}

internet_qos_options

Internet_gateway帯域メニューAPIエンドポイント

internet設定用QoS一覧の取得

internet gateway設定に使用される帯域の一覧を取得します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options
/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_qos_options":
    [
    ]
}

指定internet帯域情報の取得

指定されたIDを持つinternet 帯域情報を取得します

path Parameters
qos_option_id
required
string <uuid> (Qos Option Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options/{qos_option_id}
/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options/{qos_option_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "internet_qos_option":
    {
    }
}

public_ips

グローバルIPアドレス設定APIエンドポイント

Global_ipの一覧取得

IPVにて利用されているGlobal_ipの一覧を取得します

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "public_ips":
    [
    ]
}

Global_ipの作成

IPV Internet Gatewayにて使用できるGlobal_ipの作成を行います

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
public_ip
required
object (PublicIPRequestCreate)

PublicIP create request schema for User API.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some public_ip(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

503

The system is temporary unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Global_ipの取得

指定されたorganization内で使用されているGlobal_ip情報を取得します

path Parameters
public_ip_id
required
string <uuid> (Public Ip Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Global_ipの更新

指定されたorganization内で使用されているGlobal_ip情報の更新を行います

path Parameters
public_ip_id
required
string <uuid> (Public Ip Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
public_ip
required
object (PublicIPRequestUpdate)

PublicIP update request schema for User API.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Global_ipの削除

指定されたorganization内で使用されているGlobal_ipの削除を行います

path Parameters
public_ip_id
required
string <uuid> (Public Ip Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some public_ip(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

503

The system is temporary unavailable. Please try again later.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}

fic_gateways

FIC(Flexible InterConnect)gateway設定APIエンドポイント

fic_gateway情報の一覧取得

指定されたorganization内のfic_gateway情報を一覧取得します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateways":
    [
    ]
}

fic_gatewayのKey発行

fic_connectionにて使用される指定organizationと接続するfic_gatewayのKeyを発行します

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
fic_gateway
required
object (FicGatewayRequestCreate)

Fic gateway schema for User API POST request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

fic_gateway作成リクエスト承認

指定されたorganizationと接続するfic_gatewayの作成リクエストの承認を行います

path Parameters
gateway_id
required
string <uuid> (Gateway Id)
method
required
string (FicGatewayApprovalMethodEnum)
Enum: "create" "update"

Fic gateway method enum.

tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/request_{method}_approval
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/request_{method}_approval

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

fic_gatewayサービスの開始

FIC Connection側の接続処理を実施します

path Parameters
gateway_id
required
string <uuid> (Gateway Id)
method
required
string (FicGatewayServiceMethodEnum)
Enum: "update" "start"

Fic gateway method enum.

vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/{method}_service
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/{method}_service

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

指定fic_gateway情報の取得

指定されたIDを持つfic_gateway情報の取得を行います

path Parameters
fic_gateway_id
required
string <uuid> (Fic Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

fic_gateway情報の更新

指定されたorganization内のfic_gateway情報の更新を行います

path Parameters
fic_gateway_id
required
string <uuid> (Fic Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
fic_gateway
required
object (FicGatewayRequestUpdate)

Fic gateway schema for User API PUT request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

fic_gatewayの削除

指定されたorganization内に作成されているfic_gatewayの削除を行います

path Parameters
fic_gateway_id
required
string <uuid> (Fic Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "detail":
    [
    ]
}