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",
- "password": "string"
}
}
Response samples
- 201
- 400
{- "org_admin": {
- "id": "string",
- "name": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "status": "string"
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Specified org_admin_id not found.
Some internal server error occurred.
Response samples
- 200
- 400
{- "org_admin": {
- "id": "string",
- "name": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "status": "string"
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Specified org_admin_id not found.
Some internal server error occurred.
Request samples
- Payload
{- "org_admin": {
- "password": "string"
}
}
Response samples
- 200
- 400
{- "org_admin": {
- "id": "string",
- "name": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "status": "string"
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Specified org_admin_id not found.
Some internal server error occurred.
Response samples
- 400
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
指定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
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
{- "backup": {
- "total_logical_usage_bytes": "string"
}
}
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
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
{- "vdcs": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "flavor": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}, - "disk_type": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
]
}
新規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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some vdc(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The name given is already used in other vdc(s) in the organziation.
Some internal server error occurred.
Request samples
- Payload
{- "vdc": {
- "name": "string",
- "description": "string",
- "disk_type_id": "string",
- "flavor_id": "string"
}
}
Response samples
- 201
- 400
{- "vdc": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "flavor": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}, - "disk_type": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
}
指定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
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
{- "vdc": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "flavor": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}, - "disk_type": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
}
指定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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some vdc(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The name given is already used in other vdc(s) in the organziation.
Some internal server error occurred.
Request samples
- Payload
{- "vdc": {
- "name": "string",
- "description": "string"
}
}
Response samples
- 200
- 400
{- "vdc": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "flavor": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}, - "disk_type": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "inactive"
}
}
}
指定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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some vdc(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"
}
]
}
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
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
{- "disk_types": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
]
}
指定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
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
{- "disk_type": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
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
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
{- "flavors": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "available_disk_types": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
]
}
]
}
指定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
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
{- "flavor": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "available_disk_types": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
]
}
}
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
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
{- "nsx_t_external_networks": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "high_availability": false,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "owner_resource_type": "string",
- "owner_resource_id": "string",
- "static_routes": [ ],
- "form_factor_name": "string",
- "load_balancer_type_name": "string"
}
]
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some nsx_t_external_network(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
There is already a resource with same name in the organization.
Some internal server error occurred.
Request samples
- Payload
{- "nsx_t_external_network": {
- "name": "string",
- "description": "string",
- "owner_resource_id": "string",
- "form_factor_name": "string",
- "load_balancer_type_name": "string",
- "owner_resource_type": "vdc",
- "static_routes": [ ]
}
}
Response samples
- 201
- 400
{- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "high_availability": false,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "owner_resource_type": "string",
- "owner_resource_id": "string",
- "static_routes": [ ],
- "form_factor_name": "string",
- "load_balancer_type_name": "string"
}
}
指定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
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
{- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "high_availability": false,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "owner_resource_type": "string",
- "owner_resource_id": "string",
- "static_routes": [ ],
- "form_factor_name": "string",
- "load_balancer_type_name": "string"
}
}
指定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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some nsx_t_external_network(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
There is already a resource with same name in the organization.
Some internal server error occurred.
Request samples
- Payload
{- "nsx_t_external_network": {
- "name": "string",
- "description": "string",
- "owner_resource_id": "string",
- "form_factor_name": "string",
- "load_balancer_type_name": "string",
- "owner_resource_type": "vdc",
- "static_routes": [ ]
}
}
Response samples
- 200
- 400
{- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "high_availability": false,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "owner_resource_type": "string",
- "owner_resource_id": "string",
- "static_routes": [ ],
- "form_factor_name": "string",
- "load_balancer_type_name": "string"
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some nsx_t_external_network(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"
}
]
}
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
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
{- "internet_gateways": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "internet_qos_option_id": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
]
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internet gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The given name is already used in the organization.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Request samples
- Payload
{- "internet_gateway": {
- "name": "string",
- "description": "string",
- "cidr": "string",
- "internet_qos_option_id": "string",
- "nsx_t_external_network_id": "string"
}
}
Response samples
- 201
- 400
{- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "internet_qos_option_id": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
指定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
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
{- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "internet_qos_option_id": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internet gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Request samples
- Payload
{- "internet_gateway": {
- "name": "string",
- "description": "string",
- "internet_qos_option_id": "string"
}
}
Response samples
- 200
- 400
{- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "internet_qos_option_id": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some internet gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Response samples
- 400
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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
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
{- "internet_qos_options": [
- {
- "id": "string",
- "name": "string"
}
]
}
指定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
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
{- "internet_qos_option": {
- "id": "string",
- "name": "string"
}
}
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
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
{- "public_ips": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "cidr": "string",
- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
]
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some public_ip(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
There is already a resource with same name in the organization.
Some internal server error occurred.
The system is temporary unavailable. Please try again later.
Request samples
- Payload
{- "public_ip": {
- "name": "string",
- "description": "string",
- "internet_gateway_id": "string",
- "prefix_length": 0
}
}
Response samples
- 201
- 400
{- "public_ip": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "cidr": "string",
- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
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
{- "public_ip": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "cidr": "string",
- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
There is already a resource with same name in the organization.
Some internal server error occurred.
Request samples
- Payload
{- "public_ip": {
- "name": "string",
- "description": "string"
}
}
Response samples
- 200
- 400
{- "public_ip": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "organization": {
- "id": "string",
- "name": "string",
- "status": "pending_create"
}, - "cidr": "string",
- "internet_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some public_ip(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
Some internal server error occurred.
The system is temporary unavailable. Please try again later.
Response samples
- 400
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
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
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
{- "fic_gateways": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gateway_static_routes": [ ],
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "public_service_key": "string",
- "fic_connection_id": "string",
- "primary_peer_dst_address": "string",
- "primary_peer_src_address": "string",
- "primary_peer_vlan_id": -32768,
- "secondary_peer_dst_address": "string",
- "secondary_peer_src_address": "string",
- "secondary_peer_vlan_id": -32768,
- "additional_ip_ranges": [ ],
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "primary_fic_port_id": "string",
- "secondary_fic_port_id": "string",
- "primary_fic_port_public_name": "string",
- "secondary_fic_port_public_name": "string",
- "xaas_tenant_id": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
]
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The given name is already used in the organization.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Request samples
- Payload
{- "fic_gateway": {
- "name": "string",
- "description": "string",
- "cidr": "string",
- "nsx_t_external_network_id": "string",
- "bandwidth": "string"
}
}
Response samples
- 201
- 400
{- "fic_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gateway_static_routes": [ ],
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "public_service_key": "string",
- "fic_connection_id": "string",
- "primary_peer_dst_address": "string",
- "primary_peer_src_address": "string",
- "primary_peer_vlan_id": -32768,
- "secondary_peer_dst_address": "string",
- "secondary_peer_src_address": "string",
- "secondary_peer_vlan_id": -32768,
- "additional_ip_ranges": [ ],
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "primary_fic_port_id": "string",
- "secondary_fic_port_id": "string",
- "primary_fic_port_public_name": "string",
- "secondary_fic_port_public_name": "string",
- "xaas_tenant_id": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The given name is already used in the organization.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Response samples
- 200
- 400
{- "fic_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gateway_static_routes": [ ],
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "public_service_key": "string",
- "fic_connection_id": "string",
- "primary_peer_dst_address": "string",
- "primary_peer_src_address": "string",
- "primary_peer_vlan_id": -32768,
- "secondary_peer_dst_address": "string",
- "secondary_peer_src_address": "string",
- "secondary_peer_vlan_id": -32768,
- "additional_ip_ranges": [ ],
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "primary_fic_port_id": "string",
- "secondary_fic_port_id": "string",
- "primary_fic_port_public_name": "string",
- "secondary_fic_port_public_name": "string",
- "xaas_tenant_id": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The given name is already used in the organization.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Response samples
- 200
- 400
{- "fic_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gateway_static_routes": [ ],
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "public_service_key": "string",
- "fic_connection_id": "string",
- "primary_peer_dst_address": "string",
- "primary_peer_src_address": "string",
- "primary_peer_vlan_id": -32768,
- "secondary_peer_dst_address": "string",
- "secondary_peer_src_address": "string",
- "secondary_peer_vlan_id": -32768,
- "additional_ip_ranges": [ ],
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "primary_fic_port_id": "string",
- "secondary_fic_port_id": "string",
- "primary_fic_port_public_name": "string",
- "secondary_fic_port_public_name": "string",
- "xaas_tenant_id": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
指定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
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
{- "fic_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gateway_static_routes": [ ],
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "public_service_key": "string",
- "fic_connection_id": "string",
- "primary_peer_dst_address": "string",
- "primary_peer_src_address": "string",
- "primary_peer_vlan_id": -32768,
- "secondary_peer_dst_address": "string",
- "secondary_peer_src_address": "string",
- "secondary_peer_vlan_id": -32768,
- "additional_ip_ranges": [ ],
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "primary_fic_port_id": "string",
- "secondary_fic_port_id": "string",
- "primary_fic_port_public_name": "string",
- "secondary_fic_port_public_name": "string",
- "xaas_tenant_id": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The given name is already used in the organization.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Request samples
- Payload
{- "fic_gateway": {
- "name": "string",
- "description": "string",
- "additional_ip_ranges": [ ],
- "gateway_static_routes": [ ]
}
}
Response samples
- 200
- 400
{- "fic_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "gateway_static_routes": [ ],
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "public_service_key": "string",
- "fic_connection_id": "string",
- "primary_peer_dst_address": "string",
- "primary_peer_src_address": "string",
- "primary_peer_vlan_id": -32768,
- "secondary_peer_dst_address": "string",
- "secondary_peer_src_address": "string",
- "secondary_peer_vlan_id": -32768,
- "additional_ip_ranges": [ ],
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "primary_fic_port_id": "string",
- "secondary_fic_port_id": "string",
- "primary_fic_port_public_name": "string",
- "secondary_fic_port_public_name": "string",
- "xaas_tenant_id": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
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
Successful Response
Invalid request body or header.
Unauthorized.
No sufficient user role for invoking this API.
Resource with given URL does not exist.
Some fic_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Response samples
- 400
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
internal link gatewayリストの取得
指定されたIDを持つinternal link 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
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
{- "internal_link_gateways": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "gateway_static_routes": [ ],
- "gateway_uplink_cidr": "string",
- "gateway_uplink_vip_address": "192.168.0.1",
- "gateway_uplink_active_address": "192.168.0.1",
- "gateway_uplink_standby_address": "192.168.0.1",
- "gateway_vrrp_id": -32768,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
]
}
指定されたinternal link gatewayの取得
指定されたIDを持つinternal link gatewayを取得します
path Parameters
internal_link_gateway_id required | string <uuid> (Internal Link 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
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
{- "internal_link_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "gateway_static_routes": [ ],
- "gateway_uplink_cidr": "string",
- "gateway_uplink_vip_address": "192.168.0.1",
- "gateway_uplink_active_address": "192.168.0.1",
- "gateway_uplink_standby_address": "192.168.0.1",
- "gateway_vrrp_id": -32768,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}
internal link gateway情報の更新
指定されたorganization内に作成されているinternal link gateway情報(名前、備考、スタティックルート情報)の更新をします
path Parameters
internal_link_gateway_id required | string <uuid> (Internal Link 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
internal_link_gateway required | object (InternalLinkGatewayRequestUpdate) Internal Link gateway schema for User API PUT 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.
Some internal_link_gateway(s) are under processing(have status pending_(creat|updat|delet)ing. Please wait until all process is done.
The given name is already used in the organization.
Some internal server error occurred.
The service is temporarily unavailable. Please try again later.
Request samples
- Payload
{- "internal_link_gateway": {
- "name": "string",
- "description": "string",
- "gateway_static_routes": [ ]
}
}
Response samples
- 200
- 400
{- "internal_link_gateway": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string",
- "cidr": "string",
- "edge_gateway_vip_address": "192.168.0.1",
- "edge_gateway_real_address1": "192.168.0.1",
- "edge_gateway_real_address2": "192.168.0.1",
- "gateway_vip_address": "192.168.0.1",
- "gateway_active_address": "192.168.0.1",
- "gateway_standby_address": "192.168.0.1",
- "gateway_static_routes": [ ],
- "gateway_uplink_cidr": "string",
- "gateway_uplink_vip_address": "192.168.0.1",
- "gateway_uplink_active_address": "192.168.0.1",
- "gateway_uplink_standby_address": "192.168.0.1",
- "gateway_vrrp_id": -32768,
- "organization": {
- "id": "string",
- "name": "string",
- "status": "string"
}, - "bandwidth": "string",
- "nsx_t_external_network": {
- "id": "string",
- "name": "string",
- "description": "string",
- "status": "string"
}
}
}