编辑已经存在的设备形态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cmn:UpdateDeviceForm |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DeviceFormId | string | 是 | 设备形态 ID。 | form-u4ilnhu64h026lrf |
| ConfigCompare | boolean | 否 | 是否支持配置生成。 | true |
| AccountConfig | boolean | 否 | 是否需要账号配置。 | true |
| AttributeList | array<object> | 否 | 设备形态属性列表。 | true |
| object | 否 | 设备形态对象。 | ||
| AttributeKey | string | 是 | 设备形态属性主键。 | serviceStatus |
| AttributeName | string | 是 | 设备形态属性名称。 | 服务状态 |
| AttributeRequirement | boolean | 是 | 设备形态属性是否必填。 | true |
| AttributeUniqueness | boolean | 是 | 设备形态属性是否唯一。 | false |
| AttributeFormat | string | 是 | 设备形态属性值格式。 | STRING |
| AttributeType | string | 否 | 设备形态属性值类型。 | ENUMS |
| AttributeReference | string | 否 | 设备形态属性关联对象。 | status |
| AttributeTableDisplay | boolean | 是 | 设备形态属性是否表格可见。 | 服务状态 |
| AttributePlaceholder | string | 否 | 前端查询控件占位符。 | 前端占位符说明 |
| AttributeQuery | boolean | 否 | 是否前端展示搜索控件。 | false |
| AttributeFuzzyQuery | boolean | 否 | 是否支持模糊搜索。 | false |
| AttributeSequence | integer | 否 | 前端展示次序。 | 1 |
| DetailDisplay | boolean | 否 | 是否展示设备详情。 | true |
| InstanceId | string | 是 | 实例 ID。 | cmn-cn-xxx |
| RelatedDeviceFormId | string | 否 | 关联设备形态 ID。 | form-4gnk12c2pdp4qu42 |
| Script | string | 否 | 设备配置文件查询脚本。 | @login_device\r\ndef config_backup():\r\n exec_cli('show license', timeout=120)\r\n return exec_cli('show config', timeout=180) |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "15292160-382F-46F2-B241-95EFB54BA434"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Duplicate%s%s | The %s %s value is already occupied. | 资源属性值已经被占用 |
| 400 | Missing%s | You must specify the parameter %s. | 必填参数没有填。请检查调用时是否填写了此参数，并重试请求。 |
| 400 | SignatureDoesNotMatch | 签名不通过 | - |
| 403 | NoAccess.BuiltIn%s | The built in configuration does not permit the operation. | 内置配置不允许操作 |
| 403 | NoPermission | 没有权限 | - |
| 404 | ServiceNotFound | 后端服务未找到 | - |
| 500 | InternalError | 服务器内部错误 | - |
| 503 | ServiceUnavailable | 服务不可用 | - |
访问错误中心查看更多错误码。