更新设备信息 - UpdateDevices
功能介绍
功能介绍:根据设备ID更新指定第三方设备的信息,请求体字段要求与添加设备一致(设备名称、类型、部署模式、子网ID、虚拟私有云ID为必填),更新成功后返回操作结果状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/devices/{device_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 以IAM服务接口返回值为准,字符长度为32个字符。 默认取值: 不涉及 |
| device_id | 是 | String | 参数解释: 设备ID,标识一个第三方设备,可通过查询设备列表接口获取 约束限制: 满足正则匹配"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"(UUID格式) 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 设备名称 约束限制: 长度4~255字符;只能包含字母、数字、中文、下划线、连字符 取值范围: 4~255字符 默认取值: 不涉及 |
| type | 是 | Integer | 参数解释: 设备类型 约束限制: 不涉及 取值范围: 0-应用数据审计 1-应用数据安全网关 2-数据库防火墙 3-数据库加密 4-静态脱敏实例 5-数据库动脱实例 默认取值: 不涉及 |
| mode | 是 | String | 参数解释: 设备部署模式 约束限制: 不涉及 取值范围: SINGLE-单机 HA-高可用 CLUSTER-集群 默认取值: 不涉及 |
| subnet_id | 是 | String | 参数解释: 子网ID 约束限制: UUID格式 取值范围: 不涉及 默认取值: 不涉及 |
| vpc_id | 是 | String | 参数解释: 虚拟私有云ID 约束限制: UUID格式 取值范围: 不涉及 默认取值: 不涉及 |
| manage_url | 否 | String | 参数解释: 管理访问地址 约束限制: 可选;http或https开头;最大长度255字符 取值范围: 不涉及 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 资源描述信息 约束限制: 可选;最大长度512字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
更新设备信息
{
"name" : "firewall-01-updated",
"type" : 1,
"mode" : "HA",
"subnet_id" : "a1b2c3d4-e5f6-4789-abcd-ef1234567890",
"vpc_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"manage_url" : "https://console.huawei.com/device/management/v2",
"description" : "核心防火墙设备-已更新"
} 响应示例
状态码:200
{
"status" : "success"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新成功 |
错误码
请参见错误码。