DomainKnowledgeRetrieve - Domain Name Knowledge Base Retrieve-域名(Domain)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

domain:DomainKnowledgeRetrieve

get

*全部资源

*

无

请求语法

GET  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Keyword	string	是	Keywords to be retrieved.	how to renew
Site	string	否	Search knowledge base sites, including domestic cn, international intl, and all. 枚举值： all : 全部知识库 cn : 中国站知识库 intl : 国际站知识库	all
GlobalTopN	integer	否	The number of retrieve results that need to be returned.	5

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Data	array<object>	The list of retrieve result.
	object	Retrieve result.
Score	number	The score of the retrieved text; the higher the score, the more relevant the result.	0.6
Source	string	Source of retrieve results.	Domestic Business Knowledge Base
Text	string	Retrieved text.	On Alibaba Cloud's domestic website, domain name renewal can be done through the following methods.
RequestId	string	Id of the request	019FABCB-6C7D-18FE-AA42-922BFC9555D9

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "Score": 0.6,
      "Source": "Domestic Business Knowledge Base",
      "Text": "On Alibaba Cloud's domestic website, domain name renewal can be done through the following methods."
    }
  ],
  "RequestId": "019FABCB-6C7D-18FE-AA42-922BFC9555D9"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。