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リクエストパス

・[JP4/7]:mvp-[Region Name]-ecl.api.ntt.com

vcds

VMware Cloud Director参照APIエンドポイント(JP4/JP7)

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 errors 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 errors 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エンドポイント(JP4/JP7)

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 errors 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 organization(s).

500

Some internal server errors 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 errors 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 errors 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エンドポイント(JP4/JP7)

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 errors 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