alibaba.airbi.data.search.data (alibaba.airbi.data.search.data)

数据搜索

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
rpc_context RpcContext 可选 基础参数
  • └ tenant_id
  • String
  • 可选
  • 1000
  • 租户ID
  • └ time_zone
  • String
  • 可选
  • Asia/Shanghai
  • 时区
  • └ app_access_key
  • String
  • 可选
  • app_access_key
  • 应用访问KEY
  • └ app_code
  • String
  • 可选
  • app_code
  • 应用code
  • └ locale
  • String
  • 可选
  • en
  • 语言
  • operator
  • UserInfo
  • 可选
  • 人员信息
  • 人员信息
  • └ work_no
  • String
  • 可选
  • 00001
  • 工号
  • └ auth_provider
  • String
  • 可选
  • mozi
  • 登陆态
  • └ corp_id
  • String
  • 可选
  • corp_id
  • 企业id
  • └ param_map
  • String
  • 可选
  • {"param0":11}
  • 附加参数(用于数据查询)
search_param DataSearchParam 可选 searchParam
  • └ prd_id
  • String
  • 可选
  • prdId
  • prdId
  • └ prd_name
  • String
  • 可选
  • prdName
  • prdName
  • └ visual_type
  • String
  • 可选
  • visualType
  • visualType
  • └ version
  • String
  • 可选
  • version
  • version
  • └ page_id
  • String
  • 可选
  • pageId
  • pageId
  • └ page_name
  • String
  • 可选
  • pageName
  • pageName
  • └ cid
  • String
  • 可选
  • cid
  • cid
  • └ cname
  • String
  • 可选
  • cname
  • cname
  • └ data_set_key
  • String
  • 可选
  • dataSetKey
  • dataSetKey
  • └ query_context
  • String
  • 可选
  • queryContext
  • queryContext
  • └ filter_key
  • String
  • 可选
  • filterKey
  • filterKey
  • └ search_value
  • String
  • 可选
  • searchValue
  • searchValue
  • └ start
  • Number
  • 可选
  • start
  • start
  • └ limit
  • Number
  • 可选
  • limit
  • limit
  • └ draft
  • Boolean
  • 可选
  • draft
  • draft
  • └ component
  • String
  • 可选
  • component
  • component
  • └ enabled_cache
  • Boolean
  • 可选
  • enabledCache
  • enabledCache

响应参数

名称 类型 示例值 描述
result RpcResult result 返回结果
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ error_code
  • Number
  • 1000
  • 错误编码
  • └ error_msg
  • String
  • error_msg
  • 错误信息
  • └ content
  • String
  • content
  • content

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAirbiDataSearchDataRequest req = new AlibabaAirbiDataSearchDataRequest();
AlibabaAirbiDataSearchDataRequest.RpcContext obj1 = new AlibabaAirbiDataSearchDataRequest.RpcContext();
obj1.setTenantId("1000");
obj1.setTimeZone("Asia/Shanghai");
obj1.setAppAccessKey("app_access_key");
obj1.setAppCode("app_code");
obj1.setLocale("en");
AlibabaAirbiDataSearchDataRequest.UserInfo obj2 = new AlibabaAirbiDataSearchDataRequest.UserInfo();
obj2.setWorkNo("00001");
obj2.setAuthProvider("mozi");
obj2.setCorpId("corp_id");
obj2.setParamMap("{\"param0\":11}");
obj1.setOperator(obj2);
req.setRpcContext(obj1);
AlibabaAirbiDataSearchDataRequest.DataSearchParam obj3 = new AlibabaAirbiDataSearchDataRequest.DataSearchParam();
obj3.setPrdId("prdId");
obj3.setPrdName("prdName");
obj3.setVisualType("visualType");
obj3.setVersion("version");
obj3.setPageId("pageId");
obj3.setPageName("pageName");
obj3.setCid("cid");
obj3.setCname("cname");
obj3.setDataSetKey("dataSetKey");
obj3.setQueryContext("queryContext");
obj3.setFilterKey("filterKey");
obj3.setSearchValue("searchValue");
obj3.setStart(startL);
obj3.setLimit(limitL);
obj3.setDraft(draft);
obj3.setComponent("component");
obj3.setEnabledCache(enabledCache);
req.setSearchParam(obj3);
AlibabaAirbiDataSearchDataResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_airbi_data_search_data_response>
    <result>
        <success>true</success>
        <error_code>1000</error_code>
        <error_msg>error_msg</error_msg>
        <content>content</content>
    </result>
</alibaba_airbi_data_search_data_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部