创建新的设备。
调试
您可以在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 | 服务不可用 | - |
访问错误中心查看更多错误码。