目录

搜索通用网页

功能介绍

提供通用网页搜索功能,根据输入的关键词,返回通用网页结果。

场景描述

您需要从互联网上搜索相关网页时,调用该API,输入关键词,可以得到万维网中与此相关的网页列表数据。

使用约束

无。

接口原型

承载协议

HTTPS GET

接口方向

开发者服务器->华为搜索服务器

接口URL

https://{rootUrl}/apis/search/v1.0.0/web/search

说明:

{rootUrl}:请参见站点信息。

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

查询参数

参数

是否必选

参数类型

描述

q

是

string

搜索词。

lang

否

string

支持的搜索语言,参见语言码。默认值是en。

sregion

否

string

支持的搜索区域,参见搜索区域码。默认值是ww。

pn

否

integer

搜索结果分页页号,取值范围[1, 100]。默认值是1。

ps

否

integer

搜索结果单页条目数量,取值范围[1, 100]。默认值是10。

请求参数

Request Header

参数

是否必选

参数类型

描述

Accept

是

string

取值为application/json。

Content-Type

是

string

取值为application/json。

Authorization

是

string

您动态获取的Access Token。

说明:

Bearer后面拼接空格,再拼接获取的access_token。

X-Kit-AppID

是

string

联盟申请的凭证后得到的对应应用级ID及Token。

X-Kit-ClientIP

否

string

终端用户IP,云侧服务器对接时建议您传入,支持本地化。

X-Kit-RequestID

否

string

标识请求的唯一ID(用户可自己指定ID,如无指定则配置默认值)。

Request Body

无。

请求示例

GET https://{rootUrl}/apis/search/v1.0.0/web/search?q=<query>
Content-Type:application/json
Accept:application/json
Authorization:Bearer {access_token}
X-Kit-AppID:{appid}

如果实际搜索的query为test,按这里的示例appid、域名、Access Token,实际请求为:

GET https://search-forexample.cloud.huawei.com/apis/search/v1.0.0/web/search?q=test
Content-Type:application/json
Accept:application/json
Authorization:Bearer Access1Token/For2Example
X-Kit-AppID:appidforexample

响应参数

状态码为200时:

Response Header

无。

Response Body

参数

是否必选

参数类型

描述

request_id

是

string

请求ID,和请求Header中的X-Kit-RequestID一致,若请求中没有X-Kit-RequestID,会在服务端生成。

data

是

Array[WebItem]

网页搜索结果。

query_lang

是

string

从query推断出的语言。

状态码为非200时:

Response Header

无。

Response Body

参数

是否必选

参数类型

描述

code

是

string

详细错误码,参见错误码。

msg

是

string

错误信息。

request_id

是

string

请求ID,和请求Header中的X-Kit-RequestID一致,若请求中没有X-Kit-RequestID,会在服务端生成。

响应示例

HTTP/1.1 200 OK
Content-type: application/json
{
"data": {search result},
"request_id": {X-Kit-RequestID}
}

错误码

详情请参见错误码。

调用示例

curl -X GET -H 'Content-Type:application/json' -H 'X-Kit-AppID:{{app id}}' -H 'Authorization:Bearer {{Access_Token}}' -H 'Accept:application/json' {{域名}}/apis/search/v1.0.0/web/search?q={{query}}

假设为本次请求使用的appid为123456,获取的Access_Token为Access1Token/For2Example,获取的域名为https://search-dre.cloud.huawei.com,query为test,则实际调用命令为:

curl -X GET -H 'Content-Type:application/json' -H 'X-Kit-AppID:123456' -H 'Authorization:Bearer Access1Token/For2Example' -H 'Accept:application/json' https://search-dre.cloud.huawei.com/apis/search/v1.0.0/web/search?q=test