創建新的設備。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cmn:CreateDevice |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DeviceFormId | string | 是 | 設備形態 ID | form-u4ilnhu64h026lrf |
| PhysicalSpaceId | string | 是 | 物理空間 ID | space-ez6zd3w68ma4fsd4 |
| HostName | string | 否 | 主機名 | HZYT_**** |
| Ip | string | 否 | 設備 IP | 127.0.**.*** |
| Sn | string | 否 | 設備 SN | 2022***** |
| Mac | string | 否 | 設備 MAC 地址 | 01:1b*** |
| Vendor | string | 否 | 設備廠商 | Alibaba |
| Model | string | 否 | 設備型號 | SAG-1000 |
| ServiceStatus | string | 否 | 設備狀態 枚舉值：
| online |
| SecurityDomain | string | 否 | 設備安全域 | Test |
| LoginType | string | 否 | 登錄類型 枚舉值：
| SSH,TELNET |
| LoginUsername | string | 否 | 登錄賬號 | admin |
| LoginPassword | string | 否 | 登錄密碼 | pass**** |
| EnablePassword | string | 否 | enable 密碼 | pass**** |
| SnmpAccountVersion | string | 否 | SNMP 版本號 | v3 |
| SnmpCommunity | string | 否 | SNMP Community | pass**** |
| SnmpAccountType | string | 否 | SNMP 賬號類型 | get |
| SnmpSecurityLevel | string | 否 | SNMP 安全級別 | AUTH_PRIV |
| SnmpUsername | string | 否 | SNMP 用戶名 | admin |
| SnmpAuthPassphrase | string | 否 | SNMP Auth PassPhrase | pass**** |
| SnmpAuthProtocol | string | 否 | SNMP Auth Protocol | MD5 |
| SnmpPrivacyPassphrase | string | 否 | SNMP Privacy Passphrase | 145c44bb2f34610154e84dbe2a7ade04 |
| SnmpPrivacyProtocol | string | 否 | SNMP Privacy Protocol | DES |
| ExtAttributes | string | 否 | 設備額外屬性 | {"role":"ASW"} |
| ClientToken | string | 是 | 冪等校驗 token | 9388616d-2d78-48c9-87b7-3d1083c91a79 |
| InstanceId | string | 是 | 實例 ID | cmn-cn-xxx |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "fdb2af01-bd56-4034-812b-f257f73b4690",
"DeviceId": "device-evve560juend5owh"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Missing%s | You must specify the parameter %s. | 必填參數沒有填。請檢查調用時是否填寫了此參數，并重試請求。 |
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | 用了一個已經使用過的 ClientToken，但此次請求內容卻又與上一次使用該 Token 的 request 不一樣。 |
| 400 | ActionNotAvailable | The action is not available. | 操作不可用 |
| 400 | Duplicate%s%s | The %s %s value is already occupied. | 資源屬性值已經被占用 |
| 400 | InvalidMonitorItem.NotSame | The selected list contains different monitoring items. Please select the subscription items of the same monitoring item. | 列表中包含不同的監控項，請選擇相同監控項 |
| 400 | InvalidParameter%s | The specified parameter %s is invalid. | 參數無效，請檢查參數 |
| 400 | InvalidParameter.TooMuch | You cannot fill in device whitelist and blacklist at the same time. | 設備白名單和設備黑名單不能同時填寫 |
| 400 | InvalidScheme.NotEnable | The scheme is not enabled. | 方案未啟用 |
| 400 | InvalidScheme.StepNotAvailable | Some steps of the scheme are unavailable. | 方案存在不可用步驟 |
| 400 | InvalidTimeStamp | The timestamp value must not be earlier than the current time. | 傳入時間不得早于當前時間 |
| 400 | InvalidTimeStamp.Format | The format of specified timestamp or date value is invalid. | 時間戳格式不對。請檢查您的時間戳的格式是否正確。 |
| 400 | NoAccess.ResourceInUse | The resource % is used by resource %s. | 使用中的資源不支持該操作 |
| 400 | NoMoreResources | No more resources are available. %s | 無更多資源 |
| 400 | QuotaTooMuch | Quota exceeds limit. | 資源配額超過限制。 |
| 400 | ScriptCompileError.Line%s | A compile error occurred at line %s. | 腳本編譯錯誤 |
| 400 | SignatureDoesNotMatch | 簽名不通過 | - |
| 403 | NoAccess.BuiltIn%s | The built in configuration does not permit the operation. | 內置配置不允許操作 |
| 403 | NoPermission | 沒有權限 | - |
| 404 | Invalid%s.NotFound | The specified resource %s does not exist. | 找不到對應資源 |
| 404 | ServiceNotFound | 后端服務未找到 | - |
| 500 | InternalError | 服務器內部錯誤 | - |
| 503 | ServiceUnavailable | 服務不可用 | - |
訪問錯誤中心查看更多錯誤碼。