根据ID查询设备形态详情

调试

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

请求参数

名称 类型 是否必选 示例值 描述
DeviceFormId String form-u4ilnhu64h026lrf

实例 ID。

InstanceId String cmn-cn-xxxx

实例ID

返回数据

名称 类型 示例值 描述
RequestId String 6d439436-ddde-4f26-aaf6-0470099b5c35

Id of the request

DeviceForm object

设备详情

ConfigCompare Boolean true

是否支持配置生成

AttributeList Array of attributeList

设备形态属性列表

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

设备形态属性是否内置

DeviceFormId String form-u4ilnhu64h026lrf

设备形态ID

DeviceFormName String 网络设备

设备形态名称

FormBuiltIn Boolean true

设备形态是否内置

AccountConfig Boolean true

是否需要账号配置

DetailDisplay Boolean true

是否展示设备详情

UniqueKey String SN

设备形态主键

示例

请求示例

http(s)://[Endpoint]/?DeviceFormId=form-u4ilnhu64h026lrf
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeviceForm>
    <ConfigCompare>true</ConfigCompare>
    <DeviceFormId>form-u4ilnhu64h026lrf</DeviceFormId>
    <DeviceFormName>网络设备</DeviceFormName>
    <UniqueKey>SN</UniqueKey>
    <AttributeList>
        <AttributeKey>serviceStatus</AttributeKey>
        <AttributeFormat>STRING</AttributeFormat>
        <AttributeTableDisplay>true</AttributeTableDisplay>
        <AttributeRequirement>true</AttributeRequirement>
        <AttributePlaceholder>前端占位符说明</AttributePlaceholder>
        <AttributeQuery>false</AttributeQuery>
        <AttributeType>ENUMS</AttributeType>
        <AttributeReference>status</AttributeReference>
        <AttributeName>服务状态</AttributeName>
        <AttributeBuiltIn>true</AttributeBuiltIn>
        <AttributeUniqueness>false</AttributeUniqueness>
        <AttributeFuzzyQuery>false</AttributeFuzzyQuery>
    </AttributeList>
    <DetailDisplay>true</DetailDisplay>
    <FormBuiltIn>true</FormBuiltIn>
    <AccountConfig>true</AccountConfig>
</DeviceForm>
<RequestId>6d439436-ddde-4f26-aaf6-0470099b5c35</RequestId>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DeviceForm" : {
    "ConfigCompare" : "true",
    "DeviceFormId" : "form-u4ilnhu64h026lrf",
    "DeviceFormName" : "网络设备",
    "UniqueKey" : "SN",
    "AttributeList" : [ {
      "AttributeKey" : "serviceStatus",
      "AttributeFormat" : "STRING",
      "AttributeTableDisplay" : "true",
      "AttributeRequirement" : "true",
      "AttributePlaceholder" : "前端占位符说明",
      "AttributeQuery" : "false",
      "AttributeType" : "ENUMS",
      "AttributeReference" : "status",
      "AttributeName" : "服务状态",
      "AttributeBuiltIn" : "true",
      "AttributeUniqueness" : "false",
      "AttributeFuzzyQuery" : "false"
    } ],
    "DetailDisplay" : "true",
    "FormBuiltIn" : "true",
    "AccountConfig" : "true"
  },
  "RequestId" : "6d439436-ddde-4f26-aaf6-0470099b5c35"
}

错误码

HttpCode 错误码 错误信息 描述
400 Missing%s You must specify the parameter %s. 必填参数没有填。请检查调用时是否填写了此参数,并重试请求。
404 Invalid%s.NotFound The specified resource %s does not exist. 找不到对应资源

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

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