创建新的设备形态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDeviceForm | 系统规定参数。取值:CreateDeviceForm。 |
DeviceFormName | String | 是 | 网络设备 | 设备形态名称。 |
ConfigCompare | Boolean | 否 | true | 是否支持配置生成。 |
AccountConfig | Boolean | 否 | true | 是否需要账号配置。 |
DetailDisplay | Boolean | 否 | true | 是否展示设备详情。 |
UniqueKey | String | 否 | SN | 设备形态的主键。 |
ClientToken | String | 是 | c6aaac41-8cfa-4952-bb1c-1ad9617ab23f | 幂等校验 token。 |
InstanceId | String | 是 | cmn-cn-xxxx | 实例ID。 |
RelatedDeviceFormId | String | 否 | form-u4ilnhu64h026lrf | 关联设备形态ID。 |
Script | String | 否 | def func(dev):\n \n return datetime.datetime.strptime(datetime.datetime.now(), '%Y') | 设备代码。 |
ResourceUse | String | 否 | ASSET | 资源用途。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DeviceFormId | String | form-u4ilnhu64h026lrf | 设备形态ID。 |
RequestId | String | 6d439436-ddde-4f26-aaf6-0470099b5c35 | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateDeviceForm
&DeviceFormName=网络设备
&ConfigCompare=true
&AccountConfig=true
&DetailDisplay=true
&UniqueKey=SN
&ClientToken=c6aaac41-8cfa-4952-bb1c-1ad9617ab23f
&InstanceId=cmn-cn-xxxx
&RelatedDeviceFormId=form-u4ilnhu64h026lrf
&Script=def func(dev):\n \n return datetime.datetime.strptime(datetime.datetime.now(), '%Y')
&ResourceUse=ASSET
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateDeviceFormResponse>
<DeviceFormId>form-u4ilnhu64h026lrf</DeviceFormId>
<RequestId>6d439436-ddde-4f26-aaf6-0470099b5c35</RequestId>
</CreateDeviceFormResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DeviceFormId" : "form-u4ilnhu64h026lrf",
"RequestId" : "6d439436-ddde-4f26-aaf6-0470099b5c35"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Duplicate%s%s | The %s %s value is already occupied. | 资源属性值已经被占用 |
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 | InvalidParameter%s | The specified parameter %s is invalid. | 参数无效,请检查参数 |
访问错误中心查看更多错误码。
访问错误中心查看更多错误码。