文档

ListDeviceForms - 获取设备形态列表

更新时间:

获取设备形态列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cmn:ListDeviceFormsLIST
  • DeviceForm
    acs:cmn:{#regionId}:{#accountId}:deviceform/*

请求参数

名称类型必填描述示例值
MaxResultsinteger

返回结果的最大个数,如果不填写则返回所有符合条件的设备形态。

10
NextTokenstring

当总结果个数大于 MaxResults 时,用于翻页的 token。

1
InstanceIdstring

实例 ID。

cmn-cn-xxxx

返回参数

名称类型描述示例值
object

Schema of Response

DeviceFormsobject []

设备形态列表。

ConfigCompareboolean

是否支持配置生成。

true
AttributeListobject []

设备形态属性列表。

AttributeKeystring

设备形态属性主键。

serviceStatus
AttributeNamestring

设备形态属性名称。

服务状态
AttributeRequirementboolean

设备形态属性是否必填。

true
AttributeUniquenessboolean

设备形态属性是否唯一。

false
AttributeFormatstring

设备形态属性值格式。

STRING
AttributeTypestring

设备形态属性值类型。

ENUMS
AttributeReferencestring

设备形态属性关联对象。

status
AttributeTableDisplayboolean

设备形态属性是否表格可见。

true
AttributePlaceholderstring

前端查询控件占位符。

前端占位符说明
AttributeQueryboolean

前端是否展示对应的查询控件。

false
AttributeFuzzyQueryboolean

前端查询控件是否支持模糊搜索。

false
AttributeBuiltInboolean

设备形态属性是否内置。

true
AttributeContentstring

属性值。

ASW
AttributeSequenceinteger

展示次序。

1
AccountConfigboolean

是否需要账号配置。

true
DetailDisplayboolean

是否展示详情。

true
FormBuiltInboolean

设备形态是否内置。

true
UniqueKeystring

设备形态主键。

SN
DeviceFormIdstring

设备形态 ID。

form-u4ilnhu64h026lrf
DeviceFormNamestring

设备形态名称。

网络设备
RelatedDeviceFormIdstring

关联设备形态 ID。

form-4gnk12c2pdp4qu42
Scriptstring

设备配置采集脚本。

@login_device\r\ndef config_backup():\r\n exec_cli('show license', timeout=120)\r\n return exec_cli('show config', timeout=180)
ResourceUsestring

资源用途。

DEV_OPS
TotalCountinteger

总记录数。

100
RequestIdstring

请求 ID。

6d439436-ddde-4f26-aaf6-0470099b5c35
NextTokeninteger

当总结果个数大于 MaxResults 时,用于翻页的 token。

11
MaxResultsinteger

每页数量。

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错误码错误信息
400SignatureDoesNotMatch签名不通过
403NoPermission没有权限
404ServiceNotFound后端服务未找到
500InternalError服务器内部错误
503ServiceUnavailable服务不可用

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

  • 本页导读 (0)
文档反馈