分頁獲取設備列表。
調試
您可以在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 錯誤碼發生變更 | 查看變更詳情 |