獲取設(shè)備形態(tài)列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cmn:ListDeviceForms | list |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MaxResults | integer | 否 | 返回結(jié)果的最大個(gè)數(shù)，如果不填寫(xiě)則返回所有符合條件的設(shè)備形態(tài)。 | 10 |
| NextToken | string | 否 | 當(dāng)總結(jié)果個(gè)數(shù)大于 MaxResults 時(shí)，用于翻頁(yè)的 token。 | 1 |
| InstanceId | string | 是 | 實(shí)例 ID。 | cmn-cn-xxxx |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"DeviceForms": [
{
"ConfigCompare": true,
"AttributeList": [
{
"AttributeKey": "serviceStatus",
"AttributeName": "服務(wù)狀態(tài)",
"AttributeRequirement": true,
"AttributeUniqueness": false,
"AttributeFormat": "STRING",
"AttributeType": "ENUMS",
"AttributeReference": "status",
"AttributeTableDisplay": true,
"AttributePlaceholder": "前端占位符說(shuō)明",
"AttributeQuery": false,
"AttributeFuzzyQuery": false,
"AttributeBuiltIn": true,
"AttributeContent": "ASW",
"AttributeSequence": 1
}
],
"AccountConfig": true,
"DetailDisplay": true,
"FormBuiltIn": true,
"UniqueKey": "SN",
"DeviceFormId": "form-u4ilnhu64h026lrf",
"DeviceFormName": "網(wǎng)絡(luò)設(shè)備",
"RelatedDeviceFormId": "form-4gnk12c2pdp4qu42",
"Script": "@login_device\\r\\ndef config_backup():\\r\\n exec_cli('show license', timeout=120)\\r\\n return exec_cli('show config', timeout=180)",
"ResourceUse": "DEV_OPS"
}
],
"TotalCount": 100,
"RequestId": "6d439436-ddde-4f26-aaf6-0470099b5c35",
"NextToken": 11,
"MaxResults": 10
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 |
|---|---|---|
| 400 | SignatureDoesNotMatch | 簽名不通過(guò) |
| 403 | NoPermission | 沒(méi)有權(quán)限 |
| 404 | ServiceNotFound | 后端服務(wù)未找到 |
| 500 | InternalError | 服務(wù)器內(nèi)部錯(cuò)誤 |
| 503 | ServiceUnavailable | 服務(wù)不可用 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。