查詢基站設備信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeApDevices | 系統規定參數。取值:DescribeApDevices。 |
StoreId | String | 是 | s-dxsxx**** | 門店ID或商家自定義門店ID。 |
ApMac | String | 否 | 112233445566 | 基站設備的Mac地址。 |
Status | Boolean | 否 | true | 設備在線或離線狀態 ,true:在線、false:離線。 |
PageSize | Integer | 否 | 10 | 分頁參數:每頁顯示條數,默認值10。 |
PageNumber | Integer | 否 | 1 | 分頁參數:當前頁碼,默認值1。 |
Model | String | 否 | aliyun | 設備型號。 |
BeActivate | Boolean | 否 | false | 設備的激活狀態。 |
ExtraParams | String | 否 | {} | 系統保留字段,請忽略 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E69C8998-1787-4999-8C75-D663FF1173CF | 請求ID。 |
ErrorMessage | String | The specified resource type is invalid. | 錯誤消息。 |
Success | Boolean | true | 請求成功與否標識。 |
ErrorCode | String | MandatoryParameters | 錯誤碼。 |
Code | String | -1001 | 內部錯誤碼。 |
Message | String | success | 消息。 |
DynamicMessage | String | The specified store %s does not exist. | 動態消息。 |
PageNumber | Integer | 1 | 分頁參數:當前頁碼。 |
PageSize | Integer | 10 | 分頁參數:每頁顯示條數。 |
TotalCount | Integer | 100 | 總條數。 |
DynamicCode | String | PlatformResponseError.%s | 動態錯誤碼。 |
ApDevices | Array of ApInfo | 基站設備列表。 |
|
Status | Boolean | false | 在線狀態:離線。 |
StoreId | String | s-cxsds**** | 門店ID。 |
Model | String | aliyun | 設備型號。 |
Remark | String | 測試數據 | 備注。 |
BeActivate | Boolean | true | 是否激活。 |
Mac | String | 112233445566 | 設備的mac地址。 |
示例
請求示例
http(s)://cloudesl.cn-hangzhou.aliyuncs.com/?Action=DescribeApDevices
&StoreId=s-dxsxx****
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<code>200</code>
<data>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>E210B842-6AD3-4420-833A-4ED8756DBFD0</RequestId>
<PageNumber>1</PageNumber>
<ApDevices>
<Status>true</Status>
<BeActivate>true</BeActivate>
<StoreId>s-xsaa****</StoreId>
<Mac>112233445566</Mac>
</ApDevices>
<ApDevices>
<Status>true</Status>
<BeActivate>true</BeActivate>
<StoreId>s-xsaa****</StoreId>
<Mac>141FBA86****</Mac>
</ApDevices>
<Success>true</Success>
</data>
<requestId>E210B842-6AD3-4420-833A-4ED8756DBFD0</requestId>
<successResponse>true</successResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : 200,
"data" : {
"TotalCount" : 2,
"PageSize" : 10,
"RequestId" : "E210B842-6AD3-4420-833A-4ED8756DBFD0",
"PageNumber" : 1,
"ApDevices" : [ {
"Status" : true,
"BeActivate" : true,
"StoreId" : "s-xsaa****",
"Mac" : 112233445566
}, {
"Status" : true,
"BeActivate" : true,
"StoreId" : "s-xsaa****",
"Mac" : "141FBA86****"
} ],
"Success" : true
},
"requestId" : "E210B842-6AD3-4420-833A-4ED8756DBFD0",
"successResponse" : true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。