文档

GetDevice - 根据ID查询设备详情

更新时间:

根据ID查询设备详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cmn:GetDeviceREAD
  • Device
    acs:cmn:{#regionId}:{#accountId}:device/{#DeviceId}

请求参数

名称类型必填描述示例值
DeviceIdstring

设备 ID。

device-evve560juend5owh
InstanceIdstring

实例 ID

cmn-cn-xxx

返回参数

名称类型描述示例值
object

Schema of Response

Deviceobject

设备详情

DeviceIdstring

设备 ID

device-evve560juend5owh
DeviceFormIdstring

设备形态 ID

form-u4ilnhu64h026lrf
DeviceFormNamestring

设备形态名称

网络设备
PhysicalSpaceIdstring

物理空间 ID

space-ez6zd3w68ma4fsd4
PhysicalSpaceNamestring

物理空间名称

阿里巴巴西溪园区
HostNamestring

主机名

HZYT_USG6620_A
Ipstring

设备 IP

10.17.101.1
Snstring

设备 SN

210235951910K7000016
Macstring

设备 MAC 地址

b8:27:eb:34:3b:a2
Vendorstring

设备厂商

Huawei
Modelstring

设备型号

USG6620
SecurityDomainstring

设备安全域

IT
ServiceStatusstring

设备状态

online
LoginTypestring

登录类型

SSH,TELNET
LoginUsernamestring

登录账号

admin
LoginPasswordstring

登录密码

123456
EnablePasswordstring

enable 密码

123456
SnmpAccountVersionstring

SNMP 版本号

v3
SnmpCommunitystring

SNMP Community

123456
SnmpAccountTypestring

SNMP 账号类型

get
SnmpSecurityLevelstring

SNMP 安全级别

AUTH_PRIV
SnmpUsernamestring

SNMP 用户名

admin
SnmpAuthPassphrasestring

SNMP Auth PassPhrase

123456
SnmpAuthProtocolstring

SNMP Auth Protocol

MD5
SnmpPrivacyPassphrasestring

SNMP Privacy Passphrase

123456
SnmpPrivacyProtocolstring

SNMP Privacy Protocol

DES
ExtAttributesstring

设备额外属性

{"role":"ASW"}
RequestIdstring

Id of the request

fdb2af01-bd56-4034-812b-f257f73b4690

示例

正常返回示例

JSON格式

{
  "Device": {
    "DeviceId": "device-evve560juend5owh",
    "DeviceFormId": "form-u4ilnhu64h026lrf",
    "DeviceFormName": "网络设备",
    "PhysicalSpaceId": "space-ez6zd3w68ma4fsd4",
    "PhysicalSpaceName": "阿里巴巴西溪园区",
    "HostName": "HZYT_USG6620_A",
    "Ip": "10.17.101.1",
    "Sn": "210235951910K7000016",
    "Mac": "b8:27:eb:34:3b:a2",
    "Vendor": "Huawei",
    "Model": "USG6620",
    "SecurityDomain": "IT",
    "ServiceStatus": "online",
    "LoginType": "SSH,TELNET",
    "LoginUsername": "admin",
    "LoginPassword": "123456",
    "EnablePassword": "123456",
    "SnmpAccountVersion": "v3",
    "SnmpCommunity": "123456",
    "SnmpAccountType": "get",
    "SnmpSecurityLevel": "AUTH_PRIV",
    "SnmpUsername": "admin",
    "SnmpAuthPassphrase": "123456",
    "SnmpAuthProtocol": "MD5",
    "SnmpPrivacyPassphrase": "123456",
    "SnmpPrivacyProtocol": "DES",
    "ExtAttributes": "{\"role\":\"ASW\"}"
  },
  "RequestId": "fdb2af01-bd56-4034-812b-f257f73b4690"
}

错误码

HTTP status code错误码错误信息描述
400Missing%sYou must specify the parameter %s.必填参数没有填。请检查调用时是否填写了此参数,并重试请求。
400SignatureDoesNotMatch签名不通过-
403NoPermission没有权限-
404Invalid%s.NotFoundThe specified resource %s does not exist.找不到对应资源
404ServiceNotFound后端服务未找到-
500InternalError服务器内部错误-
503ServiceUnavailable服务不可用-

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈