分页获取设备列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cmn:ListDevices | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MaxResults | integer | 否 | 返回结果的最大个数。 | 10 |
| NextToken | string | 否 | 当总结果个数大于 MaxResults 时，用于翻页的 token。 | 1 |
| DeviceFormId | string | 否 | 设备形态 ID。 | form-u4ilnhu64h026lrf |
| DeviceFormName | string | 否 | 设备形态名称。 | 网络设备 |
| PhysicalSpaceId | string | 否 | 物理空间 ID。 | space-ez6zd3w68ma4fsd4 |
| HostName | array | 否 | 设备主机名列表。 | |
| string | 否 | 设备主机名。 | HZYT_**** | |
| Ip | array | 否 | 设备 IP 列表。 | |
| string | 否 | 设备 IP。 | 127.0.**.*** | |
| Sn | array | 否 | 设备 SN 列表。 | |
| string | 否 | 设备 SN。 | 2022***** | |
| Mac | array | 否 | 设备 MAC 列表。 | |
| string | 否 | 设备 MAC。 | 01:1b*** | |
| Vendor | array | 否 | 设备厂商列表。 | |
| string | 否 | 设备厂商。 | Alibaba | |
| Model | array | 否 | 设备型号列表。 | |
| string | 否 | 设备型号。 | SAG-1000 | |
| ServiceStatus | array | 否 | 设备服务状态列表。 | |
| string | 否 | 设备服务状态。 | one | |
| SecurityDomain | array | 否 | 安全域列表。 | |
| string | 否 | 安全域。 | CMN-XA07 | |
| ExtAttributes | string | 否 | 设备额外属性。 | {"role":"ASW"} |
| InstanceId | string | 是 | 实例 ID。 | cmn-cn-xxx |
| Keyword | string | 否 | 模糊查询值。 | G1QH55J****** |
| PhysicalSpaceIds | array | 否 | 物理空间 ID 列表。 | |
| string | 否 | 物理空间 ID。 | space-ez6zd3w68ma4fsd4 | |
| DeviceIds | array | 否 | 设备 ID 列表。 | |
| string | 否 | 设备 ID。 | device-2nq3str0d65rxdp6 | |
| CalculateAmount | boolean | 否 | 是否统计。 | true |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 100,
"NetworkCoefficient": 1,
"ServerCoefficient": 1,
"IotCoefficient": 1,
"OtherCoefficient": 1,
"NetworkMaintenanceCoefficient": 1,
"ServerMaintenanceCoefficient": 1,
"AmountDetail": "{\"networkOnlineCount\":11,\"serverOnlineCount\":7,\"iotOnlineCount\":2,\"otherOnlineCount\":0,\"networkMaintainCount\":0,\"serverMaintainCount\":0,\"iotMaintainCount\":0,\"otherMaintainCount\":0,\"networkUdfStatusCount\":5,\"serverUdfStatusCount\":0,\"iotUdfStatusCount\":0,\"otherUdfStatusCount\":0,\"ratioNetworkCount\":16,\"ratioServerCount\":3,\"ratioIotCount\":0,\"ratioOtherCount\":0}",
"RequestId": "fdb2af01-bd56-4034-812b-f257f73b4690",
"NextToken": 10,
"Devices": [
{
"DeviceId": "device-evve560juend5owh",
"DeviceFormName": "网络设备",
"DeviceFormId": "form-u4ilnhu64h026lrf",
"PhysicalSpaceId": "space-ez6zd3w68ma4fsd4",
"PhysicalSpaceName": "阿里巴巴西溪园区",
"HostName": "HZYT_****\n",
"Ip": "127.0.**.***\n",
"Sn": "2022*****\n",
"Mac": "01:1b***",
"Vendor": "Alibaba",
"Model": "SAG-1000\n",
"SecurityDomain": "IT",
"ServiceStatus": "online",
"LoginType": "SSH,TELNET",
"LoginUsername": "admin",
"LoginPassword": "pass****\n",
"EnablePassword": "pass****",
"SnmpAccountVersion": "v3",
"SnmpCommunity": "pass****\n",
"SnmpAccountType": "get",
"SnmpSecurityLevel": "AUTH_PRIV",
"SnmpUsername": "admin",
"SnmpAuthPassphrase": "pass****\n",
"SnmpAuthProtocol": "MD5",
"SnmpPrivacyPassphrase": "pass****\n",
"SnmpPrivacyProtocol": "DES",
"ExtAttributes": "{\"role\":\"ASW\"}",
"GmtCreate": "2022-11-08 09:00:58",
"GmtModified": "2023-01-16 09:43:20"
}
],
"MaxResults": 10,
"AmountUsed": 10
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Missing%s | You must specify the parameter %s. | 必填参数没有填。请检查调用时是否填写了此参数，并重试请求。 |
| 400 | SignatureDoesNotMatch | 签名不通过 | - |
| 403 | NoPermission | 没有权限 | - |
| 404 | Invalid%s.NotFound | The specified resource %s does not exist. | 找不到对应资源 |
| 404 | ServiceNotFound | 后端服务未找到 | - |
| 500 | InternalError | 服务器内部错误 | - |
| 503 | ServiceUnavailable | 服务不可用 | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-01-07 | OpenAPI 错误码发生变更 | 查看变更详情 |