调用GetDeviceForm根据ID查询设备形态详情

根据ID查询设备形态详情。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DeviceFormId	string	是	设备形态ID。	form-u4ilnhu64h026lrf
InstanceId	string	是	实例ID。	cmn-cn-xxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response。
RequestId	string	请求ID。	6d439436-ddde-4f26-aaf6-0470099b5c35
DeviceForm	object	设备形态对象。
ConfigCompare	boolean	是否支持配置生成。	true
AttributeList	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
AttributeSequence	integer	前端展示次序。	1
DeviceFormId	string	设备形态ID。	form-u4ilnhu64h026lrf
DeviceFormName	string	设备形态名称。	网络设备
FormBuiltIn	boolean	设备形态是否内置。	true
AccountConfig	boolean	是否需要账号配置。	true
DetailDisplay	boolean	是否展示设备详情。	true
UniqueKey	string	设备形态主键。	SN
Script	string	设备配置采集脚本。	@login_device\r\ndef config_backup():\r\n exec_cli('config', strict=False, timeout=120)\r\n return exec_cli('show configuration interface ethernet0/1', timeout=180)
ResourceUse	string	资源用途。	DEV_OPS

示例

正常返回示例

JSON格式

{
  "RequestId": "6d439436-ddde-4f26-aaf6-0470099b5c35",
  "DeviceForm": {
    "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,
        "AttributeSequence": 1
      }
    ],
    "DeviceFormId": "form-u4ilnhu64h026lrf",
    "DeviceFormName": "网络设备",
    "FormBuiltIn": true,
    "AccountConfig": true,
    "DetailDisplay": true,
    "UniqueKey": "SN",
    "Script": "@login_device\\r\\ndef config_backup():\\r\\n    exec_cli('config', strict=False, timeout=120)\\r\\n    return exec_cli('show configuration interface ethernet0/1', timeout=180)",
    "ResourceUse": "DEV_OPS"
  }
}

错误码

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	服务不可用	-

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