Querying Host Configuration Details

Function

Query host configuration details.

SLA Item	Definition
Request success rate	≥ 99.9%
Availability	Tier 1
Data consistency	Eventual consistency can be achieved. The duration of inconsistency is less than 1 minute.
Throughput	4000 TPS
TP50 request latency	2 ms
TP99.9 request latency	5 ms

Precautions

None

Calling Method

GET

URI

/rest/dataapi/homs/open-api/v1/host/detail

Path parameters

None

Query parameters

Parameter	Mandatory	Type	Value Range	Description
begin_time	Yes	integer	None	Start time
end_time	Yes	integer	None	End time
offset_value	Yes	integer	None	Offset: greater than or equal to 0
page_size	Yes	integer	Default value: 500	Page size: greater than or equal to 0
host_id	No	string	None	Host ID

Request

Request header parameters

Parameter	Mandatory	Type	Value Range	Description
X-APIG-Appcode	Yes	string	None	AppCode allocated by SRE
x-auth-token	Yes	string	None	IAM authentication token for the calling party APIG
x-hcso-domainid	No	string	None	ID of the accessed tenant. This parameter is mandatory only in the HCS Online scenario.
x-hcso-appcode	Yes	string	None	AppCode allocated by SRE

Request body parameters
None

Sample request

GET /rest/dataapi/homs/open-api/v1/host/detail?begin_time=0&end_time=0&offset_value=0&page_size=1
Content-Type: application/json
Accept: application/json
X-Auth-Token: xxxxx
x-hcso-appcode: xxxx

Response

Response parameters

Sample response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF8
{
	"total": 1,
	"list": [
		{
			"REGION_ID": "cn-north-7",
			"HOST_ID": "dea41fb4-2583-45d7-a4b1-22d8d27c5024",
			"HOST_NAME": "ecs_4-CXXX034",
			"MANUFACTURER": "cn-north-7",
			"KERNEL": "0",
			"CPU": "[{"cores":"22","model":"Intel(R) Xeon(R) Gold 6161 CPU @ 2.20GHz","threads":"2","cpu":"2 * 22 * 2 * Intel(R) Xeon(R) Gold 6161 CPU @ 2.20GHz","sockets":"2"}]",
            "MEMORY": "[{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"}]",
            "DISK": "[{"disk":"/dev/sda:599.0GB"},{"disk":"/dev/sdb:1598.0GB"},{"disk":"/dev/sdc:10.7GB"}]",
            "MAC_IP": "xx.xx.xx.xx",
            "NETWORK_ADAPTER": "1",
            "RAID": "1",
            "SN": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb",
            "CPU_ARCH": "x86_64",
            "AZ_CODE": "1",
            "POD_CODE": "1",
            "CLUSTER_NAME": "ecs",
            "ROOM_CODE": "1",
            "RACK_CODE": "1",
            "DC_CODE": "1"
		}
	]
}