根据ID查询设备形态详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cmn:GetDeviceForm | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DeviceFormId | string | 是 | 设备形态 ID。 | form-u4ilnhu64h026lrf |
| InstanceId | string | 是 | 实例 ID。 | cmn-cn-xxxx |
返回参数
示例
正常返回示例
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 | 服务不可用 | - |
访问错误中心查看更多错误码。