Server

Package : spaceone.api.inventory.v1

Server

Server Methods:

Method	Request	Response
create	CreateServerRequest	ServerInfo
update	UpdateServerRequest	ServerInfo
pin_data	PinServerDataRequest	ServerInfo
delete	ServerRequest	google.protobuf.Empty
get	GetServerRequest	ServerInfo
list	ServerQuery	ServersInfo
stat	ServerStatQuery	google.protobuf.Struct

create

POST /inventory/v1/servers

Type	Message
Request	CreateServerRequest
Response	ServerInfo

update

PUT /inventory/v1/server/{server_id}

Type	Message
Request	UpdateServerRequest
Response	ServerInfo

pin_data

PUT /inventory/v1/server/{server_id}/pin-data

Type	Message
Request	PinServerDataRequest
Response	ServerInfo

delete

DELETE /inventory/v1/server/{server_id}

Type	Message
Request	ServerRequest
Response	google.protobuf.Empty

get

GET /inventory/v1/server/{server_id}

Type	Message
Request	GetServerRequest
Response	ServerInfo

list

GET /inventory/v1/servers

POST /inventory/v1/servers/search

Type	Message
Request	ServerQuery
Response	ServersInfo

stat

POST /inventory/v1/servers/stat

Type	Message
Request	ServerStatQuery
Response	google.protobuf.Struct

Message

CreateServerRequest

Field	Type	Required	Description
name	string	✘
primary_ip_address	string	✘
os_type	OS_TYPE_NONE LINUX WINDOWS	✔
account	string	✘
instance_type	string	✘
launched_at	string	✘
provider	string	✘
cloud_service_group	string	✘
cloud_service_type	string	✘
region_code	string	✘
data	google.protobuf.Struct	✘
metadata	google.protobuf.Struct	✘
nics	list of ServerNIC	✘
disks	list of ServerDisk	✘
reference	ServerReference	✘
tags	google.protobuf.Struct	✘
project_id	string	✘
domain_id	string	✔

GetServerRequest

Field	Type	Required	Description
server_id	string	✔
domain_id	string	✔
only	list of string	✘

PinServerDataRequest

Field	Type	Required	Description
server_id	string	✔
keys	list of string	✔
domain_id	string	✔

ServerDisk

Field	Type	Required	Description
device_index	int32	✔
device	string	✘
disk_type	string	✘
size	float	✘
tags	google.protobuf.Struct	✘

ServerInfo

Field	Type	Description
server_id	string
name	string
state	string
primary_ip_address	string
ip_addresses	list of string
os_type	OS_TYPE_NONE LINUX WINDOWS
account	string
instance_type	string
provider	string
cloud_service_group	string
cloud_service_type	string
region_code	string
data	google.protobuf.Struct
metadata	google.protobuf.Struct
nics	list of ServerNIC
disks	list of ServerDisk
reference	ServerReference
tags	google.protobuf.Struct
collection_info	google.protobuf.Struct
project_id	string
domain_id	string
created_at	string
updated_at	string
deleted_at	string
launched_at	string

ServerNIC

Field	Type	Required	Description
device_index	int32	✔
device	string	✘
nic_type	string	✘
ip_addresses	list of string	✔
cidr	string	✘
mac_address	string	✘
public_ip_address	string	✘
tags	google.protobuf.Struct	✘

ServerQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
server_id	string	✘
name	string	✘
state	string	✘
primary_ip_address	string	✘
ip_addresses	string	✘
os_type	OS_TYPE_NONE LINUX WINDOWS	✘
account	string	✘
instance_type	string	✘
provider	string	✘
cloud_service_group	string	✘
cloud_service_type	string	✘
region_code	string	✘
resource_group_id	string	✘
project_id	string	✘
project_group_id	string	✘
domain_id	string	✔

ServerReference

Field	Type	Description
resource_id	string
external_link	string

ServerRequest

Field	Type	Required	Description
server_id	string	✔
domain_id	string	✔

ServerStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔
resource_group_id	string	✘

ServersInfo

Field	Type	Description
results	list of ServerInfo
total_count	int32

UpdateServerRequest

Field	Type	Required	Description
server_id	string	✔
name	string	✘
primary_ip_address	string	✘
os_type	OS_TYPE_NONE LINUX WINDOWS	✘
account	string	✘
instance_type	string	✘
launched_at	string	✘
provider	string	✘
cloud_service_group	string	✘
cloud_service_type	string	✘
region_code	string	✘
data	google.protobuf.Struct	✘
metadata	google.protobuf.Struct	✘
nics	list of ServerNIC	✘
disks	list of ServerDisk	✘
reference	ServerReference	✘
tags	google.protobuf.Struct	✘
project_id	string	✘
domain_id	string	✔
release_region	bool	✘
release_project	bool	✘