首页 云网管 开发参考 API参考 API目录 资源管理相关 ListDeviceProperties - 获取设备属性列表

ListDeviceProperties - 获取设备属性列表

更新时间: 2024-08-06 14:45:16

获取设备属性列表。

调试

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

授权信息

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

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

请求参数

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

返回结果的最大个数。

10
NextTokenstring

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

1
DeviceFormIdstring

设备形态 ID

form-u4ilnhu64h026lrf
InstanceIdstring

实例 ID

cmn-cn-xxx

返回参数

名称类型描述示例值
object

Schema of Response

DevicePropertiesarray<object>

数组,返回示例目录。

object

设备属性

DevicePropertyIdstring

设备属性 ID

property-z50wex75a1lkx7vx
DeviceFormIdstring

设备形态 ID

form-u4ilnhu64h026lrf
DeviceFormNamestring

设备形态名称

网络设备
PropertyNamestring

属性名称

厂商型号
PropertyKeystring

属性主键

device_model
PropertyFormatstring

属性格式

JSON
PropertyContentstring

属性内容

{ "H3C": [ "H3C S6800", "S6850-56HF" ], "Huawei": [ "CE6851-48S6Q" ] }
BuiltInboolean

是否内置属性

true
NextTokeninteger

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

10
RequestIdstring

Id of the request

1f598491-db6d-4276-a83a-3b5f57d4a4e1
TotalCountinteger

总记录数。

100
MaxResultsinteger

每页数量。

10

示例

正常返回示例

JSON格式

{
  "DeviceProperties": [
    {
      "DevicePropertyId": "property-z50wex75a1lkx7vx",
      "DeviceFormId": "form-u4ilnhu64h026lrf",
      "DeviceFormName": "网络设备",
      "PropertyName": "厂商型号",
      "PropertyKey": "device_model",
      "PropertyFormat": "JSON",
      "PropertyContent": "{   \"H3C\": [     \"H3C S6800\",     \"S6850-56HF\"   ],   \"Huawei\": [     \"CE6851-48S6Q\"   ] }",
      "BuiltIn": true
    }
  ],
  "NextToken": 10,
  "RequestId": "1f598491-db6d-4276-a83a-3b5f57d4a4e1",
  "TotalCount": 100,
  "MaxResults": 10
}

错误码

HTTP status code错误码错误信息描述
400SignatureDoesNotMatch签名不通过-
403NoPermission没有权限-
404Invalid%s.NotFoundThe specified resource %s does not exist.找不到对应资源
404ServiceNotFound后端服务未找到-
500InternalError服务器内部错误-
503ServiceUnavailable服务不可用-

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

上一篇: CreateDeviceProperty - 创建新的设备属性 下一篇: GetDeviceProperty - 根据ID查询设备属性详情