IPV SDP User APIリスト (0.1.0)
Download OpenAPI specification:Download
本APIはIaaS Powered by VMware SDPユーザーAPIとなります。
APIを初めてご利用になる際には、{vcd_id}が必要となります。
事前にvCD一覧取得を実施し{vcd_id}の取得を行って下さい。
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internal server error occurred.
Response samples
- 200
- 400
{- "vcds": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gui_endpoint_url": "string"
}
]
}指定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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internal server error occurred.
Response samples
- 200
- 400
{- "vcd": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gui_endpoint_url": "string"
}
}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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internal server error occurred.
Response samples
- 200
- 400
{- "organizations": [
- {
- "id": "string",
- "name": "string",
- "status": "string",
- "tenant_id": "string",
- "vcd": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
]
}新規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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some organization(s) are under processing(have status pending_(creat|delet)ing. Please wait until all process is done.
The name given is already used in other organziation(s).
Some internal server error occurred.
Response samples
- 201
- 400
{- "organization": {
- "id": "string",
- "name": "string",
- "status": "string",
- "tenant_id": "string",
- "vcd": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
}指定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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internal server error occurred.
Response samples
- 200
- 400
{- "organization": {
- "id": "string",
- "name": "string",
- "status": "string",
- "tenant_id": "string",
- "vcd": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
}指定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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some organization(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
Some internal server error occurred.
Response samples
- 400
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internal server error occurred.
Response samples
- 200
- 400
{- "org_admins": [
- {
- "id": "string",
- "name": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "status": "string"
}
]
}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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
The name given is already used in the organziation.
Some internal server error occurred.
Request samples
- Payload
{- "org_admin": {
- "name": "string",