物理设备明细 - QueryPhysicalDeviceDetails

功能

查询物理设备明细。

SLA项	定义
请求成功率	≥99%
可用性	Tier 2
数据一致性	强一致
吞吐量	60 次/分钟
TP50请求时延	200 ms
TP99.9请求时延	300 ms

注意事项

无

调用方法

GET

URI

/rest/dataapi/homs/open-api/v1/DeviceAsset/info

路径参数

无

查询参数

参数	是否必选	类型	值域	描述
device_type	否	string	无	设备类型：server/switch/firewall/router等。
page_size	是	int	0~1000	页大小。
offset_value	是	int	无	查询起始值。

请求

请求header参数

参数	是否必选	类型	值域	说明
X-APIG-Appcode	是	string	无	由SRE分配的AppCode。
x-auth-token	是	string	无	调用方APIG的IAM认证token。
x-hcso-domainid	是（HCSO场景）否（其他场景）	string	无	接入的租户ID。
x-hcso-appcode	是	string	无	由SRE分配的AppCode

请求body参数
无

请求示例

GET /rest/dataapi/homs/open-api/v1/DeviceAsset/info HTTP/1.1 
Host: example.com 
Content-Type: application/json 
Accept: application/json
X-APIG-Appcode: xxx 
x-auth-token: xxx 
x-hcso-domainid：xxx 
x-hcso-appcode：xxx

响应

响应参数

响应状态码200：返回Data对象。Data对象包含如下属性：

参数	是否必选	类型	值域	说明
total	是	int32	无	数据总数量。
list	是	List<Item>	无	流程对象。

Item对象包含如下属性：

参数	是否必选	类型	值域	说明
device_id	是	string	无	设备ID。
name	是	string	无	设备名称。
device_type	是	int32	无	设备类型。
running_status	是	string	无	设备运行状态。
model	是	string	无	设备规格。
management_ip	是	string	无	设备管理口IP。
os	是	string	无	设备操作系统。
region	是	string	无	区域Code。

响应示例

HTTP/1.1 200 OK
Date:Tue,18 Jul 2023 09:58:01 GMT
Server: example.com
Content-Type: application/json;charset=UTF8 
{ 
    "total": "33", 
    "list": [ 
             { 
             "device_id": "物理设备ID", 
             "name": "设备名称", 
             "device_type": "设备类型", 
             "running_status": "运行状态", 
             "model": "设备规格", 
             "management_ip": "设备管理口IP", 
             "os": "设备操作系统", 
             "region": "cn-north-1" 
              } 
             ] 
}