调用ListDeviceForms获取设备形态列表_云网管(CMN)-阿里云帮助中心

获取设备形态列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cmn:ListDeviceForms	list	DeviceForm acs:cmn:{#regionId}:{#accountId}:deviceform/*	无	无

请求参数

名称	类型	必填	描述	示例值
MaxResults	integer	否	返回结果的最大个数，如果不填写则返回所有符合条件的设备形态。	10
NextToken	string	否	当总结果个数大于 MaxResults 时，用于翻页的 token。	1
InstanceId	string	是	实例 ID。	cmn-cn-xxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
DeviceForms	array<object>	设备形态列表。
	object	设备形态对象。
ConfigCompare	boolean	是否支持配置生成。	true
AttributeList	array<object>	设备形态属性列表。
	object	设备形态属性对象。
AttributeKey	string	设备形态属性主键。	serviceStatus
AttributeName	string	设备形态属性名称。	服务状态
AttributeRequirement	boolean	设备形态属性是否必填。	true
AttributeUniqueness	boolean	设备形态属性是否唯一。	false
AttributeFormat	string	设备形态属性值格式。	STRING
AttributeType	string	设备形态属性值类型。	ENUMS
AttributeReference	string	设备形态属性关联对象。	status
AttributeTableDisplay	boolean	设备形态属性是否表格可见。	true
AttributePlaceholder	string	前端查询控件占位符。	前端占位符说明
AttributeQuery	boolean	前端是否展示对应的查询控件。	false
AttributeFuzzyQuery	boolean	前端查询控件是否支持模糊搜索。	false
AttributeBuiltIn	boolean	设备形态属性是否内置。	true
AttributeContent	string	属性值。	ASW
AttributeSequence	integer	展示次序。	1
AccountConfig	boolean	是否需要账号配置。	true
DetailDisplay	boolean	是否展示详情。	true
FormBuiltIn	boolean	设备形态是否内置。	true
UniqueKey	string	设备形态主键。	SN
DeviceFormId	string	设备形态 ID。	form-u4ilnhu64h026lrf
DeviceFormName	string	设备形态名称。	网络设备
RelatedDeviceFormId	string	关联设备形态 ID。	form-4gnk12c2pdp4qu42
Script	string	设备配置采集脚本。	@login_device\r\ndef config_backup():\r\n exec_cli('show license', timeout=120)\r\n return exec_cli('show config', timeout=180)
ResourceUse	string	资源用途。	DEV_OPS
TotalCount	integer	总记录数。	100
RequestId	string	请求 ID。	6d439436-ddde-4f26-aaf6-0470099b5c35
NextToken	integer	当总结果个数大于 MaxResults 时，用于翻页的 token。	11
MaxResults	integer	每页数量。	10

示例

正常返回示例

JSON格式

{
  "DeviceForms": [
    {
      "ConfigCompare": true,
      "AttributeList": [
        {
          "AttributeKey": "serviceStatus",
          "AttributeName": "服务状态",
          "AttributeRequirement": true,
          "AttributeUniqueness": false,
          "AttributeFormat": "STRING",
          "AttributeType": "ENUMS",
          "AttributeReference": "status",
          "AttributeTableDisplay": true,
          "AttributePlaceholder": "前端占位符说明",
          "AttributeQuery": false,
          "AttributeFuzzyQuery": false,
          "AttributeBuiltIn": true,
          "AttributeContent": "ASW",
          "AttributeSequence": 1
        }
      ],
      "AccountConfig": true,
      "DetailDisplay": true,
      "FormBuiltIn": true,
      "UniqueKey": "SN",
      "DeviceFormId": "form-u4ilnhu64h026lrf",
      "DeviceFormName": "网络设备",
      "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
}

错误码

HTTP status code	错误码	错误信息
400	SignatureDoesNotMatch	签名不通过
403	NoPermission	没有权限
404	ServiceNotFound	后端服务未找到
500	InternalError	服务器内部错误
503	ServiceUnavailable	服务不可用

访问错误中心查看更多错误码。