Server

Package : spaceone.api.inventory.v1

Server

Server Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateServerRequest	ServerInfo
2	update	UpdateServerRequest	ServerInfo
3	pin_data	PinServerDataRequest	ServerInfo
4	delete	ServerRequest	google.protobuf.Empty
5	get	GetServerRequest	ServerInfo
6	list	ServerQuery	ServersInfo
7	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

No	Field	Type	Required	Description
1	name	string	❌
2	state	STATE_NONE PENDING INSERVICE MAINTENANCE CLOSED DELETED	❌
3	primary_ip_address	string	❌
4	server_type	SERVER_TYPE_NONE BAREMETAL VM HYPERVISOR UNKNOWN	❌
5	os_type	OS_TYPE_NONE LINUX WINDOWS	✅
6	provider	string	❌
7	region_code	string	❌
8	region_type	string	❌
9	data	google.protobuf.Struct	❌
10	metadata	google.protobuf.Struct	❌
11	nics	list of ServerNIC	❌
12	disks	list of ServerDisk	❌
13	reference	ServerReference	❌
14	tags	google.protobuf.Struct	❌
15	project_id	string	❌
16	domain_id	string	✅

GetServerRequest

No	Field	Type	Required	Description
1	server_id	string	✅
2	domain_id	string	✅
3	only	list of string	❌

PinServerDataRequest

No	Field	Type	Required	Description
1	server_id	string	✅
2	keys	list of string	✅
3	domain_id	string	✅

ServerDisk

No	Field	Type	Required	Description
1	device_index	int32	✅
2	device	string	❌
3	disk_type	string	❌
4	size	float	❌
5	tags	google.protobuf.Struct	❌

ServerInfo

No	Field	Type	Description
1	server_id	string
2	name	string
3	state	STATE_NONE PENDING INSERVICE MAINTENANCE CLOSED DELETED
4	primary_ip_address	string
5	ip_addresses	google.protobuf.ListValue
6	server_type	SERVER_TYPE_NONE BAREMETAL VM HYPERVISOR UNKNOWN
7	os_type	OS_TYPE_NONE LINUX WINDOWS
8	provider	string
9	region_code	string
10	region_type	string
11	data	google.protobuf.Struct
12	metadata	google.protobuf.Struct
13	nics	list of ServerNIC
14	disks	list of ServerDisk
15	reference	ServerReference
16	tags	google.protobuf.Struct
17	collection_info	google.protobuf.Struct
18	project_id	string
19	domain_id	string
20	created_at	google.protobuf.Timestamp
21	updated_at	google.protobuf.Timestamp
22	deleted_at	google.protobuf.Timestamp

ServerNIC

No	Field	Type	Required	Description
1	device_index	int32	✅
2	device	string	❌
3	nic_type	string	❌
4	ip_addresses	list of string	✅
5	cidr	string	❌
6	mac_address	string	❌
7	public_ip_address	string	❌
8	tags	google.protobuf.Struct	❌

ServerQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	server_id	string	❌
3	name	string	❌
4	state	string	❌
5	primary_ip_address	string	❌
6	ip_addresses	string	❌
7	server_type	SERVER_TYPE_NONE BAREMETAL VM HYPERVISOR UNKNOWN	❌
8	os_type	OS_TYPE_NONE LINUX WINDOWS	❌
9	provider	string	❌
10	region_code	string	❌
11	region_type	string	❌
12	resource_group_id	string	❌
13	project_id	string	❌
14	domain_id	string	✅

ServerReference

No	Field	Type	Description
1	resource_id	string
2	external_link	string

ServerRequest

No	Field	Type	Required	Description
1	server_id	string	✅
2	domain_id	string	✅

ServerStatQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.StatisticsQuery	✅
2	domain_id	string	✅
3	resource_group_id	string	❌

ServersInfo

No	Field	Type	Description
1	results	list of ServerInfo
2	total_count	int32

UpdateServerRequest

No	Field	Type	Required	Description
1	server_id	string	✅	server unique id
2	name	string	❌
3	state	STATE_NONE PENDING INSERVICE MAINTENANCE CLOSED DELETED	❌
4	primary_ip_address	string	❌
5	server_type	SERVER_TYPE_NONE BAREMETAL VM HYPERVISOR UNKNOWN	❌
6	os_type	OS_TYPE_NONE LINUX WINDOWS	❌
7	provider	string	❌
8	data	google.protobuf.Struct	❌
9	metadata	google.protobuf.Struct	❌
10	nics	list of ServerNIC	❌
11	disks	list of ServerDisk	❌
12	reference	ServerReference	❌
13	tags	google.protobuf.Struct	❌
14	region_code	string	❌
15	region_type	string	❌
16	project_id	string	❌
17	domain_id	string	✅
18	release_region	bool	❌
19	release_project	bool	❌