DescribeKeyword - 搜索指定文本库中的文本

更新时间:
复制 MD 格式

查询关键词列表

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-greenweb:DescribeKeyword

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

SourceIp

string

否

访问源的 IP 地址。

113.109.***.132

Lang

string

否

语言。

zh

TotalCount

integer

否

总数。

364

PageSize

integer

否

分页大小。

10

CurrentPage

integer

否

当前页码。

1

KeywordLibId

integer

是

关键词库 ID。

22220

Keyword

string

否

查询关键字。

盯

返回参数

名称

类型

描述

示例值

object

CurrentPage

integer

当前页码。

1

RequestId

string

请求 ID。

AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****

PageSize

integer

分页大小。

10

TotalCount

integer

总数。

364

KeywordList

array<object>

关键字列表。

object

关键字列表。

HitCount

integer

命中次数。

11

Keyword

string

关键字。

盯链

Id

integer

主键 id

211

CreateTime

string

创建时间。具体为 YYYY-MM-DD HH:mm:ss ±HHMM(默认时区 UTC+08:00)

2023-10-25 15:58:07 +0800

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "PageSize": 10,
  "TotalCount": 364,
  "KeywordList": [
    {
      "HitCount": 11,
      "Keyword": "盯链",
      "Id": 211,
      "CreateTime": "2023-10-25 15:58:07 +0800"
    }
  ]
}

错误码

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

变更历史

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