获取设备属性列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cmn:ListDeviceProperties | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MaxResults | integer | 是 | 返回结果的最大个数。 | 10 |
NextToken | string | 否 | 当总结果个数大于 MaxResults 时,用于翻页的 token。 | 1 |
DeviceFormId | string | 否 | 设备形态 ID | form-u4ilnhu64h026lrf |
InstanceId | string | 是 | 实例 ID | cmn-cn-xxx |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SignatureDoesNotMatch | 签名不通过 | - |
403 | NoPermission | 没有权限 | - |
404 | Invalid%s.NotFound | The specified resource %s does not exist. | 找不到对应资源 |
404 | ServiceNotFound | 后端服务未找到 | - |
500 | InternalError | 服务器内部错误 | - |
503 | ServiceUnavailable | 服务不可用 | - |
访问错误中心查看更多错误码。