文档管理中心

查询Namespace列表

接口功能

查询用户的Namespace列表。

调用场景

在华为开发者联盟创建project后,可通过调用该接口查询Namespace列表。

接口原型

承载协议

HTTPS GET

接口方向

应用服务器或APP应用->近距离通信服务器

接口URL

https://{域名}/WiseCloudNearbyBeaconService/v1/queryNamespace?projectId=[projectId]

数据格式

Content-type: application/json

接口约束

需要获取服务帐号凭证。

请求参数

参数名称

必选(M)/可选(O)

类型

参数说明

timeStamp

M

Long

请求头参数,时间戳。

srcTranID

M

String

请求头参数,事务ID,最长为24个字符。

Authorization

M

String

请求头参数,用于网关认证,请参考基于Service Account开放鉴权获取JWT。

projectId

O

String

路径参数。

返回参数

请求成功,状态码200,响应体如下:

参数值

类型

参数说明

namespace

Json object

Namespace结构体的列表,Namespace具体见下面Namespace结构体定义。

Namespace结构体定义:

  1. {
  2. "visibility":"PRIVATE",
  3. "namespace":"dev9105385871708434"
  4. }

参数值

类型

功能

visibility

String

namespace可见性。

PUBLIC:公有

PRIVATE:私有

namespace

String

namespace。

请求失败,状态码非200,响应体如下:

(1) 非业务(网关校验失败、token过期等情况)请求失败时:

参数名称

类型

参数说明

error

String

非业务返回错误信息。

(2) 业务请求失败时:

参数名称

类型

参数说明

serviceError

object

业务返回的错误信息。

serviceError的JSON结构体为:

参数名称

类型

参数含义

code

int

错误码,错误码描述见返回码。

status

String

错误状态。

message

String

错误描述信息。

返回码

错误码

错误码含义

建议业务处理方式

400000001

请求头参数不对。

检查请求头参数。

403000003

服务帐号不可用。

切换成可用的服务帐号操作。

500000001

内部服务错误。

建议重试,重试仍失败则反馈该问题。

调用样例

使用过期的Authorization进行调用,返回错误的响应体

请求消息:

  1. GET /WiseCloudNearbyBeaconService/v1/queryNamespace?projectId=id123 HTTP/1.1
  2. Host: 域名
  3. Content-Type: application/json
  4. Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXghghSa2xeXSt4Gp---xxx
  5. srcTranID: 202001141709412953357215
  6. timeStamp: 922337203685477580
  7. Accept: application/json

响应消息:

  1. HTTP/1.1 401
  2. Content-Type: application/json
  3. Content-Length: 27
  4. {"error":"session timeout"}

业务请求失败时,返回错误的响应体,例如使用无权限的帐号去调用此接口

请求消息:

  1. GET /WiseCloudNearbyBeaconService/v1/queryNamespace?projectId=id123 HTTP/1.1
  2. Host: 域名
  3. Content-Type: application/json
  4. Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXghghSa2xeXSt4Gp---xxx
  5. srcTranID: 202001141709412953357215
  6. timeStamp: 922337203685477580
  7. Accept: application/json

响应消息:

  1. HTTP/1.1 403
  2. Content-Type: application/json
  3. Content-Length: 84
  4. {"serviceError":{"code":403000003,"message":"The service account is unavailable","status":"Forbidden"}}

请求成功,返回成功的响应体

请求消息:

  1. GET /WiseCloudNearbyBeaconService/v1/queryNamespace?projectId=id123 HTTP/1.1
  2. Host: 域名
  3. Content-Type: application/json
  4. Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXghghSa2xeXSt4Gp---xxx
  5. srcTranID: 202001141709412953357215
  6. timeStamp: 922337203685477580
  7. Accept: application/json

响应消息:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  3. Content-Length: 61
  4. {"namespaces":[{"visibility":"PRIVATE","namespace":"dev9105385871708434"}]}


搜索
请输入您想要搜索的关键词