分页获取设备列表

调试

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

请求参数

名称 类型 是否必选 示例值 描述
MaxResults Integer 10

返回结果的最大个数。

NextToken String 1

当总结果个数大于MaxResults时,用于翻页的token。

DeviceFormId String form-u4ilnhu64h026lrf

设备形态ID

DeviceFormName String 网络设备

设备形态名称

PhysicalSpaceId String space-ez6zd3w68ma4fsd4

物理空间ID

HostName Array of String HZYT_USG6620_A

设备主机名

Ip Array of String 10.17.101.1

设备IP

Sn Array of String 210235951910K7000016

设备SN

Mac Array of String b8:27:eb:34:3b:a2

设备MAC

Vendor Array of String Huawei

设备厂商

Model Array of String USG6620

设备型号

ServiceStatus Array of String one

设备服务状态

ExtAttributes String {"role":"ASW"}

设备额外属性

返回数据

名称 类型 示例值 描述
TotalCount Integer 100

总记录数。

RequestId String fdb2af01-bd56-4034-812b-f257f73b4690

Id of the request

NextToken Integer 10

当总结果个数大于MaxResults时,用于翻页的token。

Devices Array of content

数组,返回示例目录。

DeviceId String device-evve560juend5owh

设备ID

DeviceFormName String 网络设备

设备形态名称

DeviceFormId String form-u4ilnhu64h026lrf

设备形态ID

PhysicalSpaceId String space-ez6zd3w68ma4fsd4

物理空间ID

PhysicalSpaceName String 阿里巴巴西溪园区

物理空间名称

HostName String HZYT_USG6620_A

主机名

Ip String 10.17.101.1

设备IP

Sn String 210235951910K7000016

设备SN

Mac String b8:27:eb:34:3b:a2

设备MAC地址

Vendor String Huawei

设备厂商

Model String USG6620

设备型号

SecurityDomain String IT

设备安全域

ServiceStatus String online

设备状态

LoginType String SSH,TELNET

登录类型

LoginUsername String admin

登录账号

LoginPassword String 123456

登录密码

SnmpAccountVersion String v3

SNMP版本号

SnmpCommunity String 123456

SNMP Community

SnmpAccountType String get

SNMP 账号类型

SnmpSecurityLevel String AUTH_PRIV

SNMP 安全级别

SnmpUsername String admin

SNMP 用户名

SnmpAuthPassPhrase String 123456

SNMP Auth PassPhrase

SnmpAuthProtocol String MD5

SNMP Auth Protocol

SnmpPrivacyPassphase String 123456

SNMP Privacy Passphase

SnmpPrivacyProtocol String DES

SNMP Privacy Protocol

ExtAttributes String {"role":"ASW"}

设备额外属性

MaxResults Integer 10

每页数量。

示例

请求示例

http(s)://[Endpoint]/?DeviceFormName=网络设备
&NextToken=1
&MaxResults=10
&Ip=["10.17.101.1"]
&Vendor=["Huawei"]
&Mac=["b8:27:eb:34:3b:a2"]
&ExtAttributes={"role":"ASW"}
&DeviceFormId=form-u4ilnhu64h026lrf
&ServiceStatus=["one"]
&Model=["USG6620"]
&PhysicalSpaceId=space-ez6zd3w68ma4fsd4
&Sn=["210235951910K7000016"]
&HostName=["HZYT_USG6620_A"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 Missing%s You must specify the parameter %s. 必填参数没有填。请检查调用时是否填写了此参数,并重试请求。
404 Invalid%s.NotFound The specified resource %s does not exist. 找不到对应资源

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

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