承载协议 | HTTPS GET |
|---|---|
接口方向 | 应用服务器或App应用 -> 近距离通信服务器 |
接口URL | https://{域名}/WiseCloudNearbyBeaconService/v1/queryBeaconInfo/{beaconId}?projectId=[projectId] |
数据格式 | Content-type: application/json |
Request Header
参数名 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
srcTranID | 是 | String | 请求头参数,事务ID。最长为24个字符。 |
timeStamp | 是 | Long | 请求头参数,时间戳。 |
Authorization | 是 | String | 请求头参数,用于网关认证,请参见基于Service Account开放鉴权获取JWT。 |
Request Body
无
GET /WiseCloudNearbyBeaconService/v1/queryBeaconInfo/aa123?projectId=id123 HTTP/1.1 Host: 域名 Content-Type: application/json srcTranID: 201910181908046224775031 timeStamp: 922337203685477580 Accept: application/json Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx
GET /WiseCloudNearbyBeaconService/v1/queryBeaconInfo/aa123?projectId=id123 HTTP/1.1 Host: 域名 Content-Type: application/json srcTranID: 20191018190804622477503612345678912345678 timeStamp: 922337203685477580 Accept: application/json Authorization: Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx
GET /WiseCloudNearbyBeaconService/v1/queryBeaconInfo/aa124?projectId=id123 HTTP/1.1 Host: 域名 Content-Type: application/json srcTranID: 201910181908046224775031 timeStamp: 922337203685477580 Accept: application/json Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx
Response Header
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 否 | String | 上传文件Content-Type。 |
Content-Length | 是 | Integer | 上传文件Content-Length。 |
Response Body
状态码为200时:
请求成功,响应体如下。
参数 | 类型 | 描述 |
|---|---|---|
beacon | object | 信标设备的详情信息。 具体参见信标设备数据模型。 |
状态码为非200时:
参数 | 类型 | 描述 |
|---|---|---|
error | String | 非业务返回的错误信息。 |
参数 | 类型 | 描述 |
|---|---|---|
serviceError | object | 业务返回的错误信息。请见下文serviceError详细信息。 |
HTTP/1.1 401 Unauthorized
Content-type: application/json
content-length: 27
{
"error": "session timeout"
} HTTP/1.1 400 Bad Request
Content-type: application/json
content-length: 150
{
"serviceError": {
"code": 400000001,
"message": "srcTranID: size must be between 0 and 24.",
"status": "Bad Request"
}
} HTTP/1.1 200 OK
Content-type: application/json
content-length: 215
{
"beacon": {
"beaconDesc": "beacon test",
"indoorLevel": "0",
"beaconType": 1,
"latitude": 90.0,
"placeId": "place01",
"beaconId": "aa124",
"properties": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
"status": 1,
"longitude": 90.0
}
} 状态码 | 错误码 | 描述 | 建议业务处理方式 |
|---|---|---|---|
400 | 400000001 | 请求头参数不对。 | 检查请求头参数。 |
400 | 400000002 | 请求体参数不对。 | 检查请求体参数。 |
403 | 403000003 | 服务帐号不可用。 | 在华为开发者联盟的管理中心可查看服务帐号状态。 |
403 | 403000004 | 当前帐号没有权限操作此信标设备。 | 检查此帐号是否有权限操作。 |
404 | 404000006 | 当前信标设备不存在。 | 检查该当前的信标设备是否注册过,若无请先注册。 |
500 | 500000001 | 内部服务错误。 | 请选择在线提单提交问题,华为支持人员会及时处理。 |