編輯已經存在的設備形態。
調試
您可以在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 | 服務不可用 | - |
訪問錯誤中心查看更多錯誤碼。